Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
reimbursements

Get list of reimbursements

Get a list of reimbursement objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

get/v3/spend/reimbursements

Query parameters

nextPagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set this field as the nextPage value for navigation.

prevPagestring nullable

Previous page of results. Set this field as the prevPage value for navigation.

maxinteger nullable

Maximum number of results

Example:10
sortstring nullable

Field name and sort order. You can set only one sort field.

The format is sort={field}:{sort_order}.

The sortable fields are:

  • submittedTime
  • status
  • amount
  • receiptAddedTime
  • fulfillmentType
  • batchId
  • batchAmount
Example:submittedTime:desc
filtersstring nullable

Field name, operator, and value. You can set multiple filters.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example: budgetIds:in:"abc,def",submittedTime:gte:"2024-10-17T19:36:32.628Z"

The filterable fields are:

  • reimbursementIds - List of string IDs. Operators: eq, in.
  • budgetIds - List of string IDs. Operators: eq, in.
  • userIds - List of string IDs. Operators: eq, in.
  • customFieldValueIds - List of string IDs. Operators: eq, in.
  • type - PURCHASE, MILEAGE. Operators: eq.
  • submittedTime - DateTime. Operators: lte, gte.
  • retired - true or false. Operators: eq.
Example:reimbursementIds:eq:{{se_reimbursement_uuid}}

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Response

Get list of reimbursements response

nextPagestring

Next page token

prevPagestring

Previous page token