Skip to content

Creditor Crediting

Utfärda krediteringar till ett Case i Amili-systemet. Används av Creditors för att kreditera hela Cases, kompletta Invoices eller delvisa fakturabelopp.

Creditor Crediting endpoints

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

Exempel Request

Nedan är ett exempel på att utfärda en kreditering för ett befintligt Case.

URL: POST /creditor--creditings

Headers:

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

Request Body:

json
{
  "account": "674dbeaf08847b9501cc9132",
  "creditor": "674dbeb208847b9501cc9138",
  "case": "68678eda88b9226bb78d7169",
  "currency": "SEK",
  "amount": 100.0,
  "origin": "creditor_system"
}

Response Code: 201 Created

Response Body:

json
{
  "_updated": "Fri, 04 Jul 2025 14:35:29 GMT",
  "_created": "Fri, 04 Jul 2025 14:35:29 GMT",
  "_etag": "cab1b340f4ea1bacd8bc83ef46a2b6791d23f227",
  "_id": "6868242274dfc89e00608507",
  "_status": "OK",
  "_payment_status": "completed"
}

Parametrar

Request Body Properties

PropertyTypObligatoriskBeskrivning
accountstringNej**Account ID (readonly, sätts automatiskt från case/creditor)
creditorstringJaCreditor ID
casestringJa*Case ID att kreditera (ömsesidigt uteslutande med invoice_number)
invoice_numberstringJa*Invoice number för att lösa case (ömsesidigt uteslutande med case)
currencystringJaValutakod (för närvarande endast "SEK" stöds)
amountnumberJaBelopp att kreditera
credit_invoicestringNejCredit invoice ID för spårbarhet
client_registration_datestringNejNär krediteringen utfördes (RFC 1123 format, standard är nuvarande tidsstämpel)
creditor_referencestringNejReferens för krediteringsspårning
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 crediting
_createdstringJaSkapandetidsstämpel (RFC 1123 format)
_updatedstringJaSenaste uppdateringstidsstämpel (RFC 1123 format)
_etagstringJaEntity tag för samtidighetskontroll
_statusstringJaRequest-status (t.ex. "OK")***
_payment_statusstringJaCrediting-processstatus (t.ex. "completed")***
settled_amountnumberNejBeloppet som faktiskt avräknades
statusstringNejBearbetningsstatus: "completed", "warning", eller "error"
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 Crediting