Finance
Read-only access to invoices, payments and the chart of accounts. Scopes: finance:invoices:read, finance:payments:read, finance:accounts:read.
List Invoices
GET
/finance/invoices
Invoices with total, paid and remaining amounts.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
search | string | Text search on invoice number / customer |
status | string | draft, ready, settled, balance (has remaining balance), credit |
dateFrom, dateTo | string | Date range, YYYY-MM-DD (Gregorian) |
page, pageSize | number | Pagination (pageSize max 100) |
Example
curl -G "https://www.HomaCRM.com/api/v1/external/finance/invoices" \
-H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
-H "Accept: application/json" \
--data-urlencode "status=balance" \
--data-urlencode "dateFrom=2026-06-01"
Get Invoice
GET
/finance/invoices/{id}
Invoice header plus line items (quantity, unit price, discount, line total) and payments. Sensitive internal fields are omitted.
List Payments
GET
/finance/payments
Payments and receipts. Query: search, invoiceId, dateFrom, dateTo, page, pageSize. Each record has a direction of pay or receive.
Chart of Accounts Tree
GET
/finance/accounts/tree
Three-level accounting coding hierarchy: group → total (کل) → secondary (معین).