GET
View third-party balance (organization)
Organization space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller needs an accounting access grant on the book.
  • auxiliary_type is required and must be customer or vendor.
  • At least one of fiscal_year_id or fiscal_period_id must be sent; a from/to range alone is refused with a validation error.
  • to must be on or after from.
Part of Accounting reports.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

book
string
required

Identifier of the book the report covers (27-character KSUID string): the organization itself or one of its companies of the session organization.

Query Parameters

fiscal_year_id
string | null

Identifier of a fiscal year of this book (27-character KSUID string). At least one of fiscal_year_id or fiscal_period_id is required (a from/to range alone is refused). A from/to pair sent with a year takes precedence over the year.

fiscal_period_id
string | null

Identifier of a fiscal period of this book (27-character KSUID string). Takes precedence over the fiscal year and over from/to.

from
string<date-time> | null

Start of the range, a date in ISO 8601 format. Used together with to; a range given alone is ignored.

to
string<date-time> | null

End of the range, a date in ISO 8601 format, on or after from. Used together with from.

auxiliary_type
enum<string>
required

Required. Third-party accounts to report on: customer or vendor.

Available options:
customer,
vendor

Response

book
object
required

The book the report covers. In the client space it is the session client's book; in the organization space it is the book named in the URL.

auxiliary_type
string
required

Which third-party accounts the report covers, as requested: customer or vendor.

from
string<date> | null
required

Start date of the window actually used, ISO 8601 date format.

to
string<date> | null
required

End date of the window actually used, ISO 8601 date format.

groups
array
required

One block per parent account (the customer or vendor control account), each with parent (account_id, code, name; null for accounts without a parent), rows (one per third-party account, with the six trial-balance columns and auxiliary_id) and subtotals of the six columns.

totals
object
required

Sum of the six trial-balance columns over all accounts of the report, in minor units of currency_code (divide by 10 to the power currency_exponent).

currency_code
string
required

ISO 4217 code of the currency of every amount in the report.

currency_exponent
integer
required

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.