Saltar al contenido

Update a journal entry

Módulo Finance

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.

  • Requiere la capacidad finance.journal.write.
  • Alcances de OAuth: finance.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

journalEntries.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the journal entry.

Cuerpo de la solicitud: JournalEntryUpdate

journalEntries.update: JournalEntryUpdate
CampoTipoObligatorioDescripción
accounting_period_idstring (uuid)NoIdentifier of the accounting period.
entry_datestring (date)NoEntry date.
memostringNoMemo.Restricciones: length 1 to 300
project_idstring (uuid) | nullNoIdentifier 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"
}

Respuesta 200: JournalEntry

journalEntries.update: JournalEntry
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the journal entry.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
accounting_period_idstring (uuid)SíIdentifier of the accounting period.
entry_datestring (date)SíEntry date.
memostringSíMemo.Restricciones: length 1 to 300
journal_state"Proposed" | "Posted" | "Canceled"SíJournal state.
posted_atstring (date-time) | nullSíWhen it was posted.
posted_bystring (uuid) | nullSíIdentifier of the poster.
project_idstring (uuid) | nullSíIdentifier of the project.
prepared_bystring (uuid) | nullSíIdentifier of the person who prepared the entry.
source_tablestring | nullSíTable of the document that produced the entry.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
source_idstring (uuid) | nullSí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"
}

Ejemplos de código

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