curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/reports/general-ledger \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/reports/general-ledger"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/reports/general-ledger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "General ledger retrieved successfully",
"data": {
"current_page": 1,
"data": [
{
"uuid": "gl111111111111111111111111111111",
"date": "2026-03-01T00:00:00.000000Z",
"journal_no": "JNL-1001",
"narration": "Invoice INV-1042 — Website design services",
"account": "Accounts Receivable",
"account_type": "Assets",
"account_sub_type": "Accounts receivable",
"transaction_type": "Invoice",
"debit_amount": 150000,
"credit_amount": 0,
"main_debit_amount": 150000,
"main_credit_amount": 0,
"currency": "NGN",
"contact": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"contact_name": "John Smith",
"branch": null,
"department": null,
"project": null
}
],
"per_page": 100,
"total": 1
}
}General ledger
Paginated chronological ledger of all posted journal legs across the business — the complete double-entry audit trail. Filter by account name, contact, transaction type, or date range. Each row includes debit/credit amounts in both transaction and base currency.
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/reports/general-ledger \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/reports/general-ledger"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/reports/general-ledger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "General ledger retrieved successfully",
"data": {
"current_page": 1,
"data": [
{
"uuid": "gl111111111111111111111111111111",
"date": "2026-03-01T00:00:00.000000Z",
"journal_no": "JNL-1001",
"narration": "Invoice INV-1042 — Website design services",
"account": "Accounts Receivable",
"account_type": "Assets",
"account_sub_type": "Accounts receivable",
"transaction_type": "Invoice",
"debit_amount": 150000,
"credit_amount": 0,
"main_debit_amount": 150000,
"main_credit_amount": 0,
"currency": "NGN",
"contact": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"contact_name": "John Smith",
"branch": null,
"department": null,
"project": null
}
],
"per_page": 100,
"total": 1
}
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Query Parameters
Period start date (Y-m-d). Alias: from_date.
Alias for from.
Period end date (Y-m-d). Alias: to_date.
Alias for to.
Pass 1 to return raw data only without the status/message wrapper.
1 Match narration, journal no, contact name, or account name.
Filter by transaction type (e.g. invoice, expenses, sales_receipt).
Filter by account name.
Filter by contact identifier.
Filter by branch.
Page size (default 100).
Page number.
Response
Paginated general ledger