Creditor Payment
Registrera betalningar i Amili-systemet. Används när en kund gör en betalning direkt till en Creditor, vilket gör att betalningen kan registreras mot ett Case.
Creditor Payment endpoints
GET /creditor--payments- Lista alla payments (pagerad)GET /creditor--payments/{id}- Hämta en specifik paymentPOST /creditor--payments- Skapa en payment record
Se Case för att få åtkomst till Cases som kan ta emot betalningar.
Exempel
För kodexempel och detaljerade användningsguider, se Borgenärsåtgärder för ärenden.
För komplett API-specifikation med interaktiv testning, se Swagger: Creditor Payment.
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 registrera betalning för (ö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 | Betalningsbelopp |
bank_transaction_date | string | Ja | Datum för banktransaktionen (RFC 1123 format) |
client_registration_date | string | Nej | När betalningen registrerades (RFC 1123 format, standard är nuvarande tidsstämpel) |
creditor_payment_reference | string | Nej | Referens för betalningsspå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 payment |
_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 | Payment-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 |
booking_date | string | Nej | Datum när betalningen avräknades (RFC 1123 format) |
*) 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 Payment
