Push IRM Request Fields - eBRC API

This annexure lists the complete field-level details for the Push IRM request payload.

Legend: Req Y = Required, N = Not required, O = Optional, O(M) = Optional but conditionally Mandatory

Message fields

JSON	Name	Req	Format	Description
`recordResCount`	Record request count	Y	`int(4)`	Total IRM invoice mappings in this message.
`uploadType`	eBRC type	Y	`int(3)`	eBRC type: 101 Direct Export, 102 Softex, 103 Service Non IT, 104 Deemed. Sent as a string, e.g. `"101"`.
`decalarationFlag`	Declaration Flag	Y	`string(1)`	Exporter declaration confirming correctness of data. Spelling preserved exactly for wire compatibility.

Item fields (`ebrcBulkGenDtos[]`)

IRM identification

JSON	Name	Req	Format	Description
`serialNo`	Serial Number	Y	`number(3)`	Unique serial within the message; 1-999.
`branchSlNo`	IEC branch Serial number	Y	`int(3)`	IEC branch where invoice is generated. Default 0.
`irmNumber`	IRM Number	Y	`string(50)`	IRM number.
`irmDt`	IRM date	Y	`date(ddMMyyyy)`	IRM date.
`irmIfscCode`	IFSC Code	Y	`string(11)`	Bank IFSC for the IRM.
`irmAdCode`	AD Code	Y	`string(7)`	AD code of Shipping bill/SOFTEX/Invoice.
`irmFCC`	IRM foreign currency code	Y	`string(3)`	IRM FC code. See Currency Codes.
`irmPurposeCode`	Purpose Code	Y	`string(5)`	Purpose code of IRM. See Purpose Codes.

Invoice references

JSON	Name	Req	Format	Description
`sbCumInvoiceNumber`	Shipping bill/SOFTEX/Invoice Number	Y	`string(20)`	Shipping bill/Invoice number for exports.
`sbCumInvoiceDate`	Shipping Bill/SOFTEX/Invoice date	Y	`date(ddMMyyyy)`	Shipping Bill/Invoice date.
`portCode`	Port Code	Y	`string(6)`	As per DGFT master data. See Port Codes.
`sbCumInvoiceFCC`	Shipping Bill/SOFTEX/Invoice FC Code	Y	`string(3)`	FC code for the invoice. See Currency Codes.
`sbCumInvoiceValueinFCC`	Total Shipping Bill/SOFTEX/Invoice Value in FCC	Y	`number(16,2)`	Invoice value in FCC.
`billNo`	Bill Number	Y	`string(20)`	Bill/Invoice number mapped in Shipping/SOFTEX.

Amounts and currency

JSON	Name	Req	Format	Description
`irmRemitAmtFCC`	Remittance Amount Available in FCC	Y	`number(16,2)`	Total remittance available in FCC.
`mappedIRMAmountFCC`	IRM FCC Amount mapped	Y	`number(16,2)`	IRM amount mapped against invoice.
`mappedORMAmountFCC`	ORM Amount mapped	Y	`number(16,2)`	ORM amount mapped in invoice.

Vostro and third-party

JSON	Name	Req	Format	Description
`isVostro`	IsVostro Payment	Y	`string(1)`	Y if payment received in Vostro account.
`vostroType`	Vostro Type	O	`string(4)`	SVRA or NVRA.
`isThirdPartyExport`	Third Party Export	Y	`string(1)`	Y if remittance received by a third party.

Deductions (optional)

JSON	Name	Req	Format	Description
`commissionValDeduct`	Commission Value to be deducted	N	`number(16,2)`	Commission to deduct from IRM FCC.
`commissionValInfo`	Commission Value Info	N	`number(16,2)`	Commission for information in invoice FCC.
`discountValDeduct`	Discount value to be deducted	N	`number(16,2)`	Discount to deduct from IRM FCC.
`discountValInfo`	Discount value Info	N	`number(16,2)`	Discount for information in invoice FCC.
`insuranceValDeduct`	Insurance value to be deducted	N	`number(16,2)`	Insurance to deduct from IRM FCC.
`insuranceValInfo`	Insurance value Info	N	`number(16,2)`	Insurance for information in invoice FCC.
`otherDeductionDeduct`	Other deduction to be deducted	N	`number(16,2)`	Other deduction to deduct from IRM FCC.
`otherdeductionsInfo`	Other deduction for info	N	`number(16,2)`	Other deduction for information in invoice FCC. Spelling preserved exactly for wire compatibility.
`freightValDeduct`	Freight value to be deducted	N	`number(16,2)`	Freight to deduct from IRM FCC.
`freightValInfo`	Freight value for info	N	`number(16,2)`	Freight for information in invoice FCC.

Services (optional)

JSON	Name	Req	Format	Description
`sacCode1`	SAC Code	N	`string(8)`	SAC code for service export.
`sacCode2`	SAC Code 2	N	`string(8)`	Second SAC code, if applicable.
`serviceTypeModesValue`	Mode of Export of Services	O	`string`	Cross-border, Consumption Abroad, Commercial Presence, Presence of Natural Persons.

GST details

JSON	Name	Req	Format	Description
`isGstAvail`	GSTIN Available	Y	`string(1)`	Whether to avail GSTIN benefit. `Y` or `N`. Cannot be null or empty.
`gstinInvoiceNumber`	GST Invoice No	O(M)	`string(30)`	Mandatory if `isGstAvail` is `Y`; must be `null` if `isGstAvail` is `N`.
`gstinInvoiceDate`	GST Invoice Date	O(M)	`date(ddMMyyyy)`	Mandatory if `isGstAvail` is `Y`; must be `null` if `isGstAvail` is `N`.

Only the request fields relevant to Push IRM are listed here. Response and status fields (e.g., dgftAckId, ackStatus) are documented on their respective pages.

Used by

Submit IRMs for eBRC Generation, which takes these fields as JSON
Bulk Upload via Excel and its template, whose columns map to these fields by name
The Quick Start payload, a canonical example of this message

⌘I