Skip to main content
PATCH
Available in🇮🇳 India🇲🇾 Malaysia🇸🇬 Singapore🇺🇸 United States
Use this endpoint to update a Bill.

​
Path Parameters

​
string
required
The unique identifier of the Bill.

​
Request Parameters

​
string
required
Associated store code for the receipt. Required if you have a multi-store setup where you have a single integration and have multiple stores under you.
​
object
required
Details of the customer. Required if receipt mode is digital or digital_and_print.
​
string
required
The customer’s phone number. Required if receipt mode is digital or digital_and_print and email is not present.
​
string
The customer’s name.
​
string
required
The customer’s email address. Required if receipt mode is digital or digital_and_print and contact is not present.
​
string
The customer’s customer_id. Required if receipt mode is digital or digital_and_print and neither contact nor email is present.
​
integer
Age of the customer.
​
string
Customer’s date of birth.
​
string
PAN number of the billed customer.
​
string
Customer’s current job profile name.
​
string
Customer current employer.
​
string
Customer’s marital status. Possible values:
  • married
  • unmarried
​
string
Name of customer’s spouse.
​
string
Customer’s date of anniversary.
​
string
Customer gender. Possible values:
  • male
  • female
  • other
​
string
Customer’s GST number.
​
object
required
Customer’s billing address. Required if your business_type is ecommerce.
​
string
Customer billing address line 1.
​
string
Customer billing address line 2.
​
string
Customer billing address landmark.
​
string
Customer billing address city.
​
string
Customer billing address province.
​
string
Customer billing address PIN code.
​
string
Customer billing address country.
​
object
required
Customer’s billing address. Required if your business_type is ecommerce.
​
string
Name of the recipient.
​
string
The mobile number of the recipient.
​
string
GST number of the recipient.
​
string
PAN number of the recipient.
​
string
Customer shipping address line 1.
​
string
Customer shipping address line 2.
​
string
Customer shipping address landmark.
​
string
Customer shipping address city.
​
string
Customer shipping address province.
​
string
Customer shipping address PIN code.
​
string
Customer shipping address country.
​
object
This is an array of objects containing details of the employees associated with the receipt.
​
string
Employee ID/code. Unique identifier of the employee.
​
string
Name of the employee.
​
string
Employee designation/role.
​
object
required
Customer loyalty details.
​
string
Customer loyalty type.
​
string
Hashed debit/credit card number provided by the customer.
​
string
Name of the card holder.
​
integer
Wallet amount after used rewards of the customer.
​
integer
Amount saved by the customer.
​
integer
Points earned by the customer after a transaction.
​
integer
Points redeemed by the customer on a transaction.
​
integer
Points available to the customer at the beginning of the transaction.
​
integer
Points available to the customer at the end of the transaction.
​
string
required
The type of receipt. Possible values:
  • tax_invoice
  • sales_invoice
  • sales_return_invoice
  • proforma_invoice
  • credit_invoice
  • purchase_invoice
  • debit_invoice
​
integer
required
UNIX timestamp of the date and time when the receipt was generated.
​
string
required
Indicates the delivery type of the receipt. Possible values:
  • digital
  • print
  • digital_and_print
​
string
An array of strings representing relevant tags associated with the invoice.
​
string
The type of POS machine. This is applicable if business_type is retail. Possible values:
  • traditional_pos
  • kiosk_pos
​
object
required
This is an array of objects containing the product data of the bill. Required if receipt_type is not credit_invoice or debit_invoice.
​
string
required
Name of the product.
​
float
required
Quantity of the product.
​
integer
Price of the product.
​
string
Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
​
float
The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments.
​
float
The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials.
​
string
Product/Item description.
​
string
HSN code of the product.
​
string
Product/Item code.
​
string
Product/Item UID/SKU Code.
​
string
Image URL of the product.
​
integer
required
Total amount of the product.
​
string
Brand name of the product.
​
string
Product style.
​
string
Colour of the product.
​
string
Size of the product in cm.
​
string
An array of strings representing relevant tags associated with the item.
​
string
Unique ID of the employee who sold the product.
​
object
This is an array of objects containing details of the additional charges of the item.
​
string
Description of the additional charge.
​
integer
Amount of additional charge.
​
float
Percent calculated on total amount.
​
object
required
An array of objects containing the sub-item details of the item.
​
string
required
Name of the sub-item.
​
integer
required
Sub-item quantity.
​
integer
Price of the sub-item.
​
string
Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
​
float
The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments.
​
float
The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials.
​
string
Sub-item description.
​
string
HSN code of the product.
​
string
Sub-item code.
​
string
Sub-item UID/SKU Code.
​
string
Image URL of the sub-item.
​
integer
required
Total amount of the sub-item.
​
string
Brand name of the sub-item.
​
string
Sub-item style.
​
string
Colour of the sub-item.
​
string
Size of the sub-item in cm.
​
string
An array of strings representing relevant tags associated with the sub-item.
​
string
Unique ID of the employee who sold the product.
​
object
This is an array of objects containing details of the additional charges of the item.
​
string
Description of the additional charge.
​
integer
Amount of additional charge.
​
float
Percent calculated on total amount.
​
object
This is an array of objects containing the details of the taxes incurred.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
Data of the financier. This is applicable if the product is financed. For example, if the product is purchased on EMI.
​
string
Unique id of the financier.
​
string
Name of the financier.
​
object
This is an array of objects containing the details of the taxes incurred.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
required
Details of the receipt.
​
integer
required
Total product quantity sold in the invoice.
​
integer
The total amount before taxes, discounts and additional fees are added to the invoice.
​
string
required
The currency of the invoice. Refer to this sheet for the list of supported currencies.
​
integer
Total tax amount in paise.
​
float
Total tax percentage applied on the receipt.
​
integer
required
The total amount payable after adding taxes, discounts and additional fees to the invoice.
​
object
This is an array of objects containing the details of any additional charges applied on the invoice. If additional_charges is present, then description and amount are required.
​
string
Description of the additional charge.
​
integer
Amount of the additional charge.
​
float
Percent calculated on total amount.
​
string
Status of the payment. Possible values:
  • pending
  • authorized
  • failed
  • declined
  • refunded
  • cancelled
  • processed
  • settled
  • voided
  • success
  • paid
  • unpaid
​
integer
Change amount to be returned to the customer if the payment was made in cash.
​
integer
Change amount to be returned to the customer if the payment was made in cash.
​
float
Total percentage of the discount on the sub-total amount without the taxes.
​
integer
Total value of the discount on the invoice.
​
object
This is an array of objects containing the details of the discount. If product reference (product_code, product_uid, or hsn_code) is present in the object, then the discount will be on the item. If not, the discount will be on the invoice.
​
string
Name of the discount.
​
string
Amount of the applied discount.
​
integer
Percentile value of the discounted amount.
​
string
Product/Item code.
​
string
Product/Item UID/SKU Code.
​
string
HSN code of the product.
​
string
Reference ID of the discount.
​
string
Amount used from the customer’s wallet for this transaction.
​
object
This is an array of objects containing the details of the taxes incurred.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
required
This is an array of objects containing the details of the payment.
​
string
required
The mode of payment.
​
string
required
The currency in which the payment was made.
​
integer
required
The amount of the payment in paise. For example, if the amount is 1200. The unit will be 120000.
​
object
This object contains IRN ( Invoice Reference Number ) related details. If irn is present, qr_code and irn_number are required.
​
string
Acknowledgement number of the generated IRN.
​
integer
Acknowledgement date of the generated IRN.
​
string
required
QR code associated with the IRN. Required if irn is present.
​
string
required
E-invoice IRN. Required if IRN is present.

​
Response Parameters

​
string
required
Unique id of the bill generated.
​
string
required
The type of business. Possible values:
  • ecommerce
  • retail
​
string
required
The category the business falls under. Possible values:
  • events
  • food_and_beverages
  • retail_and_consumer_goods
  • other_services
​
object
required
Details of the customer. Required if receipt mode is digital or digital_and_print.
​
string
required
The customer’s phone number. Required if receipt mode is digital or digital_and_print and email is not present.
​
string
The customer’s name.
​
string
required
The customer’s email address. Required if receipt mode is digital or digital_and_print & contact not present.
​
string
The customer’s customer_id. Required if receipt mode is digital or digital_and_print and neither contact nor email is present.
​
integer
Age of the customer.
​
string
Customer’s date of birth.
​
string
Customer’s current job profile name.
​
string
Customer current employer.
​
string
Customer’s date of birth.
​
string
Customer’s marital status. Possible values:
  • married
  • unmarried
​
string
Name of customer’s spouse.
​
string
Customer’s date of anniversary.
​
string
Customer gender. Possible values:
  • male
  • female
  • other
​
string
Customer’s GST number.
​
object
required
Customer’s billing address. Required if your business_type is ecommerce.
​
string
Customer billing address line 1.
​
string
Customer billing address line 2.
​
string
Customer billing address landmark.
​
string
Customer billing address city.
​
string
Customer billing address province.
​
string
Customer billing address PIN code.
​
string
Customer billing address country.
​
object
required
Customer’s billing address. Required if your business_type is ecommerce.
​
string
Customer shipping address line 1.
​
string
Customer shipping address line 2.
​
string
Customer shipping address landmark.
​
string
Customer shipping address city.
​
string
Customer shipping address province.
​
string
Customer shipping address PIN code.
​
string
Customer shipping address country.
​
object
required
Customer loyalty details.
​
string
Customer loyalty type.
​
string
Hashed debit/credit card number provided by the customer.
​
string
Name of the card holder.
​
integer
Wallet amount after used rewards of the customer.
​
integer
Amount saved by the customer.
​
integer
Points earned by the customer after a transaction.
​
integer
Points redeemed by the customer on a transaction.
​
integer
Points available to the customer at the beginning of the transaction.
​
integer
Points available to the customer at the end of the transaction.
​
string
required
Associated store code for the receipt. Required if you have a multi-store setup where you have a single integration and have multiple stores under you.
​
integer
required
UNIX timestamp of the date and time when the receipt was generated.
​
string
required
Unique receipt number generated for the bill.
​
string
required
The type of receipt. Possible values:
  • tax_invoice
  • sales_invoice
  • sales_return_invoice
  • proforma_invoice
  • credit_invoice
  • purchase_invoice
  • debit_invoice
​
string
required
Indicates the delivery type of the receipt. Possible values:
  • digital
  • print
  • digital_and_print
​
string
An array of strings representing relevant tags associated with the invoice.
​
integer
Bar code generated after the transaction. This will be displayed on the digital bill only.
​
integer
QR code generated after the transaction. This will be displayed on the digital bill only.
​
string
POS number of the machine that generated the bill. This is applicable if business_type is retail.
​
string
The type of POS machine. This is applicable if business_type is retail. Possible values:
  • traditional_pos
  • kiosk_pos
​
string
Incremental order number of the generated bill.
​
string
Order service type of the generated bill. This is applicable if business_category is food_and_beverages. Possible values:
  • dine_in
  • take_away
​
string
Order delivery status. This is applicable if business_type is ecommerce.
​
object
required
This is an array of objects containing the product data of the bill. Required if receipt_type is not credit_invoice or debit_invoice.
​
string
required
Name of the product.
​
float
required
Quantity of the product.
​
integer
Price of the product.
​
string
Unique ID of the employee who sold the product.
​
string
Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
​
string
Product/Item description.
​
string
HSN code of the product.
​
string
Product/Item code.
​
string
Product/Item UID/SKU Code.
​
string
Image URL of the product.
​
integer
required
Total amount of the product.
​
string
Brand name of the product.
​
string
Product style.
​
string
Colour of the product.
​
string
Size of the product in cm.
​
string
An array of strings representing relevant tags associated with the item.
​
object
required
An array of objects containing the sub-item details of the item.
​
string
required
Name of the sub-item.
​
integer
required
Sub-item quantity.
​
integer
Price of the sub-item.
​
string
Unique ID of the employee who sold the product.
​
string
Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
​
string
Sub-item description.
​
string
HSN code of the product.
​
string
Sub-item code.
​
string
Sub-item UID/SKU Code.
​
string
Image URL of the sub-item.
​
integer
required
Total amount of the sub-item.
​
string
Brand name of the sub-item.
​
string
Sub-item style.
​
string
Colour of the sub-item.
​
string
Size of the sub-item in cm.
​
string
An array of strings representing relevant tags associated with the sub-item.
​
object
This is an array of objects containing the details of the taxes incurred.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
This is an array of objects containing the details of the taxes incurred.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
required
Details of the receipt.
​
integer
required
Total product quantity sold in the invoice.
​
integer
The total amount before taxes, discounts and additional fees are added to the invoice.
​
string
required
The currency of the invoice. Refer to this sheet for the list of supported currencies.
​
integer
Total tax amount in paise.
​
float
Total tax percentage applied on the receipt.
​
integer
required
The total amount payable after adding taxes, discounts and additional fees to the invoice.
​
object
This is an array of objects containing the details of any additional charges applied on the invoice. If additional_charges is present, then description and amount are required.
​
string
Description of the additional charge.
​
integer
Amount of the additional charge.
​
float
Percent calculated on total amount.
​
string
Status of the payment. Possible values:
  • pending
  • authorized
  • failed
  • declined
  • refunded
  • cancelled
  • processed
  • settled
  • voided
  • success
  • paid
  • unpaid
​
integer
Change amount to be returned to the customer if the payment was made in cash.
​
integer
Change amount to be returned to the customer if the payment was made in cash.
​
float
Total percentage of the discount on the sub-total amount without the taxes.
​
integer
Total value of the discount on the invoice.
​
object
This is an array of objects containing the details of the discount.
​
string
Name of the discount.
​
string
Amount of the applied discount.
​
integer
Percentile value of the discounted amount.
​
string
Amount used from the customer’s wallet for this transaction.
​
object
required
This is an array of objects containing the details of the taxes applied. Required if receipt_type is tax_inovice, purchase_invoice or sales_invoice.
​
string
required
Name of the tax. For example, CGST, SGST and so on.
​
float
Percentage of tax.
​
integer
required
Applicable tax calculated on total amount.
​
object
required
Details of the payment.
​
string
required
The mode of payment.
​
string
required
The currency in which the payment was made.
​
integer
required
The amount of the payment in paise. For example, if the amount is 1200. The unit will be 120000.
​
string
The Unique id of the payment method.
​
object
Details of the financier.
​
string
Unique id of the financier.
​
string
Name of the financier.
​
object
required
Details of the event booking. Required if business_category is events.
​
string
required
Name of the event.
​
integer
The exact time in seconds when the event starts.
​
integer
The exact time in seconds when the event ends.
​
string
The location/venue of the event.
​
string
The specific room where the event was held.
​
string
The number of seats booked for the event.
​
string
The link to the receipt.
​
integer
UNIX timestamp of the date when the bill was generated.

​
Errors

Code: 401The client credentials are unauthorised to make changes to this bill.Solution: Use authorised credentials to make changes to the bill.
Code: 400The quantity of the product was not written in integer format.Solution: Write the quantity in integer format.
Code: 400There is an internal server error.Solution: There is a server issue. Raise a support ticket with us to get this resolved.
Code: 400The bill id is incorrect or deleted.Solution: Add the correct bill id.
Last modified on October 8, 2026