Skip to main content
POST
Submit IRMs for eBRC generation
Submit one or more IRM-to-invoice mappings for eBRC generation. You get back a DGFT acknowledgement with a requestId; keep it and poll status. Limited to 10 calls per minute.
Available in both test and live mode. In live mode, acknowledgement typically arrives within about 2 hours.
See the full field list and constraints in the Push IRM Request Fields annexure. Dates are DDMMYYYY strings. The message-level uploadType is a string code and the item-level one is a number: 101 Direct Export, 102 Softex, 103 Service Non IT, 104 Deemed.

Request body example

recordResCount must equal the number of entries in ebrcBulkGenDtos. decalarationFlag keeps its wire spelling (as per DGFT specification). When isGstAvail is "Y", gstinInvoiceNumber and gstinInvoiceDate become mandatory; when "N", they must be null.
For a Direct Export (uploadType 101), sbCumInvoiceNumber is the shipping bill number — digits only, at most 7.The field carries a different document per uploadType (shipping bill for 101, SOFTEX for 102, invoice number for 103), and only the Direct Export case has the tighter rule. Your own invoice reference goes in billNo:
Sending an invoice-style value such as EX/25-26/028 in sbCumInvoiceNumber returns 400 with sbCumInvoiceNumber ... is not a shipping bill number. Swapping these two fields is the most common cause of a rejected Direct Export. See the field reference for all four upload types.

Response example

ackStatus values

Errors

Valid codes

Next steps

Authorizations

x-api-key
string
header
required

Body

application/json
platformCustomerId
string
required
recordResCount
number
required
uploadType
string
required

eBRC type code as a string: "101" Direct Export, "102" Softex, "103" Service Non IT, "104" Deemed.

decalarationFlag
string
required

Exporter declaration flag, Y or N (spelling as per DGFT specification).

ebrcBulkGenDtos
object[]
required

Response

Acknowledgement with DGFT Ack Id

dgftAckId
string
requestId
string
ackStatus
enum<string>

Push acknowledgement status

Available options:
Validated,
Failed
recordResCount
number
errorDetails
object[]
warnings
string[]

Non-fatal observations about a filing that WAS accepted and forwarded. Present only when there is something to report. Each entry is a disagreement with the IRM record we hold for this exporter, or an IRM we hold no record of - both of which DGFT is likely to reject later. See the Errors page.