Skip to main content

Generate IRN

Generate an Invoice Reference Number (IRN) with eTranzact.

The request model typecasts issuance_date and sanitizes invoice_number before signing and forwarding the payload upstream.

Endpoint

POST /api/v1/nrs/generate-irn

Request Body

{
"business_id": "9819d1a4-c898-401a-90d3-3dfe42891f8b",
"invoice_number": "INV-00049",
"issuance_date": "2026-03-27",
"service_id": "F6B4C898"
}

Response

{
"endpoint": "string",
"status_code": 0,
"ok": true,
"timestamp": "string",
"attempts": 1,
"retried": false,
"request_payload": {
"additionalProp1": {}
},
"response_body": "string"
}

Status Codes

CodeDescription
200IRN generated successfully
400Validation or upstream request error
422Validation error
500Local proxy failure

Validation Error Example

{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string",
"input": "string",
"ctx": {}
}
]
}

Server Error Example

{
"endpoint": "string",
"status_code": 0,
"ok": false,
"error": "string"
}

Notes

  • issuance_date must be in YYYY-MM-DD format.
  • invoice_number is sanitized before forwarding upstream.
  • The request is signed before being sent to eTranzact.
  • Ensure business_id is a valid UUID.