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 |
| String | Unique code used by the channel to identify the shipment | yes |
| 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",
"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
}
]
}
]
}
HttpStatus : 200
Note:
At least one of invoiceUrl or invoice should be present.
If invoice details are being sent, then taxItems are mandatory.
Parameter Name | Data Type | Description | Mandatory |
| String | Invoice Number that is printed on the invoice PDF | Yes |
| String | Downloadable pdf url of the invoice document(either of invoice and invoice Url is mandatory) | no |
| String | Irn generated on Govt. portal after e-invoicing | no |
| String | Qr generated on Govt. portal after e-invoicing | no |
| Object[] | Tax Details of the invoice | Yes |
| String | Date of invoice generated by Assure | Yes |
| String | Base64 encoded string of invoice PDF(either of invoice and invoice Url is mandatory) | no |
| String | SKU code of order item | Yes |
| String | This is provided by the channel to uniquely identify each order item. | No |
| Double | Per unit tax applicable for the SKU | Yes |
| Double | Total tax applicable for the SKU | Yes |
| Double | Per unit base selling price of the SKU | Yes |
| Double | Total base selling price of the SKU | Yes |
| Double | Per unit actual selling price of the SKU | Yes |
| Double | Total actual selling price of the SKU | Yes |
| Integer | Total quantity of a sku for a line item | Yes |
| Object[] | Distribution of tax with tax type | Yes |
| String | Type of tax applicable | Yes |
| Double | Tax rate for this tax type | Yes |
| Double | Per unit tax applicable for this type of tax | Yes |
| Double | Total tax applicable for this type of tax | Yes |