REremote-com
Cost Calculator

Creates PDF cost estimation of employments

Creates a PDF cost estimation of employments based on the provided parameters.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow, acting as the user who authorized it. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
  • Client token (ClientToken) — a partner client_token, accepted only on the endpoints that list it. See Authentication for partners.
post/v1/cost-calculator/estimation-pdf

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/cost-calculator/estimation-pdf
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or HTTP bearer
    • or HTTP bearer

Request body

company_namestring

The company name, used for labeling in PDF/CSV exports.

employer_currency_slugstring required

The ISO 4217 currency code for the employer's preferred currency (e.g., "USD"). All costs will be converted to this currency.

include_benefitsboolean

Whether to include benefit costs in the estimate. Defaults to false if not provided.

include_cost_breakdownsboolean

Whether to include detailed cost breakdowns (individual contributions, benefits, etc.) in the response.

include_management_feeboolean

Whether to include Remote's management fee in the total cost calculation.

include_premium_benefitsboolean

Whether to include premium benefit options in the estimate.

Example request

{
  "company_name": "My Company",
  "employer_currency_slug": "USD",
  "employments": [
    {
      "region_slug": "region_slug"
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "content": "base64 encoded content"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.