Saltar al contenido

Get an expense

Módulo Finance

GET/expenses/{id}expenses.get

An expense. One expense posts to exactly one budget line; the submitter cannot approve it. Returns one expense with its `ETag`. A expense the caller may not see returns 404.

  • Requiere la capacidad finance.expense.read.
  • Alcances de OAuth: finance.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

expenses.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the expense.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: Expense

expenses.get: 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 GET "$XOS_BASE_URL/expenses/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.expenses.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.expenses.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos expenses get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f