Introduction#
The Invoices API enables you to create and manage invoices for your collections. Each invoice represents a payment request with specific details about the payer, amount, and beneficiaries.Understanding Invoice States#
Invoices in our system can exist in three states:Status | Description | Possible Transitions |
---|
Unpaid | Initial state when invoice is created | → Paid, → Invalidated |
Paid | Successfully paid invoice | None (Terminal State) |
Invalidated | Manually invalidated or expired invoice | None (Terminal State) |
State Transition Rules#
Only unpaid invoices can be invalidated
Once an invoice is paid or invalidated, its state cannot be changed
Payment can only be processed for invoices in the Unpaid state
Modified at 2024-10-31 05:31:05