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 Cost Calculator API

The Cost Calculator API from Remote — 5 operation(s) for cost calculator.

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

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

This API exposes 5 operations across 5 paths, and defines 29 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 5 paths 29 schemas 2 GET3 POST

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 Cost Calculator 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 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Cost Calculator 5
POST
/v1/cost-calculator/estimation
Creates a cost estimation of employments
post_v1_cost-calculator_estimation body → 200404422
POST
/v1/cost-calculator/estimation-pdf
Creates PDF cost estimation of employments
post_v1_cost-calculator_estimation-pdf body → 200404422
GET
/v1/cost-calculator/countries
List countries for Cost Calculator
get_v1_cost-calculator_countries 1 param → 200
GET
/v1/cost-calculator/regions/{slug}/fields
Show region fields
get_v1_cost-calculator_regions_slug_fields 2 params → 200401500
POST
/v1/cost-calculator/estimation-csv
Creates a CSV cost estimation of employments
post_v1_cost-calculator_estimation-csv body → 200404422

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are CostCalculatorCosts (21 properties), CostCalculatorEmploymentParam (11 properties), CostCalculatorEmployment (8 properties), CostCalculator.CountryLevelRegion (8 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
ValidationError
object
1 property 1 required
CostCalculatorEmploymentParam
object
Parameters for a single employment to include in the cost estimate. Provide the region and salary (or total cost) — the calculator will compute all employer co…
11 properties 1 required
EmploymentTermType
string
CostCalculatorDiscountResponse
object
The discount applied to a cost estimate, showing the annual and monthly savings.
4 properties 4 required
CostCalculator.CountryAvailability
string
- active: country is ready to onboard employee - comingsoon: country is in process of getting ready
CostCalculatorEstimatePDFResponse
object
1 property 1 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
MinimalCountry
object
A lightweight country representation with basic identification fields.
5 properties 4 required
UnprocessableEntityResponse
object
ActionError
object
3 properties 3 required
CostCalculator.CountryLevelRegion
object
A supported country on Remote
8 properties 7 required
CostCalculator.ListCountryResponse
object
1 property 1 required
MinimalRegion
object
5 properties 2 required
CostCalculatorEstimateCSVResponse
object
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
RegionStatus
string
GenericFile
string
A file represented as a base64-encoded string.
CostCalculatorBenefitParam
object
2 properties 2 required
Currency
object
The type of money in general use in a particular country
4 properties 3 required
JSONSchemaResponse
object
JSON Schema Response
1 property
InternalServerErrorResponse
object
CostCalculatorCost
object
A single cost line item within a cost breakdown (e.g., a specific employer contribution, benefit, or statutory payment).
5 properties 5 required
MessageResponse
object
1 property 1 required
CostCalculatorCosts
object
21 properties 9 required
CostCalculatorDiscount
object
Configuration for applying a discount to a cost estimate. Provide either an amount or percent — not both.
5 properties 1 required
CostCalculatorEmployment
object
A cost estimate for a single employment, including costs in both the regional (local) currency and the employer's preferred currency.
8 properties 8 required
CostCalculatorEstimateParams
object
Parameters for generating a cost estimate for one or more employments across different countries/regions.
8 properties 2 required
CostCalculatorEstimateResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-cost-calculator-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