Create Invoice

Parameter Name

Data Type

Description

Mandatory

orderCode

String

This is the order code which the tax details were calculated and the invoice PDF needs to be generated.

yes

shipmentCode

String

This is the shipment code which the tax details were calculated and the invoice PDF needs to be generated.

yes

Parameter Name

Data Type

Description

Mandatory

billingAddress

Object

Billing Address of the customer

Yes

billingAddress.city

String

City of customer

Yes

billingAddress.country

String

Country of customer

Yes

billingAddress.email

String

Email of customer

No

billingAddress.street1

String

1st line of customer address

Yes

billingAddress.street2

String

2nd line of customer address

No

billingAddress.street3

String

3rd line of customer address

No

billingAddress.firstName

String

First Name of customer

Yes

billingAddress.middleName

String

Middle Name of customer

No

billingAddress.lastName

String

Last Name of customer

Yes

billingAddress.phone

String

Phone number of customer

No

billingAddress.state

String

State of customer

Yes

billingAddress.zip

String

Zip/Pin code of customer

Yes

shippingAddress

Object

Total quantity of a sku for a line item

Yes

shippingAddress.city

String

City of customer

Yes

shippingAddress.country

String

Country of customer

Yes

shippingAddress.email

String

Email of customer

No

shippingAddress.street1

String

1st line of customer address

Yes

shippingAddress.street2

String

2nd line of customer address

No

shippingAddress.street3

String

3rd line of customer address

No

shippingAddress.firstName

String

First Name of customer

Yes

shippingAddress.middleName

String

Middle Name of customer

No

shippingAddress.lastName

String

Last Name of customer

Yes

shippingAddress.phone

String

Phone Number of customer

No

shippingAddress.state

String

State of customer

Yes

shippingAddress.zip

String 

Zip/Pin code of customer

Yes

fromAddress

Object

Seller Address

Yes

fromAddress.city

String

City of Seller

Yes

fromAddress.country

String

Country of Seller

Yes

fromAddress.email

String 

Email of Seller

No

fromAddress.street1

String

1st line of Seller address

Yes

fromAddress.street2

String

2nd line of Seller address

No

fromAddress.street3

String

3rd line of Seller address

No

fromAddress.firstName

String

First Name of Seller

Yes

fromAddress.middleName

String

Middle Name of Seller

No

fromAddress.lastName

String

Last Name of Seller

Yes

fromAddress.phone

String

Phone Number of Seller

No

fromAddress.state

String

State of Seller

Yes

fromAddress.zip

String

Zip/Pin code of Seller

Yes

clientPanNo

String

Client Pan Number

Yes

currency

String

Currency (default value is “INR”)

No

fromPartyName

String

Name of Seller

Yes

orderTime

Date

Order Date and Time

Yes

timeZone

String

Time Zone in which order time and invoice time will be printed

Yes

toPartyName

String

Name of customer

Yes

orderType

String

Type of order. Can have one of these two values:”SALES” and “STOCK_TRANSFER”

Yes

internalOrderId

String

Internal Order Id in Seller’s system

Yes

channelOrderId

String

Channel Order Id

No

channelName

String

Channel Name

No

invoiceItems

Object[]

Invoice Items

No

invoiceItems.lineItemId

Long

Unique Identifier for the line items (should be the same as the line item id used for computing tax) 

Yes

invoiceItems.channelSku

String

Channel SKU

Yes

invoiceItems.itemName

String

Item Name

Yes

invoiceItems.orderItemCode

String

Order Item Code. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.styleId

String

Style Id. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.mrp

Double

MRP of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.discount

Double

Discount of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.category

String

Category of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.actualSellingPricePerUnit

Double

Selling Price of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.shippingChargePerUnit

Double

Shipping Charge applied on the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.codChargePerUnit

Double

COD Charge of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.quantity

Integer

Quantity of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.hsn

String

HSN of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.vendorSku

String

Vendor SKU of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.taxAmountPerUnit

Double

Tax Amount of the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.taxRate

Double

Tax Rate applied on the product. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.subTaxItems

List

List of sub tax items. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.subTaxItems.type

String

Type of sub tax item. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.subTaxItems.rate

Double

Sub Tax Item Rate. This field is required to be sent only when the tax details are not computed from RMS

No

invoiceItems.subTaxItems.taxPerUnit

Double

Sub Tax Item Amount. This field is required to be sent only when the tax details are not computed from RMS

No

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