Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Billing Documents

Get Billing Document Breakdown

Get billing document breakdown

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
get/v1/billing-documents/{billing_document_id}/breakdown

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.

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
      }
    ]
  }
}