Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Invoices

Entity

API Test Keys

Invoices Entity

The Invoices entity has the following parameters:

Is this page helpful?

Entity

1
{
2
  "id": "inv_E7q0tqkxBRzdau",
3
  "entity": "invoice",
4
  "receipt": null,
5
  "invoice_number": null,
6
  "customer_id": "cust_E7q0trFqXgExmT",
7
  "customer_details": {
8
    "id": "cust_E7q0trFqXgExmT",
9
    "name": "Gaurav Kumar",
10
    "email": "gaurav.kumar@example.com",
11
    "contact": "9876543210",
12
    "billing_address": {
13
      "id": "addr_E7q0ttqh4SGhAC",
14
      "type": "billing_address",
15
      "primary": true,
16
      "line1": "Ground & 1st Floor, SJR Cyber Laskar",
17
      "line2": "Hosur Road",
18
      "zipcode": "560068",
19
      "city": "Bengaluru",
20
      "state": "Karnataka",
21
      "country": "in"
22
    },
23
    "shipping_address": {
24
      "id": "addr_E7q0ttKwVA1h2V",
25
      "type": "shipping_address",
26
      "primary": true,
27
      "line1": "Ground & 1st Floor, SJR Cyber Laskar",
28
      "line2": "Hosur Road",
29
      "zipcode": "560068",
30
      "city": "Bengaluru",
31
      "state": "Karnataka",
32
      "country": "in"
33
    },
34
    "customer_name": "Gaurav Kumar",
35
    "customer_email": "gaurav.kumar@example.com",
36
    "customer_contact": "9876543210"
37
  },
38
  "order_id": "order_E7q0tvRpC0WJwg",
39
  "line_items": [
40
    {
41
      "id": "li_E7q0tuPNg84VbZ",
42
      "item_id": null,
43
      "ref_id": null,
44
      "ref_type": null,
45
      "name": "Master Cloud Computing in 30 Days",
46
      "description": "Book by Ravena Ravenclaw",
47
      "amount": 399,
48
      "unit_amount": 399,
49
      "gross_amount": 399,
50
      "tax_amount": 0,
51
      "taxable_amount": 399,
52
      "net_amount": 399,
53
      "currency": "MYR",
54
      "type": "invoice",
55
      "tax_inclusive": false,
56
      "hsn_code": null,
57
      "sac_code": null,
58
      "tax_rate": null,
59
      "unit": null,
60
      "quantity": 1,
61
      "taxes": []
62
    }
63
  ],
64
  "payment_id": null,
65
  "status": "issued",
66
  "expire_by": null,
67
  "issued_at": 1579765167,
68
  "paid_at": null,
69
  "cancelled_at": null,
70
  "expired_at": null,
71
  "sms_status": "pending",
72
  "email_status": "pending",
73
  "date": 1579765167,
74
  "terms": null,
75
  "partial_payment": false,
76
  "gross_amount": 399,
77
  "tax_amount": 0,
78
  "taxable_amount": 399,
79
  "amount": 399,
80
  "amount_paid": 0,
81
  "amount_due": 399,
82
  "currency": "MYR",
83
  "description": null,
84
  "notes": [],
85
  "comment": null,
86
  "short_url": "https://rzp.io/i/2wxV8Xs",
87
  "view_less": true,
88
  "billing_start": null,
89
  "billing_end": null,
90
  "type": "invoice",
91
  "group_taxes_discounts": false,
92
  "created_at": 1579765167
93
}
id
string

The unique identifier of the invoice.

entity
string

Indicates the type of entity. Here, it is invoice.

type
string

Here, it should be invoice.

invoice_number
string

Unique number you added for internal reference. The minimum character length is 1 and maximum is 40.

customer_id
string

The unique identifier of the customer. You can create customer_id using the

Customers API

. Alternatively, you can pass the customer object described in the below fields.

customer_details
object

Details of the customer.

Show child parameters (6)

order_id
string

The unique identifier of the order associated with the invoice.

line_items
object

Details of the line item that is billed in the invoice. Maximum of 50 line items.

Show child parameters (8)

payment_id
string

Unique identifier of a payment made against this invoice.

status
string

The status of the invoice. Know more about

Invoice States

. Possible values:
  • draft
  • issued
  • partially_paid
  • paid
  • cancelled
  • expired
  • deleted

expire_by
integer

Timestamp, in Unix format, at which the invoice will expire.

issued_at
integer

Timestamp, in Unix format, at which the invoice was issued to the customer.

paid_at
integer

Timestamp, in Unix format, at which the payment was made.

cancelled_at
integer

Timestamp, in Unix format, at which the invoice was cancelled.

expired_at
integer

Timestamp, in Unix format, at which the invoice expired.

sms_status
string

The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

email_status
string

The delivery status of the email notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

partial_payment
boolean

Indicates whether the customer can make a partial payment on the invoice. Possible values:

  • true: The customer can make partial payments.
  • false (default): The customer cannot make partial payments.

amount
integer

Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is MYR 300.00, pass the value as 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

amount_paid
integer

Amount paid by the customer against the invoice.

amount_due
integer

The remaining amount to be paid by the customer for the issued invoice.

currency
string

The currency associated with the invoice. Possible value is MYR.

description
string

A brief description of the invoice. The maximum character length is 2048.

notes
object

Any custom notes added to the invoice. Maximum of 2048 characters.

short_url
string

The short URL that is generated. Share this link with customers to accept payments.

date
integer

Timestamp, in Unix format, that indicates the issue date of the invoice.

terms
string

Any terms to be included in the invoice. Maximum of 2048 characters.

comment
string

Any comments to be added in the invoice. Maximum of 2048 characters.

Invoices Entity

The Invoices entity has the following parameters:

Is this page helpful?

id
string

The unique identifier of the invoice.

entity
string

Indicates the type of entity. Here, it is invoice.

type
string

Here, it should be invoice.

invoice_number
string

Unique number you added for internal reference. The minimum character length is 1 and maximum is 40.

customer_id
string

The unique identifier of the customer. You can create customer_id using the

Customers API

. Alternatively, you can pass the customer object described in the below fields.

customer_details
object

Details of the customer.

Show child parameters (6)

order_id
string

The unique identifier of the order associated with the invoice.

line_items
object

Details of the line item that is billed in the invoice. Maximum of 50 line items.

Show child parameters (8)

payment_id
string

Unique identifier of a payment made against this invoice.

status
string

The status of the invoice. Know more about

Invoice States

. Possible values:
  • draft
  • issued
  • partially_paid
  • paid
  • cancelled
  • expired
  • deleted

expire_by
integer

Timestamp, in Unix format, at which the invoice will expire.

issued_at
integer

Timestamp, in Unix format, at which the invoice was issued to the customer.

paid_at
integer

Timestamp, in Unix format, at which the payment was made.

cancelled_at
integer

Timestamp, in Unix format, at which the invoice was cancelled.

expired_at
integer

Timestamp, in Unix format, at which the invoice expired.

sms_status
string

The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

email_status
string

The delivery status of the email notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

partial_payment
boolean

Indicates whether the customer can make a partial payment on the invoice. Possible values:

  • true: The customer can make partial payments.
  • false (default): The customer cannot make partial payments.

amount
integer

Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is MYR 300.00, pass the value as 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

amount_paid
integer

Amount paid by the customer against the invoice.

amount_due
integer

The remaining amount to be paid by the customer for the issued invoice.

currency
string

The currency associated with the invoice. Possible value is MYR.

description
string

A brief description of the invoice. The maximum character length is 2048.

notes
object

Any custom notes added to the invoice. Maximum of 2048 characters.

short_url
string

The short URL that is generated. Share this link with customers to accept payments.

date
integer

Timestamp, in Unix format, that indicates the issue date of the invoice.

terms
string

Any terms to be included in the invoice. Maximum of 2048 characters.

comment
string

Any comments to be added in the invoice. Maximum of 2048 characters.

Entity

1
{
2
  "id": "inv_E7q0tqkxBRzdau",
3
  "entity": "invoice",
4
  "receipt": null,
5
  "invoice_number": null,
6
  "customer_id": "cust_E7q0trFqXgExmT",
7
  "customer_details": {
8
    "id": "cust_E7q0trFqXgExmT",
9
    "name": "Gaurav Kumar",
10
    "email": "gaurav.kumar@example.com",
11
    "contact": "9876543210",
12
    "billing_address": {
13
      "id": "addr_E7q0ttqh4SGhAC",
14
      "type": "billing_address",
15
      "primary": true,
16
      "line1": "Ground & 1st Floor, SJR Cyber Laskar",
17
      "line2": "Hosur Road",
18
      "zipcode": "560068",
19
      "city": "Bengaluru",
20
      "state": "Karnataka",
21
      "country": "in"
22
    },
23
    "shipping_address": {
24
      "id": "addr_E7q0ttKwVA1h2V",
25
      "type": "shipping_address",
26
      "primary": true,
27
      "line1": "Ground & 1st Floor, SJR Cyber Laskar",
28
      "line2": "Hosur Road",
29
      "zipcode": "560068",
30
      "city": "Bengaluru",
31
      "state": "Karnataka",
32
      "country": "in"
33
    },
34
    "customer_name": "Gaurav Kumar",
35
    "customer_email": "gaurav.kumar@example.com",
36
    "customer_contact": "9876543210"
37
  },
38
  "order_id": "order_E7q0tvRpC0WJwg",
39
  "line_items": [
40
    {
41
      "id": "li_E7q0tuPNg84VbZ",
42
      "item_id": null,
43
      "ref_id": null,
44
      "ref_type": null,
45
      "name": "Master Cloud Computing in 30 Days",
46
      "description": "Book by Ravena Ravenclaw",
47
      "amount": 399,
48
      "unit_amount": 399,
49
      "gross_amount": 399,
50
      "tax_amount": 0,
51
      "taxable_amount": 399,
52
      "net_amount": 399,
53
      "currency": "MYR",
54
      "type": "invoice",
55
      "tax_inclusive": false,
56
      "hsn_code": null,
57
      "sac_code": null,
58
      "tax_rate": null,
59
      "unit": null,
60
      "quantity": 1,
61
      "taxes": []
62
    }
63
  ],
64
  "payment_id": null,
65
  "status": "issued",
66
  "expire_by": null,
67
  "issued_at": 1579765167,
68
  "paid_at": null,
69
  "cancelled_at": null,
70
  "expired_at": null,
71
  "sms_status": "pending",
72
  "email_status": "pending",
73
  "date": 1579765167,
74
  "terms": null,
75
  "partial_payment": false,
76
  "gross_amount": 399,
77
  "tax_amount": 0,
78
  "taxable_amount": 399,
79
  "amount": 399,
80
  "amount_paid": 0,
81
  "amount_due": 399,
82
  "currency": "MYR",
83
  "description": null,
84
  "notes": [],
85
  "comment": null,
86
  "short_url": "https://rzp.io/i/2wxV8Xs",
87
  "view_less": true,
88
  "billing_start": null,
89
  "billing_end": null,
90
  "type": "invoice",
91
  "group_taxes_discounts": false,
92
  "created_at": 1579765167
93
}