Request a Call+ simulation

post

https://api.callplus.be/api/v1/simulations

Submit the necessary information to run a Call+ simulation. Returns the calculation result and a simulationId you can use to retrieve the simulation later or download the generated PDF report.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Pass the same sourceReferenceId on a later call and the API returns the previously persisted simulation instead of running a new one — use this for safe retries and idempotency.

Simulations do not trigger webhooks. This endpoint runs a hypothetical calculation and never emits the plan.launched webhook event. That event is sent only if and when the corresponding Call+ plan is actually launched. See the Webhooks guide.

Body Params

Simulation parameters.

Request payload for POST /api/v1/simulations.

sourceReferenceId

string

required

length ≤ 255

^[A-Za-z0-9_\-:.]+$

Caller-supplied unique identifier for the simulation. Acts as the idempotency key: retrying a request with the same sourceReferenceId within your tenant (shared across all of your organization's API keys, not just the one used originally) returns the existing simulation rather than creating a duplicate. If the retry's body differs from the original, the original simulation is returned unchanged and the new input is discarded.

Allowed characters: alphanumeric, hyphen -, underscore _, colon :, dot ..

accountingFirm

object

required

Accounting firm requesting the simulation

accountant

object

required

Accountant assigned to manage the beneficiary's Call+ plan

company

object

required

Company offering the Call+ plan

companyFiscalData

object

required

Fiscal context of the company offering the plan. These flags drive the calculation parameters used for the simulation.

beneficiary

object

required

Beneficiary of the Call+ plan

plan

object

required

Details of the Call+ plan

Responses

200Simulation completed successfully.

400Invalid request. Possible error codes: VALIDATION_ERROR — one or more fields failed validation (see error.details). INVALID_REQUEST — malformed JSON, unknown field, or type mismatch.

401Authentication failed. Error code: UNAUTHORIZED. Possible reasons: missing or malformed X-API-Key, key not found, key revoked, or key expired.

403Authenticated but not allowed. Error code: FORBIDDEN. Typically returned when the tenant account is suspended.

429Rate limit exceeded. Error code: RATE_LIMIT_EXCEEDED. The API enforces a per-API-key limit of 60 requests per minute. Wait for the duration in Retry-After before retrying.

500Internal server error. Error code: INTERNAL_ERROR. Retry the request later or contact support with the requestId.