Skip to main content
GET
Get general ledger report

Headers

Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

accept
string
required

Query Parameters

basis
string

Accounting basis for the report (e.g., cash, accrual)

Example:

"accrual"

precision
number

Number of decimal places to display

Example:

2

divideOn1000
boolean

Whether to divide the number by 1000

Example:

false

showZero
boolean

Whether to show zero values

Example:

true

formatMoney
enum<string>

How to format money values

Available options:
total,
always,
none
Example:

"total"

negativeFormat
enum<string>

How to format negative numbers

Available options:
parentheses,
mines
Example:

"parentheses"

noneTransactions
boolean
default:false

Whether to exclude transactions from the report

Example:

false

accountsIds
number[]

Array of account IDs to filter the report

Example:

Response

General ledger report

query
object
required

Query parameters used to generate the report

data
object[]
required

General ledger data

meta
object
required

Report metadata