Update a journal entry
Finance module
PATCH/journal-entries/{id}journalEntries.update
A journal entry. The preparer cannot post it. 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the journal entry. |
Request body: JournalEntryUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| accounting_period_id | string (uuid) | No | Identifier of the accounting period. |
| entry_date | string (date) | No | Entry date. |
| memo | string | No | Memo.Constraints: length 1 to 300 |
| project_id | string (uuid) | null | No | Identifier of the project. |
{
"accounting_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"entry_date": "2026-10-08",
"memo": "Reclass staging rental",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 200: JournalEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the journal entry. |
| 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. |
| accounting_period_id | string (uuid) | Yes | Identifier of the accounting period. |
| entry_date | string (date) | Yes | Entry date. |
| memo | string | Yes | Memo.Constraints: length 1 to 300 |
| journal_state | "Proposed" | "Posted" | "Canceled" | Yes | Journal state. |
| posted_at | string (date-time) | null | Yes | When it was posted. |
| posted_by | string (uuid) | null | Yes | Identifier of the poster. |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
| prepared_by | string (uuid) | null | Yes | Identifier of the person who prepared the entry. |
| source_table | string | null | Yes | Table of the document that produced the entry.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| source_id | string (uuid) | null | Yes | Identifier of the document that produced the entry. |
{
"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",
"accounting_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"entry_date": "2026-10-08",
"memo": "Reclass staging rental",
"journal_state": "Proposed",
"posted_at": "2026-10-08T14:30:00Z",
"posted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"prepared_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"source_table": "invoices",
"source_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X PATCH "$XOS_BASE_URL/journal-entries/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 '{"accounting_period_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","entry_date":"2026-10-08","memo":"Reclass staging rental","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data, etag } = await xos.journalEntries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"accounting_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"entry_date": "2026-10-08",
"memo": "Reclass staging rental",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}, { ifMatch: etag });response = xos.journal_entries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"accounting_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "entry_date": "2026-10-08", "memo": "Reclass staging rental", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)xos journal-entries update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"accounting_period_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","entry_date":"2026-10-08","memo":"Reclass staging rental","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto