Skip to main content
POST
Generate an account report

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

Body

application/json
name
string
required

Report name shown in the reports list.

Required string length: 1 - 200
dateFrom
integer
required

Period start (unix ms).

Required range: x > 0
dateTo
integer
required

Period end (unix ms). Must be >= dateFrom.

Required range: x > 0
description
string

Optional free-text description.

Maximum string length: 2000
reconcileWith
enum<string>

Compare each account against the Xero or QuickBooks trial balance and flag differences. Silently ignored unless the chosen platform is linked.

Available options:
xero,
qbo
comparePeriods
integer

How many earlier periods to compare with (0..11, default 0 = none). Each comparison window has the report period's shape shifted back by compareUnit; the profit_and_loss view then carries one movement column per window and the balance_sheet view the balance at each window's end.

Required range: 0 <= x <= 11
compareUnit
enum<string>

How each comparison window is shifted back: "month", "quarter" or "year" (the same period one month/quarter/year earlier, like Xero's Compare with), or "period" (the consecutive periods of the same length immediately before). A calendar unit must be at least as long as the report period (a year-long report cannot compare by month): 400 otherwise. Default: the smallest calendar unit the period fits in, else "period".

Available options:
month,
quarter,
year,
period

Response

Report generation queued

success
enum<boolean>
required
Available options:
true
data
object
required
Last modified on November 13, 2026