Skip to content

Creditor Cancellation

Avboka Cases eller Invoices i Amili-systemet. Används av Creditors för att stoppa vidare bearbetning av ett Case eller en Invoice.

Creditor Cancellation endpoints

Se Case för att få åtkomst till Cases som kan avbokas.

Exempel Request

Nedan är ett exempel på att avboka ett befintligt 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"
}

Parametrar

Request Body Properties

PropertyTypObligatoriskBeskrivning
creditorstringJaCreditor ID
casestringJa*Case ID att avboka (ömsesidigt uteslutande med invoice_number)
invoice_numberstringJa*Invoice number för att lösa case (ömsesidigt uteslutande med case)
file_import_reportstringNej**File import report ID (readonly, sätts av systemet vid filimporter)
originstringJaUrsprung för request (måste vara "creditor_system")***

Response Properties

PropertyTypObligatoriskBeskrivning
_idstringJaUnik identifierare för cancellation
_createdstringJaSkapandetidsstämpel (RFC 1123 format)
_updatedstringJaSenaste uppdateringstidsstämpel (RFC 1123 format)
_etagstringJaEntity tag för samtidighetskontroll
_statusstringJaRequest-status (t.ex. "OK")***
_cancellation_statusstringJaCancellation-processstatus (t.ex. "completed")***
statusstringNejBearbetningsstatus: "completed" eller "warning" (ingen "error"-status)
status_reason_localestringNejLocale-nyckel för statusorsaksmeddelande
case_invoice_numberstringNejInvoice number från case (projektion, inte samma som inmatningsfält)
case_reference_numberstringNejCase reference number

*) Antingen case ELLER invoice_number måste anges, men inte båda

**) Readonly-fält som sätts automatiskt av systemet

***) För komplett lista över värden och detaljer, se Creditor Cancellation