CLEARIE GETWAYEX-IM Intelligence & APIs
← Marketplace

Incentives · min plan: business · heavy (5u) · scope: write:schemes · both

Drawback Impact Analysis

Aggregates drawback calculations across a product list and returns revenue exposure, risk level, and recommended actions.

POST /v1/drawback/impact

Required scope

write:schemes

API credits

5 per success

Minimum plan

business

Rate-limit bucket

heavy

Parameters

NameInTypeRequiredDescription
itemsbodyarrayyesProduct exposure list with HSN, FOB value, quantity, and export date.

Sample request

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

Sample response

{
  "status": "verified",
  "revenue_impact": 8250,
  "risk_level": "medium"
}

Live response contract

Live calls require API-key authentication, write:schemes 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"
revenue_impact* integer// e.g. 8250
risk_level* string// e.g. "medium"
}

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.