REremote-com
Billing Documents

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

Shows a billing document details.

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

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}

Request

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

company_idstring

The company the accessed resource belongs to. Send it whenever you know which one you mean. Requests that don't resolve to a company fail with "Company not found".

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

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

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

Changes

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