Saltar al contenido

Update an expense

Módulo Finance

PATCH/expenses/{id}expenses.update

An expense. One expense posts to exactly one budget line; the submitter cannot approve 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.expense.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

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

Cuerpo de la solicitud: ExpenseUpdate

expenses.update: ExpenseUpdate
CampoTipoObligatorioDescripción
descriptionstringNoExpense description.Restricciones: length 1 to 300
amount_minorinteger (int64)NoExpense amount. Integer minor units of the document currency.Restricciones: range 0 to any
currency_codestringNoISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
incurred_onstring (date)NoWhen it was incurred.
counterparty_idstring (uuid) | nullNoIdentifier of the counterparty paid, when it is not the submitter.
{
  "description": "Gaffer tape, 12 rolls",
  "amount_minor": 14388,
  "currency_code": "USD",
  "incurred_on": "2026-10-08",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: Expense

expenses.update: Expense
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the expense.
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.
budget_line_idstring (uuid)SíIdentifier of the budget line.
submitter_person_idstring (uuid) | nullSíIdentifier of the person who submitted the expense.
descriptionstringSíExpense description.Restricciones: length 1 to 300
amount_minorinteger (int64) | nullSíExpense amount. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
incurred_onstring (date)SíWhen it was incurred.
expense_state"Proposed" | "Approved" | "Rejected" | "Paid" | "Canceled"SíExpense state.
counterparty_idstring (uuid) | nullSíIdentifier of the counterparty paid, when it is not the submitter.
{
  "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",
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "submitter_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Gaffer tape, 12 rolls",
  "amount_minor": 14388,
  "currency_code": "USD",
  "incurred_on": "2026-10-08",
  "expense_state": "Proposed",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/expenses/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 '{"description":"Gaffer tape, 12 rolls","amount_minor":14388,"currency_code":"USD","incurred_on":"2026-10-08","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.expenses.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "description": "Gaffer tape, 12 rolls",
    "amount_minor": 14388,
    "currency_code": "USD",
    "incurred_on": "2026-10-08",
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.expenses.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"description": "Gaffer tape, 12 rolls", "amount_minor": 14388, "currency_code": "USD", "incurred_on": "2026-10-08", "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos expenses update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"Gaffer tape, 12 rolls","amount_minor":14388,"currency_code":"USD","incurred_on":"2026-10-08","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto