v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Cost Calculator

Creates PDF cost estimation of employments

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

post/v1/cost-calculator/estimation-pdf

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.

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

Success

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