E invoicing

Transmit A Signed Invoice To Its Recipient Via NRS And/Or Email

Confirmed NRS success is recorded as transmitted, while an explicit non-ambiguous 4xx rejection is recorded as rejected. A timeout, transport failure, 5xx, ambiguous 408/409/425/429, or malformed response returns 502 and quarantines the attempt; do not resubmit, including with a new idempotency key, until the outcome is reconciled.

POST
/api/v1/e-invoicing/invoices/{reference}/transmit
AuthorizationBearer <token>

In: header

Path Parameters

reference*string

Invoice reference number (IRN)

Header Parameters

x-idempotency-key?string

Optional caller-supplied key, 8-128 characters from [A-Za-z0-9._:-]. A retry with the same key replays the first call's outcome instead of transmitting to NRS again. A key replayed against a different request is rejected with 409.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/e-invoicing/invoices/string/transmit" \  -H "Content-Type: application/json" \  -d '{}'
{
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "transmissionStatus": "transmitted",
  "emailedTo": [
    "buyer@example.com",
    "accounts@example.com"
  ],
  "message": "recipient not on NRS network — try again later"
}
Empty
Empty
Empty
Empty
Empty
Empty

How is this guide?

Last updated on