API Test Keys

Bills Entity

The Bills entity has the following parameters:

Is this page helpful?

Entity

1{
2  "id": "bill_PYamApGCFTAjkh",
3  "business_type": "retail",
4  "business_category": "retail_and_consumer_goods",
5  "customer": {
6    "contact": "9876543210",
7    "name": "Gaurav Kumar",
8    "email": "",
9    "customer_id": "",
10    "date_of_birth": "",
11    "profession": "",
12    "company_name": "",
13    "marital_status": "",
14    "spouse_name": "",
15    "anniversary_date": "",
16    "gender": "",
17    "gstin": "",
18    "billing_address": null,
19    "shipping_address": null
20  },
21  "loyalty": null,
22  "store_code": "JK-001",
23  "receipt_timestamp": 1722664800,
24  "receipt_number": "INV001250013",
25  "receipt_type": "tax_invoice",
26  "receipt_delivery": "digital",
27  "bar_code_number": "3412",
28  "qr_code_number": "T2322 00000009291",
29  "billing_pos_number": "bn",
30  "pos_category": "traditional_pos",
31  "order_number": "ORD213",
32  "order_service_type": "",
33  "delivery_status_url": "",
34  "cashier_name": "Saurav Kumar",
35  "cashier_code": "123",
36  "line_items": [
37    {
38      "name": "Acme Soap",
39      "quantity": 1,
40      "unit_amount": 10000,
41      "unit": "pc",
42      "description": "",
43      "hsn_code": "HC2000INCLT",
44      "product_code": "DRCO38",
45      "product_uid": "",
46      "image_url": "",
47      "discount_description": "",
48      "total_amount": 10000,
49      "brand": "",
50      "style": "",
51      "colour": "",
52      "size": "",
53      "financier_data": null,
54      "taxes": [
55        {
56          "name": "CGST",
57          "percentage": 10,
58          "amount": 1000
59        },
60        {
61          "name": "SGST",
62          "percentage": 10,
63          "amount": 1000
64        }
65      ],
66      "tags": [
67        "noise cancelling",
68        "limited edition"
69      ],
70      "sub_items": [
71        {
72          "name": "Advanced Edition",
73          "quantity": 1,
74          "unit_amount": 0,
75          "unit": "pc",
76          "description": "",
77          "hsn_code": "",
78          "product_code": "",
79          "product_uid": "",
80          "image_url": "",
81          "discount_description": "",
82          "total_amount": 10,
83          "brand": "",
84          "style": "",
85          "colour": "",
86          "size": "",
87          "taxes": [],
88          "tags": []
89        }
90      ]
91    },
92    {
93      "name": "Acme Earphones",
94      "quantity": 1,
95      "unit_amount": 80000,
96      "unit": "pc",
97      "description": "",
98      "hsn_code": "HC2000INPPLT",
99      "product_code": "POPLT281",
100      "product_uid": "",
101      "image_url": "",
102      "discount_description": "",
103      "total_amount": 80000,
104      "brand": "",
105      "style": "",
106      "colour": "",
107      "size": "",
108      "financier_data": null,
109      "taxes": [
110        {
111          "name": "CGST",
112          "percentage": 10,
113          "amount": 8000
114        },
115        {
116          "name": "SGST",
117          "percentage": 10,
118          "amount": 8000
119        }
120      ],
121      "tags": [],
122      "sub_items": []
123    }
124  ],
125  "receipt_summary": {
126    "total_quantity": 2,
127    "sub_total_amount": 150000,
128    "currency": "INR",
129    "net_payable_amount": 187500,
130    "payment_status": "success",
131    "delivery_charges": 0,
132    "cod_charges": 0,
133    "change_amount": 0,
134    "roundup_amount": 0,
135    "total_discount_percent": 0,
136    "total_discount_amount": 0,
137    "discounts": [
138      {
139        "name": "none",
140        "amount": 0,
141        "percent": 10
142      }
143    ],
144    "used_wallet_amount": 0,
145    "total_tax_amount": 37500,
146    "total_tax_percent": 25
147  },
148  "taxes": [
149    {
150      "name": "CGST",
151      "percentage": 10,
152      "amount": 150
153    },
154    {
155      "name": "SGST",
156      "percentage": 10,
157      "amount": 150
158    },
159    {
160      "name": "cess",
161      "percentage": 5,
162      "amount": 75
163    }
164  ],
165  "payments": [
166    {
167      "method": "paytm",
168      "currency": "INR",
169      "amount": 90000,
170      "payment_reference_id": "",
171      "financier_data": {
172        "reference": "",
173        "name": "v"
174      }
175    }
176  ],
177  "event": null,
178  "receipt_url": "yourbill.me/PYamApGCFTAjkh",
179  "created_at": 1722664800,
180  "tags": [
181    "noise cancelling",
182    "limited edition"
183  ]
184}

id

string

Unique id of the bill generated.

business_type

string

The type of business. Possible values:

ecommerce
retail

business_category

string

The category the business falls under. Possible values:

events
food_and_beverages
retail_and_consumer_goods
other_services

customer

object

Details of the customer. Required if receipt mode is digital or digital_and_print.

Show child parameters (16)

loyalty

object

Customer loyalty details.

Show child parameters (9)

store_code

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

integer

UNIX timestamp of the date and time when the receipt was generated.

receipt_number

string

Unique receipt number generated for the bill.

receipt_type

string

The type of receipt. Possible values:

tax_invoice
sales_invoice
sales_return_invoice
proforma_invoice
credit_invoice
purchase_invoice
debit_invoice

receipt_delivery

string

Indicates the delivery type of the receipt. Possible values:

digital
print
digital_and_print

tags

array

An array of strings representing relevant tags associated with the invoice.

bar_code_number

integer

Bar code generated after the transaction. This will be displayed on the digital bill only.

qr_code_number

integer

QR code generated after the transaction. This will be displayed on the digital bill only.

billing_pos_number

string

POS number of the machine that generated the bill. This is applicable if business_type is retail.

pos_category

string

The type of POS machine. This is applicable if business_type is retail. Possible values:

traditional_pos
kiosk_pos

order_number

string

Incremental order number of the generated bill.

order_service_type

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

string

Order delivery status. This is applicable if business_type is ecommerce.

cashier_name

string

Name of the cashier that billed the order. This is applicable if business_type is retail.

cashier_code

string

The unique id of the cashier that billed the order. This is applicable if business_type is retail.

line_items

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.

Show child parameters (19)

receipt_summary

object

Details of the receipt.

Show child parameters (15)

taxes

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.

Show child parameters (3)

payments

object

Details of the payment.

Show child parameters (5)

event

object

Details of the event booking. Required if business_category is events.

Show child parameters (6)

receipt_url

string

The link to the receipt.

created_at

integer

UNIX timestamp of the date when the bill was generated.

Bills Entity

The Bills entity has the following parameters:

Is this page helpful?

id

string

Unique id of the bill generated.

business_type

string

The type of business. Possible values:

ecommerce
retail

business_category

string

The category the business falls under. Possible values:

events
food_and_beverages
retail_and_consumer_goods
other_services

customer

object

Details of the customer. Required if receipt mode is digital or digital_and_print.

Show child parameters (16)

loyalty

object

Customer loyalty details.

Show child parameters (9)

store_code

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

integer

UNIX timestamp of the date and time when the receipt was generated.

receipt_number

string

Unique receipt number generated for the bill.

receipt_type

string

The type of receipt. Possible values:

tax_invoice
sales_invoice
sales_return_invoice
proforma_invoice
credit_invoice
purchase_invoice
debit_invoice

receipt_delivery

string

Indicates the delivery type of the receipt. Possible values:

digital
print
digital_and_print

tags

array

An array of strings representing relevant tags associated with the invoice.

bar_code_number

integer

Bar code generated after the transaction. This will be displayed on the digital bill only.

qr_code_number

integer

QR code generated after the transaction. This will be displayed on the digital bill only.

billing_pos_number

string

POS number of the machine that generated the bill. This is applicable if business_type is retail.

pos_category

string

The type of POS machine. This is applicable if business_type is retail. Possible values:

traditional_pos
kiosk_pos

order_number

string

Incremental order number of the generated bill.

order_service_type

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

string

Order delivery status. This is applicable if business_type is ecommerce.

cashier_name

string

Name of the cashier that billed the order. This is applicable if business_type is retail.

cashier_code

string

The unique id of the cashier that billed the order. This is applicable if business_type is retail.

line_items

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.

Show child parameters (19)

receipt_summary

object

Details of the receipt.

Show child parameters (15)

taxes

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.

Show child parameters (3)

payments

object

Details of the payment.

Show child parameters (5)

event

object

Details of the event booking. Required if business_category is events.

Show child parameters (6)

receipt_url

string

The link to the receipt.

created_at

integer

UNIX timestamp of the date when the bill was generated.

Entity

1{
2  "id": "bill_PYamApGCFTAjkh",
3  "business_type": "retail",
4  "business_category": "retail_and_consumer_goods",
5  "customer": {
6    "contact": "9876543210",
7    "name": "Gaurav Kumar",
8    "email": "",
9    "customer_id": "",
10    "date_of_birth": "",
11    "profession": "",
12    "company_name": "",
13    "marital_status": "",
14    "spouse_name": "",
15    "anniversary_date": "",
16    "gender": "",
17    "gstin": "",
18    "billing_address": null,
19    "shipping_address": null
20  },
21  "loyalty": null,
22  "store_code": "JK-001",
23  "receipt_timestamp": 1722664800,
24  "receipt_number": "INV001250013",
25  "receipt_type": "tax_invoice",
26  "receipt_delivery": "digital",
27  "bar_code_number": "3412",
28  "qr_code_number": "T2322 00000009291",
29  "billing_pos_number": "bn",
30  "pos_category": "traditional_pos",
31  "order_number": "ORD213",
32  "order_service_type": "",
33  "delivery_status_url": "",
34  "cashier_name": "Saurav Kumar",
35  "cashier_code": "123",
36  "line_items": [
37    {
38      "name": "Acme Soap",
39      "quantity": 1,
40      "unit_amount": 10000,
41      "unit": "pc",
42      "description": "",
43      "hsn_code": "HC2000INCLT",
44      "product_code": "DRCO38",
45      "product_uid": "",
46      "image_url": "",
47      "discount_description": "",
48      "total_amount": 10000,
49      "brand": "",
50      "style": "",
51      "colour": "",
52      "size": "",
53      "financier_data": null,
54      "taxes": [
55        {
56          "name": "CGST",
57          "percentage": 10,
58          "amount": 1000
59        },
60        {
61          "name": "SGST",
62          "percentage": 10,
63          "amount": 1000
64        }
65      ],
66      "tags": [
67        "noise cancelling",
68        "limited edition"
69      ],
70      "sub_items": [
71        {
72          "name": "Advanced Edition",
73          "quantity": 1,
74          "unit_amount": 0,
75          "unit": "pc",
76          "description": "",
77          "hsn_code": "",
78          "product_code": "",
79          "product_uid": "",
80          "image_url": "",
81          "discount_description": "",
82          "total_amount": 10,
83          "brand": "",
84          "style": "",
85          "colour": "",
86          "size": "",
87          "taxes": [],
88          "tags": []
89        }
90      ]
91    },
92    {
93      "name": "Acme Earphones",
94      "quantity": 1,
95      "unit_amount": 80000,
96      "unit": "pc",
97      "description": "",
98      "hsn_code": "HC2000INPPLT",
99      "product_code": "POPLT281",
100      "product_uid": "",
101      "image_url": "",
102      "discount_description": "",
103      "total_amount": 80000,
104      "brand": "",
105      "style": "",
106      "colour": "",
107      "size": "",
108      "financier_data": null,
109      "taxes": [
110        {
111          "name": "CGST",
112          "percentage": 10,
113          "amount": 8000
114        },
115        {
116          "name": "SGST",
117          "percentage": 10,
118          "amount": 8000
119        }
120      ],
121      "tags": [],
122      "sub_items": []
123    }
124  ],
125  "receipt_summary": {
126    "total_quantity": 2,
127    "sub_total_amount": 150000,
128    "currency": "INR",
129    "net_payable_amount": 187500,
130    "payment_status": "success",
131    "delivery_charges": 0,
132    "cod_charges": 0,
133    "change_amount": 0,
134    "roundup_amount": 0,
135    "total_discount_percent": 0,
136    "total_discount_amount": 0,
137    "discounts": [
138      {
139        "name": "none",
140        "amount": 0,
141        "percent": 10
142      }
143    ],
144    "used_wallet_amount": 0,
145    "total_tax_amount": 37500,
146    "total_tax_percent": 25
147  },
148  "taxes": [
149    {
150      "name": "CGST",
151      "percentage": 10,
152      "amount": 150
153    },
154    {
155      "name": "SGST",
156      "percentage": 10,
157      "amount": 150
158    },
159    {
160      "name": "cess",
161      "percentage": 5,
162      "amount": 75
163    }
164  ],
165  "payments": [
166    {
167      "method": "paytm",
168      "currency": "INR",
169      "amount": 90000,
170      "payment_reference_id": "",
171      "financier_data": {
172        "reference": "",
173        "name": "v"
174      }
175    }
176  ],
177  "event": null,
178  "receipt_url": "yourbill.me/PYamApGCFTAjkh",
179  "created_at": 1722664800,
180  "tags": [
181    "noise cancelling",
182    "limited edition"
183  ]
184}