Sign in
Treasury

Get Client Balance

Returns the balance of a specific client.

get/api/v3/clients/{client_id}/balance.json

Path parameters

client_idstring required
Example:12345

ID of the client.

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

Response

SUCCESS

Example response

{
  "currency": {
    "symbol": "€",
    "code": "EUR"
  },
  "initial_balance": {
    "created_at": "1970-01-01"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.23

  • 5b82d4eb0d9f23See the full diff
    • ▲

      the response property initial_balance/observation became nullable for the status 200

      response-property-became-nullable

    • ▲

      the errors response's property type/format changed from object/ to array/ for status 401

      response-property-type-changed

    • ●

      removed the optional property balance/without_vat from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property errors/error from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property overdue_balance/without_vat from the response with the 200 status

      response-optional-property-removed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog