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 Invoices API

The Invoices API from Remote — 2 operation(s) for invoices.

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

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

This API exposes 2 operations across 2 paths, and defines 15 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/.

2 operations 2 paths 15 schemas 2 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 Invoices 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 2

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

Invoices 2
GET
/v1/contractor-invoices/{id}
Show Contractor Invoice
get_v1_contractor-invoices_id 1 param → 200401403404422
GET
/v1/contractor-invoices
List Contractor Invoices
get_v1_contractor-invoices 14 params → 200401403404422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ContractorInvoice (22 properties), ActionError (3 properties), ContractorInvoiceItem (3 properties), ParameterError (3 properties). Each schema is shown below with its type and property counts.

ActionError
object
3 properties 3 required
ParameterError
object
3 properties 3 required
ListContractorInvoicesResponse
object
Paginated response schema listing all Contractor Invoices.
1 property
ContractorInvoiceItemType
string
Current types. - manual: Item manually entered when creating invoice. - timetracking: Item generated by time tracking. - expense: Item that represents an expen…
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
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ContractorInvoice
object
Contractor Invoice
22 properties 8 required
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
UuidSlug
string
Identifier of the employment being terminated.
ContractorInvoiceStatus
string
Current record state. - enqueued: An outstanding payment is enqueued to complete the invoice payment. - externallypaid: The invoice was paid outside the platfo…
ContractorInvoiceItem
object
Line Item schema for a Contractor Invoice.
3 properties 3 required
ContractorInvoiceResponse
object
Response schema to show a Contractor Invoice
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-invoices-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 Billing Documents API