v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Billing Documents

Show Billing Document

Shows a billing document details.

Please contact api-support@remote.com to request access to this endpoint.

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}

Path parameters

billing_document_idstring required

The billing document's ID

Query parameters

include_unrecognized_typesboolean

When true, includes billing document items whose type is not part of the standard set for the invoice type.

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "billing_document": {
      "billing_document_currency": "USD",
      "billing_document_number": "12345678901",
      "billing_document_period": "2023-12",
      "billing_document_type": "reconciliation_invoice",
      "company_id": "305ae616-2ef6-4b2d-bed3-b75eb3ccc069",
      "id": "8772a9f1-b43c-46be-a1ce-e50b6819f5ee",
      "issued_date": "2024-03-01",
      "items": [
        {
          "billing_document_amount": 1000000,
          "billing_document_currency": "USD",
          "employment_id": "0d25c513-employment-id-198557128104",
          "source_amount": 500000,
          "source_currency": "USD",
          "type": "base_salary"
        }
      ],
      "total": "12345"
    }
  }
}