ClientBalanceResponse

successboolean

Example: true

data object

creditBalancenumber

The client credit balance: the gross transfers of the client, minus the amounts already applied to invoices, minus the debits.

Example: 1000

debtnumber

The client debt: the sum of the pending amounts of the open invoices of the client.

Example: 3000

balancenumber

creditBalance minus debt. The credit balance and the debt are computed independently and never netted before this field.

Example: -2000

currencystring

Currency code. Currently only ARS.

Example: ARS

totalCashInnumber

Informational total: the sum of all cash_in ledger entries.

Example: 50000

totalCashOutnumber

Informational total: the absolute sum of all debit ledger entries.

Example: 5000

totalInvoicednumber

Informational total: the sum of total_amount across all client invoices, of any status.

Example: 30000

timestampstring<date-time>

ClientBalanceResponse

{
  "success": true,
  "data": {
    "creditBalance": 1000,
    "debt": 3000,
    "balance": -2000,
    "currency": "ARS",
    "totalCashIn": 50000,
    "totalCashOut": 5000,
    "totalInvoiced": 30000
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}