Pay & Compensation
Expenses

List expenses

Changed on

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 through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage expenses (employment_payments)View expenses (expense:read)Manage expenses (expense:write)
get/v1/expenses

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/expenses
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, expense:read, expense:write, employment_payments, all:write, all:read)

Query parameters

statusstring[]

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.

pageinteger

Starts fetching records after the given page

page_sizeinteger

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

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "current_page": 1,
  "expenses": [
    {
      "amount": 8000,
      "converted_amount": 8000,
      "converted_currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      },
      "converted_tax_amount": 0,
      "currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      },
      "employment_id": "ba9ead59-e471-4043-a7ea-07dbb105e72c",
      "expense_date": "2020-12-11",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "tax_amount": 0,
      "title": "New keyboard"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

  • 011e5a8b97f5Revision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional query request parameter status

    • info

      added the success response with the status