Skip to main content
GET
Get balance sheet
Filter by accounting_period_ids, or by start_date and end_date. Do not combine them. Without a filter, every accounting period is a column.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

tag_id
string

Prefixed tag ID (tag_). Filters the report to one tag. Get tag IDs from List tags.

start_date
string<date-time>

Start of the window (ISO 8601, inclusive). Send with end_date. A date inside a period returns the full period. You cannot send it with accounting_period_id or accounting_period_ids.

end_date
string<date-time>

Inclusive end of the window (ISO 8601). Send it with start_date. Each column is a whole accounting period, so a date inside a period returns the full period.

include_zero_rows
boolean
default:true

Set to false to omit accounts that are zero in every period. Defaults to true.

Legal entities to include (le_…). Omit to include all.

Maximum array length: 100

Legal entity ID (le_…).

accounting_period_id
string

Accounting period ID (ap_…).

Example:

"ap_507f1f77bcf86cd799439011"

accounting_period_ids
string[]

Accounting period IDs (ap_…), up to 100. Omit to return every period.

verbosity
enum<string>
default:faithful

faithful (the default) returns all fields. compact returns the same figures in a smaller shape.

Available options:
faithful,
compact
as_of
boolean
default:false

Set to true to include every period from the first period through end_date. Requires end_date; start_date, accounting_period_id or accounting_period_ids return HTTP 400. Defaults to false.

Response

The request succeeded.

data
object
required