Update a journal line

Finance module

PATCH/journal-lines/{id}journalLines.update

A line of a journal entry. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability finance.journal.write.
OAuth scopes: finance.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

journalLines.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the journal line.

Request body: JournalLineUpdate

journalLines.update: JournalLineUpdate
Field	Type	Required	Description
account_code	GlAccountCode	No	GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Constraints: pattern ^[0-9]{4}$
cost_center_id	string (uuid) \| null	No	Identifier of the cost center.
urid	UridAtAnyGrain	No	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
line_number	integer	No	Line number within the entry.Constraints: range 1 to any
description	string	No	Line description.Constraints: length 1 to 300
debit_minor	integer (int64)	No	Debit amount; zero on a credit line. Integer minor units of the document currency.Constraints: range 0 to any
credit_minor	integer (int64)	No	Credit amount; zero on a debit line. Integer minor units of the document currency.Constraints: range 0 to any
currency_code	string	No	ISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$
counterparty_id	string (uuid) \| null	No	Identifier of the counterparty.
element_id	ItemId \| null	No
quantity	number \| null	No	Quantity.
unit_basis	UnitCode \| null	No

{
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "line_number": 1,
  "description": "Reclass staging rental",
  "debit_minor": 45000,
  "credit_minor": 0,
  "currency_code": "USD",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 24
}

Response 200: JournalLine

journalLines.update: JournalLine
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the journal 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.
journal_entry_id	string (uuid)	Yes	Identifier of the journal entry.
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	string (uuid) \| null	Yes	Identifier of the cost center.
urid	UridAtAnyGrain	Yes	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
line_number	integer	Yes	Line number within the entry.Constraints: range 1 to any
description	string	Yes	Line description.Constraints: length 1 to 300
debit_minor	integer (int64) \| null	Yes	Debit amount; zero on a credit line. Integer minor units of the resource currency; null means unpriced, never zero.
credit_minor	integer (int64) \| null	Yes	Credit amount; zero on a debit line. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string	Yes	ISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$
counterparty_id	string (uuid) \| null	Yes	Identifier of the counterparty.
element_id	ItemId \| null	Yes
quantity	number \| null	Yes	Quantity.
unit_basis	UnitCode \| null	Yes

{
  "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"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/journal-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","line_number":1,"description":"Reclass staging rental","debit_minor":45000,"credit_minor":0,"currency_code":"USD","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":24}'

const { data, etag } = await xos.journalLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "line_number": 1,
    "description": "Reclass staging rental",
    "debit_minor": 45000,
    "credit_minor": 0,
    "currency_code": "USD",
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "quantity": 24
  }, { ifMatch: etag });

response = xos.journal_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "line_number": 1, "description": "Reclass staging rental", "debit_minor": 45000, "credit_minor": 0, "currency_code": "USD", "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "quantity": 24}, if_match=etag)

xos journal-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","line_number":1,"description":"Reclass staging rental","debit_minor":45000,"credit_minor":0,"currency_code":"USD","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":24}' --if-match auto