Create credit
In the tebio Business Portal, credit notes (often referred to as invoice corrections in accounting terms) are not typed as isolated free text documents, but are always based on a comprehensible system process. This ensures the audit security (Append Only) of the platform.
To create a credit note for a customer, you must differentiate between two different scenarios:
Scenario 1: Complete cancellation of an existing invoice
Section titled “Scenario 1: Complete cancellation of an existing invoice”This scenario applies if an invoice generated by the system is incorrect (e.g. incorrect product price billed or incorrect customer address at the time of the bill run).
- When the entire claim of a specific invoice needs to be canceled.
- You want to create the invoice again and without errors after correcting the master data.
Procedure and result
Section titled “Procedure and result”You cannot edit or delete the invoice in question. Instead, cancel the document. At the moment of cancellation, the system automatically generates a correct counter-document - an invoice correction (credit note) - which exactly offsets the original amount. You can find detailed step-by-step instructions in the article Cancel invoice.
Scenario 2: Create a one-time goodwill credit (OCC).
Section titled “Scenario 2: Create a one-time goodwill credit (OCC).”This scenario applies if you want to credit the customer with a flexible amount that is independent of the cancellation of a complete invoice. The platform uses the OCC (One-time Charge/Credit) instrument for this purpose.
When do I use this scenario?
Section titled “When do I use this scenario?”- When you grant goodwill credits (e.g. after a complaint).
- If you want to compensate for downtime or SLA violations.
- If you want to give the customer a one-time bonus.
Procedure
Section titled “Procedure”- Navigate to the customer profile of the relevant customer via the main menu.
- Switch to the Invoices tab within the customer profile.
- Look for the button to create a new OCC (One-time Charge/Credit).
- Fill out the form:
- Type: Be sure to select Credit here (and not Charge/Fee).
- Amount & Currency: Enter the desired gross or net amount.
- Tax Category: Select the appropriate tax category for the correct tax treatment of the credit.
- Description: Formulate a meaningful text (e.g. “Goodwill credit for default on May 1st.”). Attention: This text will later be visible to the customer on the invoice document.
- Application Date: Determines when the credit will take effect in the system.
- Save the process.
Result
Section titled “Result”The one-time credit is now deposited in the customer account (subscription). During the next regular Billrun (billing run), the system will use this credit and automatically offset the amount against the fees due. The credit is then shown as a separate item on the invoice document or - if the credit exceeds the new claims - sent as a separate credit document.
Result
Section titled “Result”The action was successfully carried out in the system and the overview updates accordingly.
API Notes
Section titled “API Notes”If you would like to trigger credits from third-party systems:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v2/billing/occ | POST | Creates a new OCC (credit or charge) on a subscription. | createOcc |
/v2/billing/invoice/{invoiceUuid}/cancel | POST | Cancels a final invoice and automatically generates the credit voucher document. | cancelInvoice |