Creates a cost estimation of employments

post

https://gateway.remote.com/v1/cost-calculator/estimation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Estimate params

company_name

string

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

employer_currency_slug

string

required

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

employments

array of objects

required

One or more employments to estimate costs for.

employments*

global_discount

object

Configuration for applying a discount to a cost estimate. Provide either an amount or percent — not both.

include_benefits

boolean

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

include_cost_breakdowns

boolean

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

include_management_fee

boolean

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

include_premium_benefits

boolean

Whether to include premium benefit options in the estimate.

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success