Skip to main content

​
Response

Entity

​
Parameters

id mandatory : string Unique id of the bill generated. business_type mandatory : string The type of business. Possible values:
  • ecommerce
  • retail
business_category mandatory : string The category the business falls under. Possible values:
  • events
  • food_and_beverages
  • retail_and_consumer_goods
  • other_services
customer conditionally mandatory : object Details of the customer. Required if receipt mode is digital or digital_and_print. contact conditionally mandatory : string The customer’s phone number. Required if receipt mode is digital or digital_and_print and email is not present. name optional : string The customer’s name. email conditionally mandatory : string The customer’s email address. Required if receipt mode is digital or digital_and_print and contact not present. customer_id optional : string The customer’s customer_id. Required if receipt mode is digital or digital_and_print and neither contact nor email is present. age optional : integer Age of the customer. date_of_birth optional : string Customer’s date of birth. pan optional : string PAN number of the billed customer. profession optional : string Customer’s current job profile name. company_name optional : string Customer current employer. date_of_birth optional : string Customer’s date of birth. marital_status optional : string Customer’s marital status. Possible values:
  • married
  • unmarried
spouse_name optional : string Name of customer’s spouse. anniversary_date optional : string Customer’s date of anniversary. gender optional : string Customer gender. Possible values:
  • male
  • female
  • other
gstin optional : string Customer’s GST number. billing_address mandatory : object Customer’s billing address. Required if your business_type is ecommerce. address_line_1 optional : string Customer billing address line 1. address_line_2 optional : string Customer billing address line 2. landmark optional : string Customer billing address landmark. city optional : string Customer billing address city. province optional : string Customer billing address province. pin_code optional : string Customer billing address PIN code. country optional : string Customer billing address country. shipping_address mandatory : object Customer’s billing address. Required if your business_type is ecommerce. customer_name optional : string Name of the recipient. contact optional : string The mobile number of the recipient. gstin optional : string GST number of the recipient. pan optional : string PAN number of the recipient. address_line_1 optional : string Customer shipping address line 1. address_line_2 optional : string Customer shipping address line 2. landmark optional : string Customer shipping address landmark. city optional : string Customer shipping address city. province optional : string Customer shipping address province. pin_code optional : string Customer shipping address PIN code. country optional : string Customer shipping address country. employee optional : object This is an array of objects containing details of the employees associated with the receipt. id optional : string Employee ID/code. name optional : string Employee name. role optional : string Employee designation/role. loyalty conditionally mandatory : object Customer loyalty details. type optional : string Customer loyalty type. card_num optional : string Hashed debit/credit card number provided by the customer. card_holder_name optional : string Name of the card holder. wallet_amount optional : integer Wallet amount after used rewards of the customer. amount_saved optional : integer Amount saved by the customer. points_earned optional : integer Points earned by the customer after a transaction. points_redeemed optional : integer Points redeemed by the customer on a transaction. points_available optional : integer Points available to the customer at the beginning of the transaction. points_balance optional : integer Points available to the customer at the end of the transaction. store_code conditionally mandatory : string 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. receipt_timestamp mandatory : integer UNIX timestamp of the date and time when the receipt was generated. receipt_number mandatory : string Unique receipt number generated for the bill. receipt_type mandatory : string The type of receipt. Possible values:
  • tax_invoice
  • sales_invoice
  • sales_return_invoice
  • proforma_invoice
  • credit_invoice
  • purchase_invoice
  • debit_invoice
  • order_confirmation
receipt_delivery mandatory : string Indicates the delivery type of the receipt. Possible values:
  • digital
  • print
  • digital_and_print
tags optional : array An array of strings representing relevant tags associated with the invoice. bar_code_number optional : integer Bar code generated after the transaction. This will be displayed on the digital bill only. qr_code_number optional : integer QR code generated after the transaction. This will be displayed on the digital bill only. billing_pos_number optional : string POS number of the machine that generated the bill. This is applicable if business_type is retail. pos_category optional : string The type of POS machine. This is applicable if business_type is retail. Possible values:
  • traditional_pos
  • kiosk_pos
order_number optional : string Incremental order number of the generated bill. order_service_type optional : string Order service type of the generated bill. This is applicable if business_category is food_and_beverages. Possible values:
  • dine_in
  • take_away
delivery_status_url optional : string Order delivery status. This is applicable if business_type is ecommerce. line_items conditionally mandatory : object This is an array of objects containing the product data of the bill. Required if receipt_type is not credit_invoice or debit_invoice. name mandatory : string Name of the product. quantity : float Quantity of the product. unit_amount optional : integer Price of the product. unit optional : string Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
gross_weight optional : float The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments. net_weight optional : float The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials. description optional : string Product/Item description. hsn_code optional : string HSN code of the product. product_code optional : string Product/Item code. product_uid optional : string Product/Item UID/SKU Code. image_url optional : string Image URL of the product. total_amount mandatory : integer Total amount of the product. brand optional : string Brand name of the product. style optional : string Product style. colour optional : string Colour of the product. size optional : string Size of the product in cm. tags optional : string An array of strings representing relevant tags associated with the item. employee_id optional : string Unique ID of the employee who sold the product. additional_charges optional : object This is an array of objects containing details of any additional charges on the item. description optional : string Description of the additional charges. amount optional : integer Amount of additional charges. percent optional : float Percent calculated on total amount. sub_items conditionally mandatory : object An array of objects containing the sub-item details of the item. name mandatory : string Name of the sub-item. quantity mandatory : integer Sub-item quantity. unit_amount optional : integer Price of the sub-item. unit optional : string Type of unit. Possible values:
  • kg
  • g
  • mg
  • lt
  • ml
  • pc
  • cm
  • m
  • in
  • ft
  • set
gross_weight optional : float The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments. net_weight optional : float The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials. description optional : string Sub-item description. hsn_code optional : string HSN code of the product. product_code optional : string Sub-item code. product_uid optional : string Sub-item UID/SKU Code. image_url optional : string Image URL of the sub-item. total_amount mandatory : integer Total amount of the sub-item. brand optional : string Brand name of the sub-item. style optional : string Sub-item style. colour optional : string Colour of the sub-item. size optional : string Size of the sub-item in cm. tags optional : string An array of strings representing relevant tags associated with the sub-item. additional_charges optional : object This is an array of objects containing details of any additional charges on the item. description optional : string Description of the additional charges. amount optional : integer Amount of additional charges. percent optional : float Percent calculated on total amount. taxes optional : object This is an array of objects containing the details of the taxes incurred. name mandatory : string Name of the tax. For example, CGST, SGST and so on. percentage optional : float Percentage of tax. amount mandatory : integer Applicable tax calculated on total amount. taxes optional : object This is an array of objects containing the details of the taxes incurred. name mandatory : string Name of the tax. For example, CGST, SGST and so on. percentage optional : float Percentage of tax. amount mandatory : integer Applicable tax calculated on total amount. receipt_summary mandatory : object Details of the receipt. total_quantity mandatory : integer Total product quantity sold in the invoice. sub_total_amount optional : integer The total amount before taxes, discounts and additional fees are added to the invoice. currency mandatory : string The currency of the invoice. Refer to this sheet for the list of supported currencies. total_tax_amount optional : integer Total tax amount in paise. total_tax_percent optional : float Total tax percentage applied on the receipt. net_payable_amount mandatory : integer The total amount payable after adding taxes, discounts and additional fees to the invoice. additional_charges optional : 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. description optional : string Description of the additional charge. amount optional : integer Amount of the additional charge. percent optional : float Percent calculated on total amount. payment_status optional : string Status of the payment. Possible values:
  • pending
  • authorized
  • failed
  • declined
  • refunded
  • cancelled
  • processed
  • settled
  • voided
  • success
  • paid
  • unpaid
change_amount optional : integer Change amount to be returned to the customer if the payment was made in cash. roundup_amount optional : integer Change amount to be returned to the customer if the payment was made in cash. total_discount_percent optional : float Total percentage of the discount on the sub-total amount without the taxes. total_discount_amount optional : integer Total value of the discount on the invoice. discounts optional : 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. name optional : string Name of the discount. amount optional : string Amount of the applied discount. percent optional : integer Percentile value of the discounted amount. product_code optional : string Product/Item code. product_uid optional : string Product/Item UID/SKU Code. hsn_code optional : string HSN code of the product. reference_id optional : string Reference ID of the discount. used_wallet_amount optional : string Amount used from the customer’s wallet for this transaction. taxes conditionally mandatory : object 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. name mandatory : string Name of the tax. For example, CGST, SGST and so on. percentage optional : float Percentage of tax. amount mandatory : integer Applicable tax calculated on total amount. payments mandatory : object Details of the payment. method mandatory : string The mode of payment. currency mandatory : string The currency in which the payment was made. amount mandatory : integer The amount of the payment in paise. For example, if the amount is 1200. The unit will be 120000. payment_reference_id optional : string The Unique id of the payment method. financier_data optional : object Details of the financier. reference optional : string Unique id of the financier. name optional : string Name of the financier. event conditionally mandatory : object Details of the event booking. Required if business_category is events. name mandatory : string Name of the event. start_timestamp optional : integer The exact time in seconds when the event starts. end_timestamp optional : integer The exact time in seconds when the event ends. location optional : string The location/venue of the event. room optional : string The specific room where the event was held. seats optional : string The number of seats booked for the event. irn optional : object This object contains IRN ( Invoice Reference Number ) related details. If irn is present, qr_code and irn_number are required. acknowledgement_number optional : string Acknowledgement number of the generated IRN. acknowledgement_date optional : integer Acknowledgement date of the generated IRN. qr_code conditionally mandatory : string QR code associated with the IRN. Required if IRN is present. irn_number conditionally mandatory : string E-invoice IRN. Required if IRN is present. receipt_url : string The link to the receipt. created_at : integer UNIX timestamp of the date when the bill was generated.