Hanzo
OpenapiBooks

ListGL returns the org's most recent GL Entry rows, newest first.

ListGL returns the org's most recent GL Entry rows, newest first.

GET /v1/books/gl

Addresshttps://api.hanzo.ai/v1/books/gl
MethodGET
Operationget_books_gl
AuthAuthorization: Bearer $HANZO_API_KEY

ListGL returns the org's most recent GL Entry rows, newest first. This is the raw double-entry detail behind every statement: one row per leg, with its debit, credit, posting time and the source that booked it.

Request

2 fields.

FieldInTypeRequiredDescription
sandboxquerystringSandbox reads the org's SANDBOX ledger when it is exactly "true".
limitqueryintegerLimit caps how many rows come back; 500 when absent or not positive.

Response

StatusBodyMeaning
200GLRow[]ok

200 body — 9 fields.

FieldInTypeAlwaysDescription
[].accountbodystringAccount is the chart-of-accounts number this leg posts to.
[].againstbodystringAgainst names the OTHER accounts in the same voucher — the contra side of this leg — so a single row reads as an entry rather than as half of one.
[].creditbodyintegerCredit is the amount credited to that account, in whole cents.
[].debitbodyintegerDebit is the amount debited to that account, in whole cents.
[].idbodyintegerID is the entry's position in the ledger.
[].postingAtbodystringPostingAt is the accounting date this entry belongs to — what the reports window on, which need not be when the row was written.
[].remarksbodystringRemarks is the memo carried onto the entry, for a human reading the ledger.
[].sourceIdbodystringSourceID identifies that originating record within its kind.
[].sourceKindbodystringSourceKind is what caused the posting: a bank line, a scanned document, a commerce sale.

Failure carries the platform error shape — see Errors.

Examples

hanzo books gl

Books API · All Hanzo APIs · Interactive reference

How is this guide?

On this page