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 Invoice Schedules API

The Invoice Schedules API from Remote — 2 operation(s) for invoice schedules.

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

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

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

5 operations 2 paths 22 schemas 2 GET1 PATCH1 POST1 PUT

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 Invoice Schedules 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 5

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

Invoice Schedules 5
GET
/v1/contractor-invoice-schedules/{id}
Show Contractor Invoice Schedule
get_v1_contractor-invoice-schedules_id 1 param → 200400401403404422429
PATCH
/v1/contractor-invoice-schedules/{id}
Updates Contractor Invoice Schedule
patch_v1_contractor-invoice-schedules_id (2) 1 param body → 200401403404422
PUT
/v1/contractor-invoice-schedules/{id}
Updates Contractor Invoice Schedule
patch_v1_contractor-invoice-schedules_id 1 param body → 200401403404422
GET
/v1/contractor-invoice-schedules
List Contractor Invoice Schedules
get_v1_contractor-invoice-schedules 12 params → 200401403404
POST
/v1/contractor-invoice-schedules
Create Contractor Invoice Schedules
post_v1_contractor-invoice-schedules body → 201207403404422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ContractorInvoiceSchedule (12 properties), ContractorInvoiceScheduleCreateResponseFailure (9 properties), ContractorInvoiceScheduleCreateResponseSuccess (9 properties), ContractorInvoiceScheduleCreateParams (8 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
ContractorInvoiceSchedule
object
Contractor Invoice Schedule.
12 properties 8 required
ListContractorInvoiceSchedulesResponse
object
Paginated response schema listing all Contractor Invoice Schedules.
1 property
ContractorInvoiceScheduleCreateResponseFailure
object
Set of invoice schedule attributes with failed validation.
9 properties 6 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
UpdateScheduleContractorInvoiceParams
object
Payload shape used to update invoice schedules.
7 properties
UnprocessableEntityResponse
object
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
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…
ActionError
object
3 properties 3 required
ContractorInvoiceScheduleCreateResponseSuccess
object
Set of invoice schedule attributes that were successfully created.
9 properties 6 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
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ContractorInvoiceScheduleItem
object
Line Item schema for a Contractor Invoice Schedule
2 properties 2 required
UuidSlug
string
Identifier of the employment being terminated.
ContractorInvoiceScheduleResponse
object
Response schema to show a Contractor Invoice Schedule
1 property 1 required
BulkContractorInvoiceScheduleCreateParams
object
Schema defining a bulk creation payload.
1 property 1 required
ContractorInvoiceScheduleCreateParams
object
Payload shape used to create invoice schedules.
8 properties 5 required
ContractorInvoiceScheduleStatus
string
Current record state. - active: Once an invoice is generated, and a withdrawal method has been set, then it's set to active. - processing: Ephemeral status ind…
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
ContractorInvoiceSchedulePeriodicity
string
Defines how often contractor invoices will be generated. - biweekly: Invoices will be generated every other week, on the given day of the week based on the sta…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-invoice-schedules-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