Invoices
What it does: Documents charges issued against financing agreements and billing periods.
Why it matters: Supports audit trails and reconciliation with external accounting and program reporting.
Technical reference — Read-only invoice endpoints.
The invoice model
- Name
id- Type
- string
- Description
Invoice identifier.
- Name
invoice_no- Type
- string
- Description
Human-readable invoice number.
- Name
title- Type
- string
- Description
Invoice title.
- Name
total- Type
- string
- Description
Total in contract currency.
- Name
usd_total- Type
- string
- Description
USD equivalent total.
- Name
invoice_paid- Type
- boolean
- Description
Whether the invoice has been paid.
- Name
created_at- Type
- string
- Description
Creation timestamp.
GET/payg/lms/invoices
List invoices
Query parameters
- Name
page- Type
- integer
- Description
- Page number.
- Name
limit- Type
- integer
- Description
- Page size.
- Name
search- Type
- string
- Description
- Search term.
- Name
date_from- Type
- string
- Description
- Created on or after.
- Name
date_to- Type
- string
- Description
- Created on or before.
- Name
currency- Type
- string
- Description
- Currency filter.
- Name
funding_source- Type
- string
- Description
- Funding program filter.
Request
GET
/payg/lms/invoicescurl -G https://api.hellotractor.com/payg/lms/invoices \
-H "Authorization: Bearer {your_api_key}" \
-d date_from=2025-05-01 \
-d date_to=2025-05-31
Response (redacted)
{
"count": 5,
"results": [
{
"id": "inv-***",
"invoice_no": "INV-2025-***",
"title": "Weekly service",
"total": "125000.00",
"usd_total": "85.00",
"invoice_paid": false,
"created_at": "2025-05-20T10:00:00Z"
}
]
}
GET/payg/lms/invoices/:id
Retrieve an invoice
cURL
curl https://api.hellotractor.com/payg/lms/invoices/inv-001 \
-H "Authorization: Bearer {your_api_key}"
Detail responses may include pdf_url, invoice_type, maintenance_fees, and user_id for authenticated collaborators.
Get started
New collaborators request access first; approved teams sign in and register integrations.