Skip to main content
GET
Balance by third party

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Query Parameters

end_date
string<date>
required

Cut-off date (YYYY-MM-DD).

start_date
string<date>

Optional: everything before this date accumulates as the opening balance (opening).

third_party_type
enum<string>

Optional: customer, provider or employee. The type alone lists all third parties of that type.

Available options:
customer,
provider,
employee
third_party_id
string<uuid>

Optional, requires third_party_type: a single third party (from another business → 404; without type → 422).

account_codes[]
string[]

Optional (repeatable; also accepts comma-separated codes): only those accounts.

category_ids[]
string<uuid>[]

Optional (repeatable; also accepts comma-separated ids): only accounts of those account categories and, by default, their subcategories. If no account belongs to them, the report comes back empty.

include_children
boolean
default:true

With category_ids, includes the accounts of their subcategories (default true).

branch_id
string

Optional: limits to one branch.

format
enum<string>
default:json

json (default), pdf (application/pdf), or excel (.xlsx). With pdf/excel the response is the file.

Available options:
json,
pdf,
excel

Response

Success

status
boolean
required
Example:

true

data
object
required