Pay & Compensation
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. See Authentication for partners.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
  • Client token (ClientToken) — a partner client_token, accepted only on marketing endpoints. 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: HTTP bearer and HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token) and OAuth 2 (client credentials, token URL /auth/oauth2/token)

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 65 revisions of this API.