List posting line rows
Finance module
GET/posting-linespostingLines.list
A Universal Posting Line (Bible tab 36): the one export shape, projected to every accounting platform. Returns a cursor page of posting line rows the caller may see. Coded list: the default order is numeric code order by `account_code`, then `urid`. Supports sparse fieldsets and the filter grammar.
- Requires the capability finance.journal.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 PostingLine
| Field | Type | Required | Description |
|---|---|---|---|
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| date | string (date) | Yes | Date the cost or revenue is recognized. |
| account_code | GlAccountCode | Yes | GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Constraints: pattern ^[0-9]{4}$ |
| cost_center_id | CostCenterCode | null | Yes | |
| urid | UridAtAnyGrain | null | Yes | |
| vendor_id | string (uuid) | null | Yes | Identifier of the vendor organization; null for revenue. |
| item_id | ItemId | Yes | Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$ |
| description | string | Yes | Sentence-case line description.Constraints: length 1 to 300 |
| quantity | number | null | Yes | Quantity. |
| unit_basis | UnitCode | Yes | Unit basis from the controlled unit list in `xpms.dim_unit_alias`.Constraints: pattern ^[a-z][a-z0-9_-]*$ |
| amount_minor | integer (int64) | null | Yes | Signed amount; negative for credits. Integer minor units of the resource currency; null means unpriced, never zero. |
| tax_type | TaxType | Yes | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| currency | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| external_ref | string | null | Yes | Invoice, card transaction or record identifier.Constraints: length 1 to 300 |
| line_state | SharedState | Yes | A value from the shared finance and commercial state vocabulary (Bible tab 37): the five core states plus declared domain extensions.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| posting_line_id | string (uuid) | Yes | Identifier of the posting line. |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
{
"data": [
{
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"date": "2026-10-08",
"account_code": "5000",
"cost_center_id": "CC-VENUE",
"urid": "0000.01",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"item_id": "4000.01.01-XPMS-001",
"description": "Stage deck rental for opening weekend.",
"quantity": 24,
"unit_basis": "each",
"amount_minor": 108000,
"tax_type": "Tax on Purchases",
"currency": "USD",
"external_ref": "INV-2026-0042",
"line_state": "Committed",
"posting_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
},
{
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"date": "2026-10-08",
"account_code": "5400",
"cost_center_id": "CC-VENUE",
"urid": "4000.01",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"item_id": "4000.01.01-XPMS-001",
"description": "Stage deck rental for opening weekend.",
"quantity": 24,
"unit_basis": "each",
"amount_minor": 108000,
"tax_type": "Tax on Purchases",
"currency": "USD",
"external_ref": "INV-2026-0042",
"line_state": "Committed",
"posting_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/posting-lines" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.postingLines.listAll()) {
console.log(row);
}for row in xos.posting_lines.list_all():
print(row)xos posting-lines list --all