List gl

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

GET /v1/books/gl

Books → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/books/gl`
Method	`GET`
Operation	`get_books_gl`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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.

Field	In	Type	Required	Description
`sandbox`	query	string	—	Sandbox reads the org's SANDBOX ledger when it is exactly "true".
`limit`	query	integer	—	Limit caps how many rows come back; 500 when absent or not positive.

Response

Status	Body	Meaning
`200`	books.GLRow[]	ok
`default`	problem-details	refused

200 body — 9 fields.

Field	In	Type	Always	Description
`[].account`	body	string	—	Account is the chart-of-accounts number this leg posts to.
`[].against`	body	string	—	Against 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.
`[].credit`	body	integer (int64)	—	Credit is the amount credited to that account, in whole cents.
`[].debit`	body	integer (int64)	—	Debit is the amount debited to that account, in whole cents.
`[].id`	body	integer (int64)	—	ID is the entry's position in the ledger.
`[].postingAt`	body	string	—	PostingAt is the accounting date this entry belongs to — what the reports window on, which need not be when the row was written.
`[].remarks`	body	string	—	Remarks is the memo carried onto the entry, for a human reading the ledger.
`[].sourceId`	body	string	—	SourceID identifies that originating record within its kind.
`[].sourceKind`	body	string	—	SourceKind is what caused the posting: a bank line, a scanned document, a commerce sale.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo books gl

.ts

.py

.go

.rs

.java

import { Configuration, BooksApi } from 'hanzoai';

const api = new BooksApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBooksGl();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BooksApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BooksApi(client).get_books_gl()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.BooksAPI.GetBooksGl(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, books_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = books_api::get_books_gl(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BooksApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new BooksApi(client).getBooksGl();

curl https://api.hanzo.ai/v1/books/gl \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches books through the books tool, which names its 20 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_book_accounts"
         }
       }
     }'

Books API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousExport books NextList inbox