Remote Contractors API
The Contractors API from Remote — 17 operation(s) for contractors.
Remote Contractors API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contractors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 21 operations across 17 paths, and defines 59 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/.
21 operations
17 paths
59 schemas
1 DELETE10 GET1 PATCH8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 7
Remote Contractors 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 21
Across 17 paths, the API surfaces 21 operations — 1 DELETE, 10 GET, 1 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Contractors 21
GET
/v1/contractor-invoices/{id}
Show Contractor Invoice
GET
/v1/contractor-invoices
List Contractor Invoices
GET
/v1/contractors/employments/{employment_id}/contractor-subscriptions
List contractor subscriptions
GET
/v1/contractors/cor-termination-requests
List contractor of record (COR) termination requests
GET
/v1/contractors/employments/{employment_id}/contract-documents/{id}
Return a base64 encoded version of the contract document
GET
/v1/contractors/employments/{employment_id}/contractor-currencies
List all currencies for the contractor
POST
/v1/contractors/employments/{employment_id}/cor-termination-requests
Create a contractor of record (COR) termination request
GET
/v1/contractor-invoice-schedules/{id}
Show Contractor Invoice Schedule
PATCH
/v1/contractor-invoice-schedules/{id}
Updates Contractor Invoice Schedule
PUT
/v1/contractor-invoice-schedules/{id}
Updates Contractor Invoice Schedule
POST
/v1/contractors/eligibility-questionnaire
Submit eligibility questionnaire
POST
/v1/contractors/employments/{employment_id}/contract-documents
Create a contract document for a contractor
GET
/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}
Show a contractor of record (COR) termination request
POST
/v1/contractors/employments/{employment_id}/terminate-cor-employmentdeprecated
Terminate contractor of record employment
POST
/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign
Sign a document for a contractor
GET
/v1/contractors/schemas/eligibility-questionnaire
Get eligibility questionnaire schema
POST
/v1/contractors/employments/{employment_id}/contractor-plus-subscription
Manage contractor plus subscription
DELETE
/v1/contractors/employments/{employment_id}/contractor-cor-subscription
Delete contractor of record subscription intent
POST
/v1/contractors/employments/{employment_id}/contractor-cor-subscription
Create contractor of record subscription intent
GET
/v1/contractor-invoice-schedules
List Contractor Invoice Schedules
POST
/v1/contractor-invoice-schedules
Create Contractor Invoice Schedules
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ContractorInvoice (22 properties), ContractorInvoiceSchedule (12 properties), ContractorSubscriptions.Summary (11 properties), Signatory (9 properties). Each schema is shown below with its type and property counts.
ContractorSubscriptions.Summary
object
11 properties
6 required
SignContractDocument
object
SignContractDocument schema
1 property
1 required
ParameterError
object
3 properties
3 required
ContractorInvoiceItemType
string
Current types. - manual: Item manually entered when creating invoice. - timetracking: Item generated by time tracking. - expense: Item that represents an expen…
ValidationError
object
1 property
1 required
EligibilityQuestionnaire
object
6 properties
6 required
EligibilityQuestionnaireResponse
object
1 property
1 required
CreateContractDocument
object
Parameters for creating a contract document
2 properties
1 required
Decimal
string
A decimal number represented as a string to preserve precision. Supports negative values and fractional digits.
ContractorSubscriptionSummariesResponse
object
Summaries of contractor subscriptions
1 property
1 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
IndexCorTerminationRequestsResponse
object
Response schema listing many terminationrequests
1 property
ContractDocument
object
A contract document for a contractor employment, tracking its signing status.
2 properties
2 required
ContractorInvoiceStatus
string
Current record state. - enqueued: An outstanding payment is enqueued to complete the invoice payment. - externallypaid: The invoice was paid outside the platfo…
ContractorInvoiceSchedule
object
Contractor Invoice Schedule.
12 properties
8 required
ListContractorInvoiceSchedulesResponse
object
Paginated response schema listing all Contractor Invoice Schedules.
1 property
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
ContractorInvoiceScheduleCreateResponseFailure
object
Set of invoice schedule attributes with failed validation.
9 properties
6 required
SubmitEligibilityQuestionnaireRequest
object
Request body for submitting an eligibility questionnaire
3 properties
3 required
CreateContractDocumentResponse
object
Contract document response
1 property
1 required
SignatoryStatus
string
Current signing status of this signatory
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
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
UpdateScheduleContractorInvoiceParams
object
Payload shape used to update invoice schedules.
7 properties
UnprocessableEntityResponse
object
Signatory
object
A signatory on a contract document. For company and employee signatories, userid is provided. For other signatory types, userid is null.
9 properties
2 required
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
ContractorInvoice
object
Contractor Invoice
22 properties
8 required
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…
ContractorCurrencyItem
object
2 properties
2 required
CorTerminationRequestCreatedResponse
object
1 property
1 required
ContractorCurrencyResponse
object
Schema for listing contractor currencies
1 property
1 required
EligibilityQuestionnaireJSONSchemaResponse
object
JSON Schema definition for eligibility questionnaire
1 property
ListContractorInvoicesResponse
object
Paginated response schema listing all Contractor Invoices.
1 property
ContractorInvoiceItem
object
Line Item schema for a Contractor Invoice.
3 properties
3 required
ActionError
object
3 properties
3 required
ContractorContractDocumentStatus
string
The signing status of a contract document. - draft: The document is being prepared and has not been sent for signing. - awaitingsignatures: The document has be…
SignatoryType
string
The role of this signatory in the contract signing process
ContractorInvoiceScheduleCreateResponseSuccess
object
Set of invoice schedule attributes that were successfully created.
9 properties
6 required
Product
object
A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
7 properties
3 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
CorTerminationRequestResponse
object
1 property
1 required
ConflictErrorResponse
object
ContractorInvoiceScheduleItem
object
Line Item schema for a Contractor Invoice Schedule
2 properties
2 required
ManageContractorPlusSubscriptionOperationsParams
object
Defines the operation that must be executed: upgrade or downgrade
1 property
1 required
UuidSlug
string
Identifier of the employment being terminated.
Currency
object
The type of money in general use in a particular country
4 properties
3 required
ContractorInvoiceResponse
object
Response schema to show a Contractor Invoice
1 property
1 required
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
InternalServerErrorResponse
object
MessageResponse
object
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…
CorTerminationRequest
object
8 properties
8 required
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
ContractDocumentResponse
object
Return a base64 encoded contract document
1 property
1 required
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
More from Remote 12
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
#Contractors