Expenses

Create expense

Creates an approved expense

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:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage expenses (employment_payments)	-	Manage expenses (expense:write)
Company-scoped access token (assertion)	Manage expenses (employment_payments)	-	Manage expenses (expense:write)
Customer API token	Manage expenses (employment_payments)	-	Manage expenses (expense:write)

post/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:write
- 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:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

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.

Request body

amountinteger required

The expense amount in the specified currency, in cents.

Categories allowed for an expense (legacy, deprecated).<br/> Note: coworking, home_office, phone_utilities, travel are deprecated and will be removed in the future.

currencystring required

The three-letter code for the expense currency.<br/> Examples: "USD", "EUR", "CAD"

employment_idstring required

The ID for the employment to which this expense relates.

expense_category_slugstring nullable

Slug of the expense category from the hierarchical categories system (recommended). Takes precedence over legacy category field.

expense_datestring required

Date of the purchase, which must be in the past

reviewed_atstring date-time

The date and time that the expense was reviewed in ISO8601 format. If not provided, it defaults to the current datetime.

reviewer_idstring

If the person reviewing the expense is a user in Remote, you can provide its user id for this field. If a value is not provided, defaults to the user that generated the API token.

tax_amountinteger

The tax portion of the expense amount, in cents. Use 0 if no tax applies.

timezonestring

TZ identifier

titlestring required

A short description of the expense (e.g., "New keyboard", "Team dinner").

Example request

{
  "amount": 8000,
  "currency": "EUR",
  "employment_id": "d4ebc714-4950-47a9-a464-28e1f1ab2a90",
  "expense_category_slug": "uuid-tech-equipment-slug",
  "expense_date": "2020-12-11",
  "receipt": {
    "content": "UGVyaW9kIEVuZCBEYXRlLFBheSBEYXRlLEVtcG...5jZSBPZiBSZXNpZGVuYdXJyZW50LEFsbG93",
    "name": "receipt.pdf"
  },
  "reviewed_at": "2021-07-15T18:18:17Z",
  "reviewer_id": "14c14128-f5f4-475a-8ec0-6329b4832a61",
  "tax_amount": 0,
  "timezone": "Etc/UTC",
  "title": "new keyboard"
}

Response

Success

Example response

{
  "data": {
    "expense": {
      "amount": 1000,
      "category": "tech_equipment",
      "converted_amount": 1000,
      "converted_currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      },
      "converted_tax_amount": 500,
      "currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      },
      "employment_id": "ba9ead59-e471-4043-a7ea-07dbb105e72c",
      "expense_category": {
        "code": "tech.equipment",
        "slug": "uuid-tech-equipment-slug",
        "title": "Technology Equipment"
      },
      "expense_date": "2021-09-03",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "project": {
        "code": "PRJ-001",
        "id": "uuid-client-site-project-slug",
        "name": "Client site rollout"
      },
      "receipts": [
        {
          "id": "9880b711-file-id-ecf8f551bd78",
          "inserted_at": "2021-07-15T18:18:17Z",
          "name": "id.pdf",
          "sub_type": "personal_id",
          "type": "id"
        }
      ],
      "status": "pending",
      "tax_amount": 500,
      "title": "New desk"
    }
  }
}

Changes

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