---
title: "Get Billing Document Breakdown. Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token."
method: GET
path: "/v1/billing-documents/{billing_document_id}/breakdown"
tags: ["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 /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: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `invoices:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `invoices:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

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](https://developer.remote.com/docs/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](https://developer.remote.com/docs/authorization-method-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](https://developer.remote.com/docs/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 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 token | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) |

## Path parameters

- `billing_document_id` string, required

## Query parameters

- `type` string

## Response `200`

Success

- BillingDocumentBreakdownResponse: Information about a billing document breakdown
  - `data` object, required
    - `billing_document_breakdown` BillingDocumentBreakdownItem[], required
      - `country_code` string, nullable, required: Country code according to ISO 3166-1 3-digit alphabetic codes. May be null for legal-entity-wide lines.
      - `description` string, required: A human-readable description of this cost item.
      - `employment_id` string, uuid, nullable, required: A unique identifier in UUID v4 format for the employment this cost belongs to. May be null for legal-entity-wide lines that apply to the whole legal entity rather than a single employment.
      - `fx_rate` string, required: The foreign exchange rate applied to convert from the source currency to the invoice currency.
      - `invoice_amount` integer, required: Invoice amount in cents
      - `invoice_currency` string, required: Currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
      - `invoice_number` string, required: The invoice number associated with this breakdown item.
      - `invoice_period` string, required: The invoice period in YYYY-MM format.
      - `source_amount` integer, required: Source amount in cents
      - `source_currency` string, required: Currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
      - `type` string, required: The cost category (e.g., "Base Salary", "Employer Contributions", "Benefits").
      - `variance_from_invoice` string, nullable, required: A human-readable note about any variance between the breakdown amount and the invoiced amount, typically due to FX rounding.
      - `variance_from_invoice_amount` integer, nullable, required: Variance from invoice amount in cents

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/billing.md) - [All operations](https://skmtc.dev/remote-com/apis/billing/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/billing/revisions/cb627dcc7315?raw)