Skip to content

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 ​

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 ​

PropertyTypeRequiredDescription
creditorstringYesCreditor ID
casestringYes*Case ID to cancel (mutually exclusive with invoice_number)
invoice_numberstringYes*Invoice number to resolve case (mutually exclusive with case)
file_import_reportstringNo**File import report ID (readonly, set by system during file imports)
originstringYesOrigin of request (must be "creditor_system")***

Response Properties ​

PropertyTypeRequiredDescription
_idstringYesUnique identifier for the cancellation
_createdstringYesCreation timestamp (RFC 1123 format)
_updatedstringYesLast update timestamp (RFC 1123 format)
_etagstringYesEntity tag for concurrency control
_statusstringYesRequest status (e.g. "OK")***
_cancellation_statusstringYesCancellation process status (e.g. "completed")***
statusstringNoProcessing status: "completed" or "warning" (no "error" status)
status_reason_localestringNoLocale key for status reason message
case_invoice_numberstringNoInvoice number from the case (projection, not same as input field)
case_reference_numberstringNoCase 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