ChargebeeAPI

Einvoices

Represents the e-invoice record associated with an invoice, including its processing status, reference number (such as one assigned by the IRP), and related status messages.

API Index URL

https://[site].chargebee.com/api/v2/einvoices

Einvoices attributes

id
required, string, max chars=50

The unique id for the e-invoice. This is auto-generated by Chargebee.

reference_number
optional, string, max chars=100

This attribute is used to populate the unique reference number assigned to an invoice on the Invoice Registration Portal (IRP) network. It is essential for identifying and tracking invoices that are processed through the IRP network.

In the future, this field may be used to store similar reference numbers for other networks.

status
required, enumerated string

The status of processing the e-invoice. To obtain detailed information about the current status, see message.

Possible Enum Values
scheduled

Sending the e-invoice to the customer has been scheduled.

skipped

The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.

in_progress

The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.

success

The e-invoice has been successfully delivered to the customer.

failed

The e-invoice was sent and there was an error due to which it was not delivered.

message
optional, string, max chars=250

Detailed information about the status of the e-invoice. When status is skipped or failed, this contains the reason or error details. The following are some valid examples:

  • Invoice successfully sent to customer via the e-invoicing network 9090:123456
  • Invoice successfully sent to customer via email id abc@acme.com