Billing
Billing Documents

List Billing Documents

Changed on

List billing documents for a company

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)
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)

type'reconciliation_credit_note' | 'credit_note' | 'prefunding_credit_note' | 'eor_reserve_credit_note' | 'supplemental_service_credit_note' | 'reconciliation_invoice' | 'contractor_management_invoice' | 'cor_service_invoice' | 'eor_reserve_invoice' | 'prefunding_invoice' | 'supplemental_service_invoice' | 'payroll_service_invoice' | 'remote_plan_invoice' | 'peo_payroll_invoice' | 'peo_service_invoice'

Filters the results by the type of the billing document. Matches the response's billing_document_type field.

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

  • 2d2ae7c2c903Revision changes
    • warning

      added the new prefunding_credit_note enum value to the /// response property for the response status

    • warning

      added the new supplemental_service_credit_note enum value to the /// response property for the response status

    • info

      added the new optional query request parameter type

  • 7c436f8a57aaRevision changes
    • warning

      added the new cor_service_invoice enum value to the /// response property for the response status

    • warning

      added the new eor_reserve_credit_note enum value to the /// response property for the response status

    • warning

      added the new eor_reserve_invoice enum value to the /// response property for the response status

    • warning

      added the new payroll_service_invoice enum value to the /// response property for the response status

    • warning

      added the new peo_service_invoice enum value to the /// response property for the response status