Outbound | GET | {Client’s URL}

Summary

This API will fetch invoice URL along with tax details .

Description

This API will fetch invoice URL and the tax details. Invoice URL should point to invoice file in pdf format.

Example : https://example.com/articles?shipmentCode=2342&orderCode=2

Request Params

• shipmentCode
• orderCode

Response

{
  "invoiceCode": "INV123456",
  "invoiceUrl": "<https://example.com/invoices/INV123456.pdf>",
  "irn": "IRN987654321",
  "qrCode": "Base64EncodedQRCodeString",
  "invoiceDate": "2024-01-01T10:00:00Z",
  "invoice": "Base64EncodedInvoiceString",
  "orderCustomAttributes": {
    "attribute1": "value1",
    "attribute2": "value2",
    "attribute3": "value3",
    "attribute4": "value4",
    "attribute5": "value5",
    "attribute6": "value6",
    "attribute7": "value7",
    "attribute8": "value8",
    "attribute9": "value9",
    "attribute10": "value10",
    "currency": "INR",
    "channelMetadata": {
      "key": "value"
    }
  },
  "invoiceDetails": [
    {
      "channelSkuCode": "SKU123456",
      "orderItemCode": "ITEM123456",
      "netTaxAmountPerUnit": 60,
      "netTaxAmountTotal": 120,
      "baseSellingPricePerUnit": 500,
      "baseSellingPriceTotal": 1000,
      "actualSellingPricePerUnit": 560,
      "actualSellingPriceTotal": 1120,
      "quantity": 2,
      "taxItems": [
        {
          "type": "SGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        },
        {
          "type": "CGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        }
      ],
      "orderItemCustomAttributes": {
        "attribute1": "value1",
        "attribute2": "value2",
        "attribute3": "value3",
        "attribute4": "value4",
        "attribute5": "value5",
        "attribute6": "value6",
        "attribute7": "value7",
        "attribute8": "value8",
        "attribute9": "value9",
        "attribute10": "value10",
        "channelMetadata": {
          "key": "value"
        }
      }
    }
  ]
}

HttpStatus : 200

<aside> 🗒️ Note:

• At least one of invoiceUrl or invoice should be present.
• If invoice details are being sent, then taxItems are mandatory. </aside>

<aside> 🗒️ The value of Custom Order Attributes or Custom Order Line Item Attributes received in response to the GetInvoice API will be updated in the Omni. This implies that if an external system needs to update any custom Order Attributes or Custom Order Line Item Attributes value, it can also do so by passing the updated value in response to this API.

</aside>