List expenses

Lists expenses. Use status to list only expenses in the given statuses.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage expenses (employment_payments)View expenses (expense:read)Manage expenses (expense:write)
Company-scoped access token (assertion)Manage expenses (employment_payments)View expenses (expense:read)Manage expenses (expense:write)
Customer API tokenManage expenses (employment_payments)View expenses (expense:read)Manage expenses (expense:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status
array of strings

Filters expenses by status. To ask for several statuses, send status once with comma-separated values, for example status=approved,reimbursed. If you repeat status, only the last value counts. status[]= or any other value returns 422. The list never contains pending contractor or card spend expenses, so pending returns only expenses an employer can review.

status
Allowed:
integer

Starts fetching records after the given page

integer

Change the amount of records returned per page, defaults to 20, limited to 100

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json