Creditor Cancellation
Cancel cases or invoices in the Amili system. Used by creditors to stop further processing of a case or invoice.
Creditor Cancellation endpoints
GET /creditor--cancellations- List all cancellations (paginated)GET /creditor--cancellations/{id}- Get a specific cancellationPOST /creditor--cancellations- Create a cancellation request
See Case for accessing the cases that can be cancelled.
Examples
For working code examples and detailed usage guides, see Creditor Case Actions.
For complete API specification with interactive testing, see Swagger: Creditor Cancellation.
Parameters
Request Body Properties
| Property | Type | Required | Description |
|---|---|---|---|
creditor | string | Yes | Creditor ID |
case | string | Yes* | Case ID to cancel (mutually exclusive with invoice_number) |
invoice_number | string | Yes* | Invoice number to resolve case (mutually exclusive with case) |
file_import_report | string | No** | File import report ID (readonly, set by system during file imports) |
origin | string | Yes | Origin of request (must be "creditor_system")*** |
Response Properties
| Property | Type | Required | Description |
|---|---|---|---|
_id | string | Yes | Unique identifier for the cancellation |
_created | string | Yes | Creation timestamp (RFC 1123 format) |
_updated | string | Yes | Last update timestamp (RFC 1123 format) |
_etag | string | Yes | Entity tag for concurrency control |
_status | string | Yes | Request status (e.g. "OK")*** |
_cancellation_status | string | Yes | Cancellation process status (e.g. "completed")*** |
status | string | No | Processing status: "completed" or "warning" (no "error" status) |
status_reason_locale | string | No | Locale key for status reason message |
case_invoice_number | string | No | Invoice number from the case (projection, not same as input field) |
case_reference_number | string | No | Case reference number |
*) Either case OR invoice_number must be provided, but not both
**) Readonly fields automatically set by the system
***) For complete list of values and details, please see Creditor Cancellation
