Skip to content

Create an expense

Finance module

POST/expensesexpenses.create

An expense. One expense posts to exactly one budget line; the submitter cannot approve it. Creates an expense. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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

Request body: ExpenseCreate

expenses.create: ExpenseCreate
FieldTypeRequiredDescription
budget_line_idstring (uuid)YesIdentifier of the budget line.
descriptionstringYesExpense description.Constraints: length 1 to 300
amount_minorinteger (int64)YesExpense amount. Integer minor units of the document currency.Constraints: range 0 to any
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
incurred_onstring (date)YesWhen it was incurred.
counterparty_idstring (uuid) | nullNoIdentifier of the counterparty paid, when it is not the submitter.
{
  "budget_line_id": "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"
}

Response 201: Expense

expenses.create: Expense
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the expense.
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.
budget_line_idstring (uuid)YesIdentifier of the budget line.
submitter_person_idstring (uuid) | nullYesIdentifier of the person who submitted the expense.
descriptionstringYesExpense description.Constraints: length 1 to 300
amount_minorinteger (int64) | nullYesExpense amount. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
incurred_onstring (date)YesWhen it was incurred.
expense_state"Proposed" | "Approved" | "Rejected" | "Paid" | "Canceled"YesExpense state.
counterparty_idstring (uuid) | nullYesIdentifier 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"
}

Code samples

curl -X POST "$XOS_BASE_URL/expenses" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"budget_line_id":"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"}'
const { data } = await xos.expenses.create({
    "budget_line_id": "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"
  });
response = xos.expenses.create({"budget_line_id": "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"})
xos expenses create --data '{"budget_line_id":"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"}'