Billing Documents

List Billing Documents

List billing documents for a company

Scopes

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

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/billing-documents
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, invoices:read, invoices:write, invoices, all:write, all:read)

Query parameters

periodstring

The month for the billing documents (in ISO-8601 format)

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

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_documents": [
      {
        "billing_document_period": "2023-12",
        "billing_document_type": "reconciliation_invoice",
        "id": "8772a9f1-b43c-46be-a1ce-e50b6819f5ee"
      }
    ],
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Changes

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