Versions Compared

Old Version 4

changes.mady.by.user Suprit Bhattacharjee

Saved on

compared with

New Version 5

changes.mady.by.user Zeeshan Equbal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter Name

Data Type

Description

Mandatory

orderCode

String

The order code against which Invoice is being generated

Yes

shipmentCode

String

The shipment code against which Invoice is being generated

Yes

invoiceId

String

Invoice Id for the Invoice generated

Yes

documentUrl

String

Downloadable URL of the InvoicePDF

Yes

invoiceDate

Date

Invoice Time

Yes

irn

String

IRN generated by Government Portal. This will be sent in the E-Invoicing case.

No

signedInvoice

String

Signed Invoice generated by Government Portal. This will be sent in the E-Invoicing case.

Yes

signedQRCode

String

Signed QR Code generated by Government Portal. This will be sent in the E-Invoicing case.

Yes

INVOICE_GENERATED Notification

When invoice is generated by RMS, it also sends a INVOICE_GENERATED notification back to client/proxy if the is_notification_enabled field is True in the Invoice config. This is disabled by default, and can be enabled by raising a DevOps ticket with the following query:

Code Block
languagesql
update invoice_config set is_notification_enabled=true where org_domain_id=<org_domain_id> and invoice_alias=<invoice_alias>;

  • You can get the org_domain_id from the DevOps team by mentioning the RMS org name.

  • The invoice_alias is the Alias configured in RMS UI for which notification needs to be enabled.

The INVOICE_GENERATED notification contains the Invoice details and some metadata. The push notification payload for this notification is of the following format:

Code Block
languagejson
{
  "forwardOrderCode": "ABCD",
  "forwardShipmentCode": "1",
  "forwardAwb": "SP73883123",
  "notificationType": "INVOICE_GENERATED",
  "notificationUpdateTime": null,
  "returnOrderInfo": null,
  "logisticAggregatorInfo": null,
  "invoiceData": {
    "invoiceId": 123,
    "invoiceStatus": "CREATED",
    "documentType": "INVOICE",
    "documentUrl": "https://invoice.com/dummy/pdf",
    "irn": null,
    "ackName": null,
    "ackDate": null
  },
  "warehouseCode": null,
  "courierName": null,
  "omniMetaData": {},
  "items": null
}

FAQs

For E-Invoice generation, will the same API be used?

...