vCita Deposits API

The Deposits API from vCita — 4 operation(s) for deposits.

GitHub OpenAPI

Operations 7

GET /client/payments/v1/deposits Show Deposits List #
GET /client/payments/v1/deposits/{deposit_uid} Show Deposit #
GET /business/payments/v1/deposits Show Deposits List #
POST /business/payments/v1/deposits Create Deposit #
DELETE /business/payments/v1/deposits/{uid} Delete Deposit #
GET /business/payments/v1/deposits/{uid} Show Deposit #
PUT /business/payments/v1/deposits/{uid} Update Deposit #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-deposits-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-deposits-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Vcita Deposits API
  version: '3.0'
  x-refined-note:
  - x-generated differs across the merged source definitions and was not carried
  description: 'Operations tagged Deposits across 2 of this provider''s published API definitions: vcita-clients-api-openapi.yml, vcita-sales-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Deposits
paths:
  /client/payments/v1/deposits:
    get:
      description: '## Overview

        Show list of deposits.


        ## Authentication

        **Available for Client Tokens only.**


        ## Required Parameters

        - `matter_uid` (query, **required**): The matter UID to fetch deposits for. Returns 500 error if not provided.'
      parameters:
      - description: relevant matter_uid to fetch deposits for
        in: query
        name: matter_uid
        required: true
        schema:
          type: string
      - description: 'Page offset (default: 1)'
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: 'Page size (default: 25)'
        in: query
        name: per_page
        required: false
        schema:
          type: string
      - description: 'Sort by one of the following: created_at, updated_at. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc'
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: 'Available filters: entity_uid, entity_type. example: filter[entity_uid][eq]=123&filter[entity_type][in]=Invoice.'
        in: query
        name: filter
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposits:
                  - amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T01:55:17.659-05:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: ogw6lfpggda2sews
                    matter_uid: w8gtso6t02go66ad
                    payment_request_uid: null
                    payment_uid: ftxwbw9a199m9xdb
                    staff_uid: c1d6ffb93c834ba9
                    title: 'Deposit for INVOICE #0000001'
                    uid: 6y5ssai032sfpv54
                    updated_at: '2025-08-05T01:55:17.659-05:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Show Deposits List
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///client/payments/v1/deposits
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getClientPaymentsV1Deposits
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /client/payments/v1/deposits/{deposit_uid}:
    get:
      description: '## Overview

        Show specific deposit details.


        ## Authentication

        **Available for Client Tokens only.**


        ## Parameters

        - `deposit_uid`: The unique identifier of the deposit

        - `matter_uid`: (Optional) When provided, validated and used to filter by engagement; an incorrect value may result in not_found or missing deposit_uid rather than 422.


        ## Error Responses

        - 404/not_found: When deposit does not exist or matter_uid (if provided) does not match.'
      parameters:
      - description: The unique identifier of the deposit (e.g., "6y5ssai032sfpv54").
        in: path
        name: deposit_uid
        required: true
        schema:
          type: string
      - description: Matter UID (optional). When provided, validated and used to filter; incorrect value may return not_found.
        in: query
        name: matter_uid
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposit:
                    amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T01:55:17.659-05:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: ogw6lfpggda2sews
                    matter_uid: w8gtso6t02go66ad
                    payment_request_uid: null
                    payment_uid: ftxwbw9a199m9xdb
                    staff_uid: c1d6ffb93c834ba9
                    title: 'Deposit for INVOICE #0000001'
                    uid: 6y5ssai032sfpv54
                    updated_at: '2025-08-05T01:55:17.659-05:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Show Deposit
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///client/payments/v1/deposits/{deposit_uid}?matter_uid={matter_uid}
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getClientPaymentsV1DepositsByDepositUid
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /business/payments/v1/deposits:
    get:
      description: '## 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`'
      parameters:
      - description: 'Page offset (default: 1)'
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: 'Page size (default: 25)'
        in: query
        name: per_page
        required: false
        schema:
          type: string
      - description: 'Sort by one of the following: created_at, updated_at. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc'
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: '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'
        in: query
        name: filter
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposits:
                  - amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T09:54:08.266+03:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: ehxqtvabtig2aj06
                    matter_uid: 8ou4cwb8h5ipjlvt
                    payment_request_uid: null
                    payment_uid: 7zv99u0v4w36l3ru
                    staff_uid: 63dd60d2c4783ebe
                    title: 'Deposit for INVOICE #0000001'
                    uid: pzbkn3h41ntc3c4u
                    updated_at: '2025-08-05T09:54:08.266+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Show Deposits List
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/deposits
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1Deposits
      x-operation-id-source: derived
    post:
      description: '## Overview

        Creates a Deposit Available for **Staff, App, and Directory tokens**.'
      parameters: []
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposit:
                    amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T09:54:09.134+03:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: 1loujducpdk71p5r
                    matter_uid: 8ou4cwb8h5ipjlvt
                    payment_request_uid: null
                    payment_uid: 874tdqen0acd5t7f
                    staff_uid: 63dd60d2c4783ebe
                    title: 'Deposit for INVOICE #0000002'
                    uid: m9k8akac0pu9h71v
                    updated_at: '2025-08-05T09:54:09.134+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Create Deposit
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: '201'
        type: http_proxy
        uri: https:///business/payments/v1/deposits
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                deposit:
                  properties:
                    amount:
                      description: Deposit's amount
                      type: object
                      properties:
                        is_rounded:
                          description: Indication whether amount is rounded to the closest dollar.
                          type: boolean
                        total:
                          description: Amount total (fixed - after percentage calculation).
                          type: number
                        type:
                          description: Amount type (e.g., "fixed" or "percentage").
                          type: string
                        value:
                          description: Amount value.
                          type: number
                      required:
                      - type
                      - value
                      - total
                    can_client_pay:
                      description: Indicates whether the payment will be made in Client Portal. Default is true
                      type: boolean
                    currency:
                      description: Three-letter ISO currency code
                      type: string
                    entity_type:
                      description: 'The type of entity this deposit is associated with. Must be one of: `Invoice` or `Estimate` (case-sensitive).'
                      type: string
                      enum:
                      - Invoice
                      - Estimate
                    entity_uid:
                      description: Related entity_uid
                      type: string
                      x-reference-to: generic.entity
                    matter_uid:
                      description: Matter UID
                      type: string
                      x-reference-to: clients.matter
                    payment_uid:
                      description: Related payment_uid
                      type: string
                      x-reference-to: sales.payment
                  required:
                  - currency
                  - matter_uid
                  - amount
                  - entity_uid
                  - entity_type
                  type: object
              required:
              - deposit
              type: object
      security:
      - Bearer: []
      operationId: postBusinessPaymentsV1Deposits
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /business/payments/v1/deposits/{uid}:
    delete:
      description: '## Overview

        Delete a specific deposit Available for **Staff, App, and Directory tokens**.'
      parameters:
      - description: Deposit UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data: {}
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Delete Deposit
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: DELETE
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/deposits/{uid}
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: deleteBusinessPaymentsV1DepositsByUid
      x-operation-id-source: derived
    get:
      description: '## Overview

        Show specific deposit data. Available for **Staff Tokens**.'
      parameters:
      - description: Deposit UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposit:
                    amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T09:54:08.266+03:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: ehxqtvabtig2aj06
                    matter_uid: 8ou4cwb8h5ipjlvt
                    payment_request_uid: null
                    payment_uid: 7zv99u0v4w36l3ru
                    staff_uid: 63dd60d2c4783ebe
                    title: 'Deposit for INVOICE #0000001'
                    uid: pzbkn3h41ntc3c4u
                    updated_at: '2025-08-05T09:54:08.266+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Show Deposit
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/deposits/{uid}
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1DepositsByUid
      x-operation-id-source: derived
    put:
      description: '## Overview

        Update specific deposit Available for **Staff, App, and Directory tokens**.'
      parameters:
      - description: Deposit UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  deposit:
                    amount:
                      is_rounded: null
                      total: 50
                      type: fixed
                      value: 50
                    can_client_pay: true
                    created_at: '2025-08-05T09:54:08.266+03:00'
                    currency: USD
                    entity_type: Invoice
                    entity_uid: ehxqtvabtig2aj06
                    matter_uid: 8ou4cwb8h5ipjlvt
                    payment_request_uid: null
                    payment_uid: 7zv99u0v4w36l3ru
                    staff_uid: 63dd60d2c4783ebe
                    title: 'Deposit for INVOICE #0000001'
                    uid: pzbkn3h41ntc3c4u
                    updated_at: '2025-08-05T09:54:08.266+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Update Deposit
      tags:
      - Deposits
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: PUT
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/deposits/{uid}
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                deposit:
                  properties:
                    amount:
                      description: Deposit's amount
                      type: object
                      properties:
                        is_rounded:
                          description: Indication whether amount is rounded to the closest dollar.
                          type: boolean
                        total:
                          description: Amount total (fixed - after percentage calculation).
                          type: number
                        type:
                          description: Amount type (e.g., "fixed" or "percentage").
                          type: string
                        value:
                          description: Amount value.
                          type: number
                    can_client_pay:
                      description: Indicates whether the payment will be made in Client Portal. Default is true
                      type: boolean
                    currency:
                      description: Three-letter ISO currency code
                      type: string
                    entity_type:
                      description: 'The type of entity this deposit is associated with. Must be one of: `Invoice` or `Estimate` (case-sensitive).'
                      type: string
                      enum:
                      - Invoice
                      - Estimate
                    entity_uid:
                      description: Related entity_uid
                      type: string
                      x-reference-to: generic.entity
                  type: object
              required:
              - deposit
              type: object
      security:
      - Bearer: []
      operationId: putBusinessPaymentsV1DepositsByUid
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
components:
  securitySchemes:
    ActivitySources:
      type: http
      scheme: bearer
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
    Notes:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
    ClientMessaging:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid client bearer token in the Authorization header. Example: ''Authorization: Bearer {client_token}'''
    ClientPaymentCards:
      type: http
      scheme: bearer
      description: Provide a valid bearer token in the Authorization header.
    PaymentPlans:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
x-refined-from:
- vcita-clients-api-openapi.yml
- vcita-sales-api-openapi.yml