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  "line_items": [
35    {
36      "name": "Acme Soap",
37      "quantity": 1,
38      "unit_amount": 10000,
39      "unit": "pc",
40      "description": "",
41      "hsn_code": "HC2000INCLT",
42      "product_code": "DRCO38",
43      "product_uid": "",
44      "image_url": "",
45      "total_amount": 10000,
46      "brand": "",
47      "style": "",
48      "colour": "",
49      "size": "",
50      "financier_data": null,
51      "taxes": [
52        {
53          "name": "CGST",
54          "percentage": 10,
55          "amount": 1000
56        },
57        {
58          "name": "SGST",
59          "percentage": 10,
60          "amount": 1000
61        }
62      ],
63      "tags": [
64        "noise cancelling",
65        "limited edition"
66      ],
67      "sub_items": [
68        {
69          "name": "Advanced Edition",
70          "quantity": 1,
71          "unit_amount": 0,
72          "unit": "pc",
73          "description": "",
74          "hsn_code": "",
75          "product_code": "",
76          "product_uid": "",
77          "image_url": "",
78          "total_amount": 10,
79          "brand": "",
80          "style": "",
81          "colour": "",
82          "size": "",
83          "taxes": [],
84          "tags": []
85        }
86      ]
87    },
88    {
89      "name": "Acme Earphones",
90      "quantity": 1,
91      "unit_amount": 80000,
92      "unit": "pc",
93      "description": "",
94      "hsn_code": "HC2000INPPLT",
95      "product_code": "POPLT281",
96      "product_uid": "",
97      "image_url": "",
98      "total_amount": 80000,
99      "brand": "",
100      "style": "",
101      "colour": "",
102      "size": "",
103      "financier_data": null,
104      "taxes": [
105        {
106          "name": "CGST",
107          "percentage": 10,
108          "amount": 8000
109        },
110        {
111          "name": "SGST",
112          "percentage": 10,
113          "amount": 8000
114        }
115      ],
116      "tags": [],
117      "sub_items": []
118    }
119  ],
120  "receipt_summary": {
121    "total_quantity": 2,
122    "sub_total_amount": 150000,
123    "currency": "INR",
124    "net_payable_amount": 187500,
125    "payment_status": "success",
126    "delivery_charges": 0,
127    "cod_charges": 0,
128    "change_amount": 0,
129    "roundup_amount": 0,
130    "total_discount_percent": 0,
131    "total_discount_amount": 0,
132    "discounts": [
133      {
134        "name": "none",
135        "amount": 0,
136        "percent": 10
137      }
138    ],
139    "used_wallet_amount": 0,
140    "total_tax_amount": 37500,
141    "total_tax_percent": 25
142  },
143  "taxes": [
144    {
145      "name": "CGST",
146      "percentage": 10,
147      "amount": 150
148    },
149    {
150      "name": "SGST",
151      "percentage": 10,
152      "amount": 150
153    },
154    {
155      "name": "cess",
156      "percentage": 5,
157      "amount": 75
158    }
159  ],
160  "payments": [
161    {
162      "method": "paytm",
163      "currency": "INR",
164      "amount": 90000,
165      "payment_reference_id": "",
166      "financier_data": {
167        "reference": "",
168        "name": "v"
169      }
170    }
171  ],
172  "event": null,
173  "receipt_url": "yourbill.me/PYamApGCFTAjkh",
174  "created_at": 1722664800,
175  "tags": [
176    "noise cancelling",
177    "limited edition"
178  ]
179}

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 (17)

employee

object

This is an array of objects containing details of the employees associated with the receipt.

Show child parameters (3)

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
order_confirmation

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.

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 (20)

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)

irn

object

This object contains IRN ( Invoice Reference Number ) related details. If irn is present, qr_code and irn_number are required.

Show child parameters (4)

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 (17)

employee

object

This is an array of objects containing details of the employees associated with the receipt.

Show child parameters (3)

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
order_confirmation

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.

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 (20)

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)

irn

object

This object contains IRN ( Invoice Reference Number ) related details. If irn is present, qr_code and irn_number are required.

Show child parameters (4)

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  "line_items": [
35    {
36      "name": "Acme Soap",
37      "quantity": 1,
38      "unit_amount": 10000,
39      "unit": "pc",
40      "description": "",
41      "hsn_code": "HC2000INCLT",
42      "product_code": "DRCO38",
43      "product_uid": "",
44      "image_url": "",
45      "total_amount": 10000,
46      "brand": "",
47      "style": "",
48      "colour": "",
49      "size": "",
50      "financier_data": null,
51      "taxes": [
52        {
53          "name": "CGST",
54          "percentage": 10,
55          "amount": 1000
56        },
57        {
58          "name": "SGST",
59          "percentage": 10,
60          "amount": 1000
61        }
62      ],
63      "tags": [
64        "noise cancelling",
65        "limited edition"
66      ],
67      "sub_items": [
68        {
69          "name": "Advanced Edition",
70          "quantity": 1,
71          "unit_amount": 0,
72          "unit": "pc",
73          "description": "",
74          "hsn_code": "",
75          "product_code": "",
76          "product_uid": "",
77          "image_url": "",
78          "total_amount": 10,
79          "brand": "",
80          "style": "",
81          "colour": "",
82          "size": "",
83          "taxes": [],
84          "tags": []
85        }
86      ]
87    },
88    {
89      "name": "Acme Earphones",
90      "quantity": 1,
91      "unit_amount": 80000,
92      "unit": "pc",
93      "description": "",
94      "hsn_code": "HC2000INPPLT",
95      "product_code": "POPLT281",
96      "product_uid": "",
97      "image_url": "",
98      "total_amount": 80000,
99      "brand": "",
100      "style": "",
101      "colour": "",
102      "size": "",
103      "financier_data": null,
104      "taxes": [
105        {
106          "name": "CGST",
107          "percentage": 10,
108          "amount": 8000
109        },
110        {
111          "name": "SGST",
112          "percentage": 10,
113          "amount": 8000
114        }
115      ],
116      "tags": [],
117      "sub_items": []
118    }
119  ],
120  "receipt_summary": {
121    "total_quantity": 2,
122    "sub_total_amount": 150000,
123    "currency": "INR",
124    "net_payable_amount": 187500,
125    "payment_status": "success",
126    "delivery_charges": 0,
127    "cod_charges": 0,
128    "change_amount": 0,
129    "roundup_amount": 0,
130    "total_discount_percent": 0,
131    "total_discount_amount": 0,
132    "discounts": [
133      {
134        "name": "none",
135        "amount": 0,
136        "percent": 10
137      }
138    ],
139    "used_wallet_amount": 0,
140    "total_tax_amount": 37500,
141    "total_tax_percent": 25
142  },
143  "taxes": [
144    {
145      "name": "CGST",
146      "percentage": 10,
147      "amount": 150
148    },
149    {
150      "name": "SGST",
151      "percentage": 10,
152      "amount": 150
153    },
154    {
155      "name": "cess",
156      "percentage": 5,
157      "amount": 75
158    }
159  ],
160  "payments": [
161    {
162      "method": "paytm",
163      "currency": "INR",
164      "amount": 90000,
165      "payment_reference_id": "",
166      "financier_data": {
167        "reference": "",
168        "name": "v"
169      }
170    }
171  ],
172  "event": null,
173  "receipt_url": "yourbill.me/PYamApGCFTAjkh",
174  "created_at": 1722664800,
175  "tags": [
176    "noise cancelling",
177    "limited edition"
178  ]
179}