CLEARIE GETWAYEX-IM Intelligence & APIs
← Marketplace

Duty Intelligence · min plan: business · heavy (5u) · scope: write:duty · both

Duty Scenario Modeling

Runs a verified base duty calculation and scenario variations for strategy planning. Each output preserves the base source references and formula trace.

POST /v1/duty/scenarios

Required scope

write:duty

API credits

5 per success

Minimum plan

business

Rate-limit bucket

heavy

Parameters

NameInTypeRequiredDescription
base_inputbodyobjectyesBase duty calculation input.
scenariosbodyarrayyesScenario assumptions.

Sample request

curl -X POST "https://getway.clearie.neximprove.com/v1/duty/scenarios" -H "Authorization: Bearer $CLEARIE_API_KEY" -H "Content-Type: application/json" -d '{"base_input":{"hsn":"85171300","origin":"VN","destination":"IN","cif_value":100000},"scenarios":[{"name":"Duty +10%","duty_delta_pct":10}]}'

Sample response

{
  "status": "verified",
  "scenarios": [
    {
      "scenario_id": "scenario_1",
      "duty_delta": 10000
    }
  ]
}

Live response contract

Live calls require API-key authentication, write:duty scope, plan access, and available quota. Successful calls consume 5 API credits.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {
status* string// e.g. "verified"
scenarios* array [
item object {
scenario_id* string// e.g. "scenario_1"
duty_delta* integer// e.g. 10000
}
]
}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.