REremote-com
Billing Documents

Get Billing Document Breakdown. Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token.

Get billing document breakdown

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 invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
Company-scoped access token (assertion)Manage invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
Customer API tokenManage invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
get/v1/billing-documents/{billing_document_id}/breakdown

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/billing-documents/{billing_document_id}/breakdown
  • 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: invoices: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: invoices: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

Path parameters

billing_document_idstring required

The billing document's ID

Query parameters

typestring

Filters the results by the type of the billing breakdown item. Matched exactly against the type field of the returned items, so unrecognised values yield an empty list. Card spend is reported as Card expenses, separately from payroll-reimbursed Expenses. Other Compensation is reported as Other compensation, separately from Base salary. Payslip benefits can be returned as Payslip benefits for existing breakdown items, or as Payslip Benefit Cash and Payslip Benefit Non-Cash for newly generated items.

Response

Success

Example response

{
  "data": {
    "billing_document_breakdown": [
      {
        "country_code": "PRT",
        "description": "Base Salary",
        "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "fx_rate": "0.9",
        "invoice_amount": 900000,
        "invoice_currency": "EUR",
        "invoice_number": "1234567890",
        "invoice_period": "2023-12",
        "source_amount": 1000000,
        "source_currency": "USD",
        "type": "Base Salary",
        "variance_from_invoice": "May vary from invoice by under USD 1.00 (or equivalent)",
        "variance_from_invoice_amount": 0
      }
    ]
  }
}

Changes

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