CLEARIE GETWAYEX-IM Intelligence & APIs
← Marketplace

Incentives · min plan: growth · medium (2u) · scope: write:schemes · both

Drawback Calculator

Applies verified drawback percentage and per-unit caps to calculate expected benefit with transparent formula trace and source references.

POST /v1/drawback/calculate

Required scope

write:schemes

API credits

2 per success

Minimum plan

growth

Rate-limit bucket

medium

Parameters

NameInTypeRequiredDescription
hsnbodystringyes6 or 8 digit HSN.
fob_valuebodynumberyesFOB value.
quantitybodynumberExport quantity.

Sample request

curl -X POST "https://getway.clearie.neximprove.com/v1/drawback/calculate" -H "Authorization: Bearer $CLEARIE_API_KEY" -H "Content-Type: application/json" -d '{"hsn":"62030101","fob_value":250000,"quantity":100}'

Sample response

{
  "status": "verified",
  "expected_benefit": 8250,
  "rate_applied_pct": 3.3
}

Live response contract

Live calls require API-key authentication, write:schemes scope, plan access, and available quota. Successful calls consume 2 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"
expected_benefit* integer// e.g. 8250
rate_applied_pct* number// e.g. 3.3
}

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.