API Reference

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
https://gateway.remote.com/v1/billing-documents//breakdown

Get billing document breakdown

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The billing document's ID

Query Params
string

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.

Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?