Skip to content

Post a journal entry

Finance module

POST/journal-entries/{id}/postjournalEntries.post

Posts the entry to the ledger. The preparer cannot post it; a closed period refuses it. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability finance.journal.post.
  • OAuth scopes: finance.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

journalEntries.post: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the journal entry.

Response 200: JournalEntry

journalEntries.post: JournalEntry
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the journal entry.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
accounting_period_idstring (uuid)YesIdentifier of the accounting period.
entry_datestring (date)YesEntry date.
memostringYesMemo.Constraints: length 1 to 300
journal_state"Proposed" | "Posted" | "Canceled"YesJournal state.
posted_atstring (date-time) | nullYesWhen it was posted.
posted_bystring (uuid) | nullYesIdentifier of the poster.
project_idstring (uuid) | nullYesIdentifier of the project.
prepared_bystring (uuid) | nullYesIdentifier of the person who prepared the entry.
source_tablestring | nullYesTable of the document that produced the entry.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
source_idstring (uuid) | nullYesIdentifier 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 POST "$XOS_BASE_URL/journal-entries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/post" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.journalEntries.post("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.journal_entries.post("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos journal-entries post 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f