Skip to navigation

List Reimbursement Requests

Returns reimbursement claims, newest first. By default only claims waiting for a decision; use status for decided ones too. With salarybox_ids and status=all you get one staff member’s full claim history. Claims an admin deleted are never returned.

With multi-level approval, status=current shows only claims at a stage you can act on, as in the app. Other statuses are not narrowed.

Each item has status (pending, approved, declined, cancelled or revoked), action_by, action_on, action_reason and approval_flow, as described in List Leave Requests. Claims above a flow’s threshold amount show the threshold levels.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

statusenumOptionalDefaults to current

Which claims to return. Defaults to current.

  • current: waiting for a decision.
  • approved: approved.
  • declined: rejected by an approver before it was approved.
  • cancelled: withdrawn by the staff member while pending.
  • revoked: approved, then reversed by an admin.
  • all: every status.
salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

datalist of objects
messagestring
statusboolean
countinteger
prevstring or null
nextstring or null

Errors

400
Bad Request Error