Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Rollforward request

currency
string
required
period_start
string<date-time>
required

YYYY-MM

accounts
enum<string>[]

defaults to [deferred_revenue]

Available options:
cash,
accounts_receivable,
unbilled_receivable,
deferred_revenue,
customer_credit,
tax_payable,
revenue,
contra_revenue
contract_ids
string[]
customer_ids
string[]
group_by
enum<string>[]
Available options:
customer_id,
contract_id,
pob_id
limit
integer

item rows per page; totals are never paged

Required range: 0 <= x <= 1000
offset
integer
Required range: x >= 0
period_end
string<date-time>

YYYY-MM, an ended month; defaults to period_start

pob_ids
string[]
posted_by
string

only entries posted at or before it: the books as they were then

Response

OK

items
object[]

per period, account and group; empty without group_by

pagination
object
totals
object[]

per period and account, all groups