Skip to content
campaiDeveloper
campai.com

Finance · Accounting

POST/{organizationId}/{mandateId}/finance/accounting/depositBalances

Get available deposit balances

Returns paid deposit balances still available per debtor and VAT rate at a date, as gross or net amounts.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • receipt.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • formatstringrequired
    html pdf excel csv
  • asOfstringrequired
  • searchstring

    at most 200 characters · default ""

  • sortBystring

    default "account"

    account name
  • amountTypestring

    default "gross"

    gross net
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/accounting/depositBalances' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • namestring
  • dataobject
    2 properties
    • contentstring
    • zipboolean
  • emptyboolean
Response200
{
  "name": "string",
  "data": {
    "content": "string"
  },
  "empty": true
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.