Fetch IRM list
IRM
Fetch IRM List
Refresh inward remittances (IRMs) for a platform customer and return the latest records, the first step before mapping them and generating an eBRC.
POST
Fetch IRM list
Pull the customer’s latest inward remittances (IRMs) and return them paginated. This performs a live refresh on every call and is limited to 6 calls per minute; for everyday reads of already-fetched data, use List saved IRMs instead.
Optional filters:
Request example
irmNumber, fromDate, toDate (ISO dates), and page / limit for pagination.
Response example
Errors
422/409when the customer’s DGFT credentials are missing or stale. See DGFT credential error codes.429beyond 6 calls per minute. See rate limits.
Next steps
- List saved IRMs for reads without a live refresh.
- Submit IRMs for generation.
- Download IRMs as Excel to work in a spreadsheet.
Authorizations
Query Parameters
Required range:
x >= 1Required range:
x >= 1Body
application/json
The body is of type object.