Invoices
Invoices, representing the transactional records of purchases made by customers, are automatically generated either when a customer completes an order through your checkout flows, Tamio Sites, automations or created manually in the Tamio dashboard. Each invoice is paired with a corresponding data object, encapsulating an array of information. This encompasses details of the payment method, customer data, applied taxes, any discounts used, and the specific products that constitute the purchase.
- The prefix and numbering of your invoices can be customised at the account level inside the Tamio dashboard.
- You can create one-off and recurring invoices directly inside the Tamio Dashboard.
You can execute various actions on an invoice, including processing refunds, adding tracking numbers, and marking items as shipped. The available actions for each invoice depend on factors such as its type, the payment method opted by the customer, and the nature of the products purchased.
All invoices undergo a lifecycle commencing from the point of generation and culminating when no further action can be taken on them. The progression of an invoice through this lifecycle is guided by its status.
Status | Description |
|---|---|
awaiting payment | The invoice is awaiting payment confirmation (manual or automated) |
pending | An order has been placed and requires the merchant's attention (approve or decline) |
new | A customer has placed a new order via checkout or a new custom invoice has been created. |
refunded, reversed | The invoice has been refunded in full. |
partially refunded | The invoice has been refunded in part. |
authorized | A payment for the invoice has been authorized, but has not been captured. |
done | The invoice has completed its lifecycle, and it can only be removed. |
partially paid | The invoice represents an instalment plan, and it is paid in part. |
completed | The invoice represents an instalment plan, and it is paid in full. |
failed, voided | All payment attempts for this invoice have failed. |
Description | Method | URL |
|---|---|---|
GET | /v2/invoices/retrieve/:id | |
POST | /v2/invoices/mark-paid/:id | |
DELETE | /v2/invoices/:id | |
POST | /v2/invoices/mark-shipped/:id | |
POST | /v2/invoices/refund/:id | |
POST | /v2/invoices/affiliate-commission/:id | |
POST | /v2/invoices/bulk/delete | |
POST | /v2/invoices/cancel/:id | |
GET | /v2/invoices/list | |
GET | /v2/invoices/upcoming/:id |
There are six webhook notification events associated with the Invoices API.
- invoice-created
- invoice-payment-confirmed
- invoice-refunded
- invoice-approved
- invoice-declined
- invoice-updated
You can see examples of notification events here:
Whether managing teammates or creating API developer keys, you can customise permissions when accessing Invoices API resources. The default set of Invoice permissions are view, edit, create and remove.
Each invoice generated by the Tamio system is accompanied by a corresponding PDF file. This digital invoice copy is automatically forwarded to the customer following their purchase, as well as during any updates concerning their order. For instance, when a refund is initiated, the updated invoice is promptly sent. Within Tamio's framework, we offer three different invoice templates that you can preview directly within your dashboard interface.
Do note that while Tamio allows you the flexibility to disable the automatic sending of customer invoices, it is essential to first verify the legal stipulations in your operating jurisdiction. Legal requirements for invoice delivery can vary widely, and non-compliance can lead to penalties.
In the field of accounting, the practice of reversing invoices, also known as "Storno," is common. Tamio fully supports this operation, enabling you to effectively reverse an original invoice by applying negative numbers. Such a reversal may be necessary if the goods or services have not been provided as promised or if an invoice has inadvertently been issued to the incorrect customer.