Approve expense claim

Approves a submitted (or declined) expense claim and posts its bill; for a personal claim settlement_method says how the claimant is paid back (bank_payout, or current_account for a director or shareholder). A claim dated in a locked period is refused with 422 expense_claim_period_locked unless book_in_open_period is true, which books it on the first open day (error.fields.next_open_date). Under a claims approval policy the call records this approver's step and the claim may still wait. Every refusal names its code in error.code and at the start of error.message (for example expense_claim_self_approval, expense_claim_requirements_missing, expense_claim_status_mismatch), and the field in error.fields. Idempotency-Key and If-Match with the latest ETag are required. Requires the expense-claims:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to approve expense claim. The schema identifies required and optional values.

string | null
enum
Allowed:
boolean
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*