Learn about the lifecycle of a return in Numeral
Events are created as returns are created or updated in Numeral. An update can be the update of any attribute, such as a status, a date, or any other data. Learn more about events and webhooks in Numeral.
Events
| Event | Description |
|---|---|
| pending_approval | Return has been created and is pending approval. |
| approved | Return has been approved. |
| auto_approved | Return has been automatically approved. |
| canceled | Return has been canceled. |
| processing | Return is being processed and has been added to a file. |
| sent | Return has been sent to the bank. |
| executed | Return has been executed by the bank. |
| received | Return has been received from the bank. |
| rejected | Return has been rejected. |
| pending_retry | Return file file has been rejected by the bank. The return will be sent in a new file. |
| retried | Return has been sent in a new file. |
| reconciled | Return has been reconciled with a transaction. |
| partially_reconciled | Return has been partially reconciled with a transaction. |
| unreconciled | Return has been unreconciled. |
Statuses
| Status | Description |
|---|---|
| pending_approval | Return has been created and is pending approval. |
| approved | Return has been approved. |
| auto_approved | Return has been automatically approved. |
| canceled | Return has been canceled. |
| processing | Return is being processed and has been added to a file. |
| sent | Return has been sent to the bank. |
| executed | Return has been executed by the bank. |
| received | Return has been received from the bank. This is the initial status for a return linked to a payment order. |
| rejected | Return has been rejected. |
State machine
