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
GET /creditor--creditings- Lista alla creditings (pagerad)GET /creditor--creditings/{id}- Hämta en specifik creditingPOST /creditor--creditings- Skapa en crediting request
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/jsonRequest 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
| Property | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
account | string | Nej** | Account ID (readonly, sätts automatiskt från case/creditor) |
creditor | string | Ja | Creditor ID |
case | string | Ja* | Case ID att kreditera (ömsesidigt uteslutande med invoice_number) |
invoice_number | string | Ja* | Invoice number för att lösa case (ömsesidigt uteslutande med case) |
currency | string | Ja | Valutakod (för närvarande endast "SEK" stöds) |
amount | number | Ja | Belopp att kreditera |
credit_invoice | string | Nej | Credit invoice ID för spårbarhet |
client_registration_date | string | Nej | När krediteringen utfördes (RFC 1123 format, standard är nuvarande tidsstämpel) |
creditor_reference | string | Nej | Referens för krediteringsspårning |
file_import_report | string | Nej** | File import report ID (readonly, sätts av systemet vid filimporter) |
origin | string | Ja | Ursprung för request (måste vara "creditor_system")*** |
Response Properties
| Property | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
_id | string | Ja | Unik identifierare för crediting |
_created | string | Ja | Skapandetidsstämpel (RFC 1123 format) |
_updated | string | Ja | Senaste uppdateringstidsstämpel (RFC 1123 format) |
_etag | string | Ja | Entity tag för samtidighetskontroll |
_status | string | Ja | Request-status (t.ex. "OK")*** |
_payment_status | string | Ja | Crediting-processstatus (t.ex. "completed")*** |
settled_amount | number | Nej | Beloppet som faktiskt avräknades |
status | string | Nej | Bearbetningsstatus: "completed", "warning", eller "error" |
status_reason_locale | string | Nej | Locale-nyckel för statusorsaksmeddelande |
case_invoice_number | string | Nej | Invoice number från case (projektion, inte samma som inmatningsfält) |
case_reference_number | string | Nej | Case 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
