> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Bills Entity
> Entity parameters and sample code for Bills API.
Available in
🇮🇳 India
🇸🇬 Singapore
🇺🇸 United States
The Bills entity has the following parameters:
```json Entity theme={null}
{
"id": "bill_PYamApGCFTAjkh",
"business_type": "retail",
"business_category": "retail_and_consumer_goods",
"customer": {
"contact": "9876543210",
"name": "Gaurav Kumar",
"email": "",
"customer_id": "",
"date_of_birth": "",
"profession": "",
"company_name": "",
"marital_status": "",
"spouse_name": "",
"anniversary_date": "",
"gender": "",
"gstin": "",
"billing_address": null,
"shipping_address": null
},
"loyalty": null,
"store_code": "JK-001",
"receipt_timestamp": 1722664800,
"receipt_number": "INV001250013",
"receipt_type": "tax_invoice",
"receipt_delivery": "digital",
"bar_code_number": "3412",
"qr_code_number": "T2322 00000009291",
"billing_pos_number": "bn",
"pos_category": "traditional_pos",
"order_number": "ORD213",
"order_service_type": "",
"delivery_status_url": "",
"line_items": [
{
"name": "Acme Soap",
"quantity": 1,
"unit_amount": 10000,
"employee_id": "1234",
"unit": "pc",
"description": "",
"hsn_code": "HC2000INCLT",
"product_code": "DRCO38",
"product_uid": "",
"image_url": "",
"total_amount": 10000,
"brand": "",
"style": "",
"colour": "",
"size": "",
"financier_data": null,
"taxes": [
{
"name": "CGST",
"percentage": 10,
"amount": 1000
},
{
"name": "SGST",
"percentage": 10,
"amount": 1000
}
],
"tags": [
"noise cancelling",
"limited edition"
],
"sub_items": [
{
"name": "Advanced Edition",
"quantity": 1,
"unit_amount": 0,
"employee_id": "1234",
"unit": "pc",
"description": "",
"hsn_code": "",
"product_code": "",
"product_uid": "",
"image_url": "",
"total_amount": 10,
"brand": "",
"style": "",
"colour": "",
"size": "",
"taxes": [],
"tags": []
}
]
},
{
"name": "Acme Earphones",
"quantity": 1,
"unit_amount": 80000,
"employee_id": "1234",
"unit": "pc",
"description": "",
"hsn_code": "HC2000INPPLT",
"product_code": "POPLT281",
"product_uid": "",
"image_url": "",
"total_amount": 80000,
"brand": "",
"style": "",
"colour": "",
"size": "",
"financier_data": null,
"taxes": [
{
"name": "CGST",
"percentage": 10,
"amount": 8000
},
{
"name": "SGST",
"percentage": 10,
"amount": 8000
}
],
"tags": [],
"sub_items": []
}
],
"receipt_summary": {
"total_quantity": 2,
"sub_total_amount": 150000,
"currency": "INR",
"net_payable_amount": 187500,
"additional_charges": [
{
"description": "alteration charge",
"amount": 2000
},
{
"description": "cash on delivery",
"amount": 2000
},
],
"payment_status": "success",
"change_amount": 0,
"roundup_amount": 0,
"total_discount_percent": 0,
"total_discount_amount": 0,
"discounts": [
{
"name": "none",
"amount": 0,
"percent": 10
}
],
"used_wallet_amount": 0,
"total_tax_amount": 37500,
"total_tax_percent": 25
},
"taxes": [
{
"name": "CGST",
"percentage": 10,
"amount": 150
},
{
"name": "SGST",
"percentage": 10,
"amount": 150
},
{
"name": "cess",
"percentage": 5,
"amount": 75
}
],
"payments": [
{
"method": "paytm",
"currency": "INR",
"amount": 90000,
"payment_reference_id": "",
"financier_data": {
"reference": "",
"name": "v"
}
}
],
"event": null,
"receipt_url": "yourbill.me/PYamApGCFTAjkh",
"created_at": 1722664800,
"tags": [
"noise cancelling",
"limited edition"
]
}
```
Unique id of the bill generated.
The type of business. Possible values:
* `ecommerce`
* `retail`
The category the business falls under. Possible values:
* `events`
* `food_and_beverages`
* `retail_and_consumer_goods`
* `other_services`
Details of the customer. Required if receipt mode is `digital` or `digital_and_print`.
The customer's phone number. Required if receipt mode is `digital` or `digital_and_print` and `email` is not present.
The customer's name.
The customer's email address. Required if receipt mode is `digital` or `digital_and_print` and `contact` not present.
The customer's customer\_id. Required if receipt mode is `digital` or `digital_and_print` and neither `contact` nor `email` is present.
Age of the customer.
Customer's date of birth.
PAN number of the billed customer.
Customer's current job profile name.
Customer current employer.
Customer's date of birth.
Customer's marital status. Possible values:
* `married`
* `unmarried`
Name of customer's spouse.
Customer's date of anniversary.
Customer gender. Possible values:
* `male`
* `female`
* `other`
Customer's GST number.
Customer's billing address. Required if your `business_type` is `ecommerce`.
Customer billing address line 1.
Customer billing address line 2.
Customer billing address landmark.
Customer billing address city.
Customer billing address province.
Customer billing address PIN code.
Customer billing address country.
Customer's billing address. Required if your `business_type` is `ecommerce`.
Name of the recipient.
The mobile number of the recipient.
GST number of the recipient.
PAN number of the recipient.
Customer shipping address line 1.
Customer shipping address line 2.
Customer shipping address landmark.
Customer shipping address city.
Customer shipping address province.
Customer shipping address PIN code.
Customer shipping address country.
This is an array of objects containing details of the employees associated with the receipt.
Employee ID/code.
Employee name.
Employee designation/role.
Customer loyalty details.
Customer loyalty type.
Hashed debit/credit card number provided by the customer.
Name of the card holder.
Wallet amount after used rewards of the customer.
Amount saved by the customer.
Points earned by the customer after a transaction.
Points redeemed by the customer on a transaction.
Points available to the customer at the beginning of the transaction.
Points available to the customer at the end of the transaction.
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.
UNIX timestamp of the date and time when the receipt was generated.
Unique receipt number generated for the bill.
The type of receipt. Possible values:
* `tax_invoice`
* `sales_invoice`
* `sales_return_invoice`
* `proforma_invoice`
* `credit_invoice`
* `purchase_invoice`
* `debit_invoice`
* `order_confirmation`
Indicates the delivery type of the receipt. Possible values:
* `digital`
* `print`
* `digital_and_print`
An array of strings representing relevant tags associated with the invoice.
Bar code generated after the transaction. This will be displayed on the digital bill only.
QR code generated after the transaction. This will be displayed on the digital bill only.
POS number of the machine that generated the bill. This is applicable if `business_type` is `retail`.
The type of POS machine. This is applicable if `business_type` is `retail`. Possible values:
* `traditional_pos`
* `kiosk_pos`
Incremental order number of the generated bill.
Order service type of the generated bill. This is applicable if `business_category` is `food_and_beverages`. Possible values:
* `dine_in`
* `take_away`
Order delivery status. This is applicable if `business_type` is `ecommerce`.
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 of the product.
Quantity of the product.
Price of the product.
Type of unit. Possible values:
* `kg`
* `g`
* `mg`
* `lt`
* `ml`
* `pc`
* `cm`
* `m`
* `in`
* `ft`
* `set`
The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments.
The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials.
Product/Item description.
HSN code of the product.
Product/Item code.
Product/Item UID/SKU Code.
Image URL of the product.
Total amount of the product.
Brand name of the product.
Product style.
Colour of the product.
Size of the product in `cm`.
An array of strings representing relevant tags associated with the item.
Unique ID of the employee who sold the product.
This is an array of objects containing details of any additional charges on the item.
Description of the additional charges.
Amount of additional charges.
Percent calculated on total amount.
An array of objects containing the sub-item details of the item.
Name of the sub-item.
Sub-item quantity.
Price of the sub-item.
Type of unit. Possible values:
* `kg`
* `g`
* `mg`
* `lt`
* `ml`
* `pc`
* `cm`
* `m`
* `in`
* `ft`
* `set`
The total weight of the item, including all materials such as metal, stones, diamonds, and other embellishments.
The weight of only the metal used in the item, excluding the weight of any diamonds, stones, or other materials.
Sub-item description.
HSN code of the product.
Sub-item code.
Sub-item UID/SKU Code.
Image URL of the sub-item.
Total amount of the sub-item.
Brand name of the sub-item.
Sub-item style.
Colour of the sub-item.
Size of the sub-item in `cm`.
An array of strings representing relevant tags associated with the sub-item.
This is an array of objects containing details of any additional charges on the item.
Description of the additional charges.
Amount of additional charges.
Percent calculated on total amount.
This is an array of objects containing the details of the taxes incurred.
Name of the tax. For example, CGST, SGST and so on.
Percentage of tax.
Applicable tax calculated on total amount.
This is an array of objects containing the details of the taxes incurred.
Name of the tax. For example, CGST, SGST and so on.
Percentage of tax.
Applicable tax calculated on total amount.
Details of the receipt.
Total product quantity sold in the invoice.
The total amount before taxes, discounts and additional fees are added to the invoice.
The currency of the invoice. Refer to this [sheet](/docs/pos/billme/appendix) for the list of supported currencies.
Total tax amount in paise.
Total tax percentage applied on the receipt.
The total amount payable after adding taxes, discounts and additional fees to the invoice.
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 of the additional charge.
Amount of the additional charge.
Percent calculated on total amount.
Status of the payment. Possible values:
* `pending`
* `authorized`
* `failed`
* `declined`
* `refunded`
* `cancelled`
* `processed`
* `settled`
* `voided`
* `success`
* `paid`
* `unpaid`
Change amount to be returned to the customer if the payment was made in cash.
Change amount to be returned to the customer if the payment was made in cash.
Total percentage of the discount on the sub-total amount without the taxes.
Total value of the discount on the invoice.
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 of the discount.
Amount of the applied discount.
Percentile value of the discounted amount.
Product/Item code.
Product/Item UID/SKU Code.
HSN code of the product.
Reference ID of the discount.
Amount used from the customer's wallet for this transaction.
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 of the tax. For example, CGST, SGST and so on.
Percentage of tax.
Applicable tax calculated on total amount.
Details of the payment.
The mode of payment.
The currency in which the payment was made.
The amount of the payment in paise. For example, if the amount is `1200`. The unit will be `120000`.
The Unique id of the payment method.
Details of the financier.
Unique id of the financier.
Name of the financier.
Details of the event booking. Required if `business_category` is `events`.
Name of the event.
The exact time in seconds when the event starts.
The exact time in seconds when the event ends.
The location/venue of the event.
The specific room where the event was held.
The number of seats booked for the event.
This object contains IRN ( Invoice Reference Number ) related details. If `irn` is present,
qr\_code and irn\_number are required.
Acknowledgement number of the generated IRN.
Acknowledgement date of the generated IRN.
QR code associated with the IRN. Required if IRN is present.
E-invoice IRN. Required if IRN is present.
The link to the receipt.
UNIX timestamp of the date when the bill was generated.