Get Invoice API

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

Parameter Name	Data Type	Description	Mandatory
`shipmentCode`	String	Unique code used by the channel to identify the shipment	Yes
`orderCode`	String	Unique code used by the channel to identify the order	Yes

Response

{
  "invoiceCode": "INV123",
  "invoiceUrl": "https://mybrand.com/invoice123.pdf",
  "irn": "a429746e34d844c9d2cb2a6f68997d1c2af23987cc834f3b52da45d1b0bc9799",
  "qrCode": "eyJhbGciKiJSUzI1NiIsImtpZCI6IkI4RGYzRUNCNThFQTVFNkY0QUFDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
  "invoiceDate": "2020-10-16T20:22:28.000+05:30",
  "invoice": "invoiceBase64String",
  "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": "100000789702",
      "orderItemCode": "item123",
      "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

Note:

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

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.

Parameter Name	Data Type	Description	Mandatory
`invoiceCode`	String	Invoice Number that is printed on the invoice PDF	Yes
`invoiceUrl`	String	Downloadable pdf url of the invoice document(either of invoice and invoice Url is mandatory)	No
`irn`	String	Irn generated on Govt. portal after e-invoicing	No
`qrCode`	String	Qr generated on Govt. portal after e-invoicing	No
`invoiceDetails`	Object[]	Tax Details of the invoice. If invoice details are being sent, then taxItems are mandatory.	No
`invoiceDate`	String	Date of invoice generated by Increff Omni	Yes
`invoice`	String	Base64 encoded string of invoice PDF(either of invoice and invoice Url is mandatory)	No
`invoiceDetails.channelSkuCode`	String	SKU code of order item	Yes
`invoiceDetails.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.	No
`invoiceDetails.netTaxAmountPerUnit`	Double	Per unit tax applicable for the SKU	Yes
`invoiceDetails.netTaxAmountTotal`	Double	Total tax applicable for the SKU	Yes
`invoiceDetails.baseSellingPricePerUnit`	Double	Per unit base selling price of the SKU	Yes
`invoiceDetails.baseSellingPriceTotal`	Double	Total base selling price of the SKU	Yes
`invoiceDetails.actualSellingPricePerUnit`	Double	Per unit actual selling price of the SKU	Yes
`invoiceDetails.actualSellingPriceTotal`	Double	Total actual selling price of the SKU	Yes
`invoiceDetails.quantity`	Integer	Total quantity of a sku for a line item	Yes
`invoiceDetails.taxItems`	Object[]	Distribution of tax with tax type If invoice details are being sent, then taxItems are mandatory.	Yes
`taxItems.type`	String	Type of tax applicable	Yes
`taxItems.rate`	Double	Tax rate for this tax type	Yes
`taxItems.taxPerUnit`	Double	Per unit tax applicable for this type of tax	Yes
`taxItems.taxTotal`	Double	Total tax applicable for this type of tax	Yes
`invoiceDetails.orderItemCustomAttributes`	Object	Custom attributes for an order Item	No
`orderItemCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderItemCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderItemCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderItemCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderItemCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderItemCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderItemCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderItemCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderItemCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderItemCustomAttributes.attribute10`	String	Custom attribute 10	No
orderItemCustomAttributes.channelMetaData	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No
`orderCustomAttributes`	Object	Custom attributes for an order	No
`orderCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderCustomAttributes.attribute10`	String	Custom attribute 10	No
`orderCustomAttributes.channelMetaData`	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No
`orderCustomAttributes.currency`	String	Currency	No