REremote-com
Billing Documents

List Billing Documents

List billing documents for a company

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

Request

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

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

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_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.