List invoice line rows
Finance module
GET/invoice-linesinvoiceLines.list
A line of an invoice. Returns a cursor page of invoice line rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability finance.invoice.read.
- OAuth scopes: finance.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of InvoiceLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invoice line. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| invoice_id | string (uuid) | Yes | Identifier of the invoice. |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | null | Yes | Quantity. |
| unit_price_minor | integer (int64) | null | Yes | Unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| line_number | integer | Yes | Line number within the invoice.Constraints: range 1 to any |
| budget_line_id | string (uuid) | null | Yes | Identifier of the budget line. |
| tax_rate_id | string (uuid) | null | Yes | Identifier of the tax rate. |
| urid | UridAtAnyGrain | null | Yes |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Stage deck rental",
"quantity": 24,
"unit_price_minor": 4500,
"line_number": 1,
"budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/invoice-lines" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.invoiceLines.listAll()) {
console.log(row);
}for row in xos.invoice_lines.list_all():
print(row)xos invoice-lines list --all