Context
If you need to invoice an item to a customer outside the context of their subscription (e.g., billing for an exceptional service, offering a commercial gesture, etc.), you can add a line item to the customer’s balance. Once created, the line item will be processed in the next regular billing cycle.
Note: If you don’t want to wait for the next billing cycle, you also have the option to force the generation of an invoice.
Prerequisites
To make it work, you need to have:
- An active customer.
Procedure
1/ Create a line item in the balance
Example request
POST https://api-{IdBusiness}.proabono.com/v1/BalanceLine
{
"ReferenceCustomer": "{ReferenceCustomer}",
"Label": "Service XYZ",
"Amount": 50000,
"Quantity": 18
}
Attention! The specified amount should be in cents.
Note: You can enter a positive or negative amount in the “Amount” field. This allows you to create a debit or credit line item.
For more details, refer to the dedicated documentation.
2/ (optional) Force the invoice collection
Example request
POST https://api-{IdBusiness}.proabono.com/v1/Billing/Customer
{
"ReferenceCustomer": "{ReferenceCustomer}",
"NoteLocalized" : "unique invoice for Service XYZ"
}
Note: If you add information in the NoteLocalized field, a note will be added at the bottom of the PDF invoice (just above the “Customer Service” section).
For more details, refer to the dedicated documentation.