List journal line rows
Módulo Finance
GET/journal-linesjournalLines.list
A line of a journal entry. Returns a cursor page of journal line rows the caller may see. Coded list: the default order is numeric code order by `account_code`. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad finance.journal.read.
- Alcances de OAuth: finance.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: 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).Restricciones: 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. |
Respuesta 200: una página de JournalLine
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the journal line. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| journal_entry_id | string (uuid) | Sí | Identifier of the journal entry. |
| account_code | GlAccountCode | Sí | GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Restricciones: pattern ^[0-9]{4}$ |
| cost_center_id | string (uuid) | null | Sí | Identifier of the cost center. |
| urid | UridAtAnyGrain | Sí | URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$ |
| line_number | integer | Sí | Line number within the entry.Restricciones: range 1 to any |
| description | string | Sí | Line description.Restricciones: length 1 to 300 |
| debit_minor | integer (int64) | null | Sí | Debit amount; zero on a credit line. Integer minor units of the resource currency; null means unpriced, never zero. |
| credit_minor | integer (int64) | null | Sí | Credit amount; zero on a debit line. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Sí | ISO 4217 currency code of every money field on the row.Restricciones: pattern ^[A-Z]{3}$ |
| counterparty_id | string (uuid) | null | Sí | Identifier of the counterparty. |
| element_id | ItemId | null | Sí | |
| quantity | number | null | Sí | Quantity. |
| unit_basis | UnitCode | null | Sí |
{
"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",
"journal_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"account_code": "1000",
"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01",
"line_number": 1,
"description": "Reclass staging rental",
"debit_minor": 45000,
"credit_minor": 0,
"currency_code": "USD",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"element_id": "4000.01.01-XPMS-001",
"quantity": 24,
"unit_basis": "each"
},
{
"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",
"journal_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"account_code": "5400",
"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01",
"line_number": 1,
"description": "Reclass staging rental",
"debit_minor": 45000,
"credit_minor": 0,
"currency_code": "USD",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"element_id": "4000.01.01-XPMS-001",
"quantity": 24,
"unit_basis": "each"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/journal-lines" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.journalLines.listAll()) {
console.log(row);
}for row in xos.journal_lines.list_all():
print(row)xos journal-lines list --all