API Docs / Schemas / BooksReportLineDto

BooksReportLineDto

One line of a report.

Properties

Name Type Description
namestring

The line's label — an account name, or the name of a subtotal.

The line's label — an account name, or the name of a subtotal.

nominalCodestring

The account's nominal code, where the platform puts one on the line. Null on platforms whose
reports carry names and figures only (Xero, QuickBooks), and on every subtotal.

The account's nominal code, where the platform puts one on the line. Null on platforms whose
reports carry names and figures only (Xero, QuickBooks), and on every subtotal.

amountnumber

The line's value for the period.

The line's value for the period.

isTotalboolean

Whether this line is a total or subtotal rather than an account. Totals must not be summed
with the lines around them.

Whether this line is a total or subtotal rather than an account. Totals must not be summed
with the lines around them.

isArchivedboolean

Whether the account behind this line is archived in the books — Xero's "archived",
QuickBooks' inactive. Reports go on listing retired accounts, usually at nil, so the practice
UI hides an archived line whose amount is zero and shows every other one. False on subtotals,
and on platforms whose reports do not identify the account (FreeAgent, which has no archiving
at all) — it means "not known to be archived", never "known to be active".

Whether the account behind this line is archived in the books — Xero's "archived",
QuickBooks' inactive. Reports go on listing retired accounts, usually at nil, so the practice
UI hides an archived line whose amount is zero and shows every other one. False on subtotals,
and on platforms whose reports do not identify the account (FreeAgent, which has no archiving
at all) — it means "not known to be archived", never "known to be active".

JSON Example

{
  "name": "string",
  "nominalCode": "string",
  "amount": 0,
  "isTotal": false,
  "isArchived": false
}

Contained in Schemas