REremote-com
Expenses

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)
get/v1/expenses

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/expenses
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: expense:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: expense:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

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

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

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

No recorded changes to this operation across all 1 revision of this API.