Generate IRN

Submits an invoice to the IRP and returns the IRN registration record. The handler is
Optionally, including an eWayBillDetails block in the body issues a linked EWB in the same IRP
call; the response then also carries ewbNumber, ewbDate and ewbValidTill.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Customer-facing IRN-generation request. Nested objects (transactionDetails, documentDetails, seller, buyer, items, valueDetails, eWayBillDetails) keep a stable, well-documented canonical shape. Idempotency uses the

transactionDetails
object
required

Transaction-level details.

documentDetails
object
required

Document details.

seller
object
required

Party details — used for Seller (and via inheritance for Shipping).

buyer
object
required

Buyer details — party + place of supply.

dispatcherDetails
object | null

Dispatcher details. Populate only when goods are dispatched from a non-seller location.

shippingDetails
object | null

Shipping details — same shape as Seller. Populate only when goods ship to a non-buyer location.

items
array of objects
required
length between 1 and 1000

At least one item is required; IRP allows up to 1000.

items*
valueDetails
object
required

Invoice value totals.

paymentDetails
object | null

Payment details.

referenceDetails
object | null

Reference details.

additionalDocuments
array of objects | null
additionalDocuments
exportDetails
object | null

Export details — required for SEZ / Export supply types.

eWayBillDetails
object | null

E-Way Bill details — populate to generate the EWB with the IRN.
Either transporterId (Part-A only) or vehicleNumber (Part-A + Part-B) must be supplied.

Headers
string
required
length between 15 and 15
^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][A-Z0-9]{3}$

GSTIN whose NIC IRP / EWB-portal credential authorizes the call.
Seed each GSTIN's credential through the Developer Console.

uuid

Optional client-supplied UUID for correlation across logs and dashboards. If omitted, OneFinOps mints one and echoes it back on the response.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json