Skip to main content
POST
Get the balance of accounts

Path Parameters

consumer_id
string<uuid>
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Body

application/json
accounts
string[]
required

Array/list containing the account numbers/classes to include in the response. E.g. ["601", "7"] to retrieve all account in the class 7 and accounts with an account number beginning with 601

end
string
required

End month (inclusive). Format: YYYYMM (e.g., 202512 for December 2025).

Required string length: 6
start
string | null

Start month (inclusive). Format: YYYYMM (e.g., 202502 for February 2025).

Response

Successful Response

items
AccountBalance · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1