Expenses

List expense categories

Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided.

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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage 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 token	Manage expenses (employment_payments)	View expenses (expense:read)	Manage expenses (expense:write)

get/v1/expenses/categories

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/expenses/categories
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

employment_idstring

The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.

expense_idstring

The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.

include_parentsboolean

Include un-selectable intermediate categories in the response

country_codestring

Filter categories by country (ISO 3166-1 alpha-3 code, e.g. "GBR"). Only used when neither employment_id nor expense_id is provided.

Response

Success

Example response

{
  "data": [
    {
      "code": "travel",
      "description": "Travel-related expenses",
      "instructions": null,
      "is_selectable": false,
      "parent": null,
      "prompt": null,
      "scope": "global",
      "slug": "travel-abc123",
      "status": "active",
      "title": "Travel"
    },
    {
      "code": "travel.flights",
      "description": "Flight expenses for business travel",
      "instructions": "Please include flight confirmation number",
      "is_selectable": true,
      "parent": {
        "code": "travel",
        "slug": "travel-abc123",
        "title": "Travel"
      },
      "prompt": "What was the purpose of this flight?",
      "scope": "global",
      "slug": "travel-flights-abc123",
      "status": "active",
      "title": "Flights"
    }
  ]
}

Changes

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