Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Billing Documents API

The Billing Documents API from Remote — 4 operation(s) for billing documents.

Remote Billing Documents API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

4 operations 4 paths 17 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Billing Documents API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Billing Documents 4
GET
/v1/billing-documents/{billing_document_id}
Show Billing Document
get_v1_billing-documents_billing_document_id 3 params → 200400401404422429
GET
/v1/billing-documents
List Billing Documents
get_v1_billing-documents 4 params → 200401404422
GET
/v1/billing-documents/{billing_document_id}/breakdown
Get Billing Document Breakdown
get_v1_billing-documents_billing_document_id_breakdown 2 params → 200400401404422429
GET
/v1/billing-documents/{billing_document_id}/pdf
Download a billing document PDF
get_v1_billing-documents_billing_document_id_pdf 2 params → 200401404422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BillingDocumentBreakdownItem (13 properties), BillingDocument (9 properties), BillingDocumentAmountItem (6 properties), ParameterError (3 properties). Each schema is shown below with its type and property counts.

BillingDocument
object
A billing document (invoice or credit note) issued to a company by Remote for employment management services.
9 properties 9 required
ParameterError
object
3 properties 3 required
BillingDocumentAmountItem
object
A line item on a billing document, representing a specific cost category (e.g., base salary, allowances, taxes) for an employment.
6 properties 3 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
BillingDocumentBreakdownResponse
object
Information about a billing document breakdown
1 property 1 required
BillingDocumentsResponse
object
Information about a list of billing documents
1 property 1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
BillingDocumentResponse
object
Information of a billing document
1 property 1 required
UnprocessableEntityResponse
object
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
GenericFile
string
A file represented as a base64-encoded string.
BillingDocumentBreakdownItem
object
Item in a billing document breakdown
13 properties 13 required
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
CountryCode
string
Country code according to ISO 3166-1 3-digit alphabetic codes.
UuidSlug
string
Identifier of the employment being terminated.
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
ActionError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-billing-documents-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Companies API