Skip to main content
POST
Accept a balance

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
balance
string
required

The balance id, from get_document or get_account.

Required string length: 1 - 60

Body

application/json
amount_cents
number | null
as_at
string | null

A date, YYYY-MM-DD.

Response

Success.

object
enum<string>
required
Available options:
balance
id
string
required
account_id
string
required
amount_cents
number
required

Negative for what is owed.

as_at
string
required

An ISO 8601 time in UTC.

status
enum<string>
required
Available options:
proposed,
accepted
document_id
string | null
required