API Reference

Show Deposits List

get
https://api.vcita.biz/business/payments/v1/deposits

Overview

Show list of deposits. Available for Staff, App, and Directory tokens.

Filter Validation Rules

  • When filtering by entity_uid, the entity_type filter must also be provided
  • Valid entity_type values: Invoice, Estimate
  • Example query: filter[entity_uid][eq]=uid123&filter[entity_type][in]=Invoice
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Page offset (default: 1)

string

Page size (default: 25)

string

Sort by one of the following: created_at, updated_at. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc

string

Available filters: entity_uid, entity_type. Important: When entity_uid is provided, entity_type is also required. Valid entity_type values are 'Invoice' and 'Estimate'. Example: filter[entity_uid][eq]=abc123&filter[entity_type][in]=Invoice

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago