Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/billing/invoices
Returns invoices for your tenant’s billing history. Each invoice includes the amount, currency, payment status, and links to download the PDF or receipt.

​
Query parameters

​
start
string
Filter invoices created on or after this date (ISO 8601, e.g. 2026-01-01).
​
end
string
Filter invoices created on or before this date (ISO 8601, e.g. 2026-06-30).

​
Export invoices

GET /v1/billing/exports/accounting
Enterprise tenants can export invoices as CSV or JSON for accounting and reconciliation. The export includes invoice number, status, issue and due dates, amounts, tax, currency, and PO references. If no date range is provided, the export defaults to the last 30 days.
​
format
string
Export format: csv or json. Defaults to csv.
​
from
string
Start of the date range (YYYY-MM-DD, e.g. 2026-01-01). Defaults to 30 days ago.
​
to
string
End of the date range (YYYY-MM-DD, e.g. 2026-06-30). Defaults to today.

​
Response

Returns an array of invoice objects.
​
id
string
Invoice identifier.
​
invoice_number
string
Human-readable invoice number.
​
status
string
Payment status: paid, open, void, or uncollectible.
​
total
integer
Total amount in the smallest currency unit (e.g., cents for USD).
​
amount
integer
Amount due in the smallest currency unit.
​
currency
string
ISO 4217 currency code (e.g., usd, ngn).
​
created_at
string
ISO 8601 timestamp when the invoice was created.
​
issued_at
string
ISO 8601 timestamp when the invoice was finalized and sent.
​
due_at
string
ISO 8601 timestamp for the payment due date.
​
full_pdf_url
string
URL to download the full invoice PDF.
​
receipt_url
string
URL to view the payment receipt (available for paid invoices).