accountRegister

returns AccountRegister

One entity's posted lines on one account, oldest first, each with the balance it leaves.

The lines run from an opening balance to a closing one, which is the trial balance's for the same window added to the opening. An income or expense account's opening counts from the fiscal year's start.

Arguments

Name	Type	Description
accountId	String!	The account.
startDate	Date	Start of the window (inclusive). Omit from the first line.
endDate	Date	End of the window (inclusive). Omit through the last line.
entityId	String	The entity whose books to read. Omit for the group parent.
dimensionType	String	A management dimension axis to slice by, with dimension_member_id.
dimensionMemberId	String	The one member whose lines to read, or `unallocated` for the lines no member of the axis tags.
flowElementId	String	Only the lines tagged to this cash flow or equity movement row.
includeDrafts	Boolean! = false	Also return the window's draft lines, outside every balance.
after	String	The `nextCursor` of the page before.
limit	Int	Maximum rows to return, 1-1000. Omit to use this field's own default; out of range raises `INVALID_PAGINATION`.

Returns AccountRegister

One account's lines over a window, each with the balance it leaves. closingBalance is openingBalance plus the window's lines, and equals the trial balance's net for the same entity, account and window added to the opening. A page carries its own pageOpeningBalance, so reading one page needs none before it.

Field	Type	Description
account	RegisterAccount!	The account read.
entityId	String	The entity whose books were read.
startDate	Date	The window's first day; null from the first line.
endDate	Date	The window's last day; null through the last line.
openingFrom	Date	The day the opening balance counts from: the fiscal year's start for an income or expense account, null (inception) for any other.
openingBalance	Float!	The balance before the window's first line, natural sign.
totalDebits	Float!	The window's debits, in dollars.
totalCredits	Float!	The window's credits, in dollars.
closingBalance	Float!	The balance after the window's last line, natural sign. A window spanning fiscal years carries an income or expense account's balance across the year end rather than resetting it.
lineCount	Int!	How many lines the window holds.
pageOpeningBalance	Float!	The balance before this page's first line, natural sign.
lines	[RegisterLine!]!	This page's lines, oldest first.
nextCursor	String	Pass as `after` for the next page; null on the last.
drafts	[RegisterLine!]!	With `include_drafts`, on the first page only: the window's draft lines on the account, oldest first and at most a page of them, outside every balance above.
draftsTruncated	Boolean!	True when the window holds more drafts than `drafts` lists.
sliced	Boolean!	True when read for one management dimension member, its axis's Unallocated, or one flow row: the balances are that slice's, not the account's.

Example

query

{ accountRegister(accountId: "...", includeDrafts: true) { entityId startDate endDate openingFrom } }

curl

curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ accountRegister(accountId: \"...\", includeDrafts: true) { entityId startDate endDate openingFrom } }"}'