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 cancellation
POST /creditor--cancellations - Create a cancellation request

See Case for accessing the cases that can be cancelled.

Example Request

Below is an example of cancelling an existing case.

URL: POST /creditor--cancellations

Headers:

x-api-key: {your_access_token}
Content-Type: application/json

Request Body:

json

{
  "creditor": "674dbeb208847b9501cc9138",
  "case": "68678eda88b9226bb78d7169",
  "origin": "creditor_system"
}

Response Code: 201 Created

Response Body:

json

{
  "_updated": "Fri, 04 Jul 2025 14:39:21 GMT",
  "_created": "Fri, 04 Jul 2025 14:39:21 GMT",
  "_etag": "3fffb8089c7de1cafe5001182786108c4005c22a",
  "_id": "6867e7991a9d6cdeb9f73c54",
  "_status": "OK",
  "_cancellation_status": "completed"
}

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

Creditor Cancellation ​