Get Invoice Details

This REST API is used to fetch complete tax details (break-up) corresponding to order items from the marketplace. This tax information is required by sellers for accounting purpose or to generate invoice for keeping inside shipment.

Tip

Invoice details are fetched when the shipment status changes from created to packed.

The invoice details are fetched based on Order Items IDs and not Order IDs, which helps in getting valid invoice details even for splitted orders.

It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME	DETAILS
Usage:	Optional
Endpoint:	/invoiceDetails
Request Type:	GET
Schemes:	HTTPS
Header (Content-Type):	application/json
Header (apiKey):	accessToken (got from Get Authentication)

Sample URL

https://{MarketplaceBaseUrl}/invoiceDetails?orderItemIds=abc123

Query Parameters

PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
orderItemIds	string	Order Item ID’s	Yes	-

Response Payload

{
  "code": "CIN1000345",
  "productTaxes": [
    {
      "additionalInfo": "string",
      "productId": "string",
      "variantId": "string",
      "taxPercentage": 0,
      "centralGstPercentage": 6,
      "stateGstPercentage": 6,
      "unionTerritoryGstPercentage": 0,
      "integratedGstPercentage": 12,
      "compensationCessPercentage": 0
    }
  ],
  "invoiceDate": "2024-02-26T12:41:45"
}

Response Payload (Error)

{
 "message":"String"
}

Tax Applicability

VAT (taxPercentage) - Use for VAT system taxation countries.
GST - Goods and Services Tax (GST) has replaced VAT, CST and all other indirect taxes levied on goods and services by the central and state governments with Uniform Tax throughout the country to mark the evolution of a common national market

SGST (stateGstPercentage) and CGST (centralGstPercentage): For intra-state transactions (supply of goods).
IGST (integratedGstPercentage): For inter-state transactions.
UTGST (unionTerritoryGstPercentage): For transactions in five union territories i.e. Andaman and Nicobar Islands, Dadra and Nagar Haveli, Chandigarh, Lakshadweep and Daman and Diu.
Compensation Cess: Cess to compensate the loss of state’s revenue due to the implementation of GST.

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	code	string	Invoice code	Yes	e.g. CIN1000345
2	productTaxes	list	List of product taxes	-	-
2.1	additionalInfo	string	Any additional information	No	Only Internal purpose
2.2	productId	string	The product ID for which the tax details are provided	Yes	-
2.3	variantId	string	The variant ID for which the tax details are provided	Yes (if applicable)	-
2.4	taxPercentage	number	VAT Tax percentage	Yes (if applicable)	Use only for VAT system taxation countries
2.5	centralGstPercentage	number	Central GST percentage	Yes (if applicable)	-
2.6	stateGstPercentage	number	State GST percentage	Yes (if applicable)	-
2.7	unionTerritoryGstPercentage	number	UT GST percentage	Yes (if applicable)	-
2.8	integratedGstPercentage	number	IGST percentage	Yes (if applicable)	-
2.9	compensationCessPercentage	number	Compensation cess percentage	Yes (if applicable)	-
3	invoiceDate	date	Date when invoice was generated	Yes	Format: yyyy-MM-dd’T’HH:mm:ss, Eg: 2017-01-02T08:12:53
E	message	string	Error message Eg: Invalid User/Token	No	-

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What is “code” in response? Which type of invoice code does UC want?
Ans. Invoice code can be any alphanumeric unique code or ID. This code signifies the invoice number of the MP.

Q2. Can MPs skip integrating this API?
Ans. It depends on the MP, if they want to provide invoice from their side or want it from our side. If it is generated from UC end, then also UC can provide invoice details to the MP using Post Shipment Details API.

Q3. What is .600z after date and time in the Response Payload?
Ans. For maintaining time zone consistency, .600z is added and shown as an example of timestamp. ‘z’ is added as a parameter to display time in a local time zone.

Q4. Since this API is optional, when do we use it and since the seller always needs the invoice, where does he get this?
Ans. This API is used to fetch invoice details from the MP. UC can also provide the invoice to the seller.

Q5. If MP wants to send the Invoice PDF, how can they do it?
Ans. They can merge it along with the Label PDF and send in the same response payload of Get Labels API.

Q6. If the invoice is generated from UC’s end, can UC provide its details to the MP?
Ans. Yes, Post Shipment Details api can do this. If MP does not opt Get Invoice Details api then invoice will be generated from UC’s end. Here only UC invoice series will be pass against the param invoiceNumber without Uniware Channel Code. e.g. UIN1000345. If MP opts the Get Invoice Details api then channel invoice series will be passed against the param invoiceNumber appended with Uniware Channel Code, format will be UniwareChannelCode-InvoiceNumber e.g. ChanelXYZABC-CIN1000345.