Creditor Payment
Register payments in the Amili system. Used when a customer makes a payment directly to a creditor, allowing the payment to be recorded against a case.
Creditor Payment endpoints
- GET
/creditor--payments- List all payments (paginated) - GET
/creditor--payments/{id}- Get a specific payment - POST
/creditor--payments- Create a payment record
See Case for accessing the cases that can receive payments.
Examples
For working code examples and detailed usage guides, see Creditor Case Actions.
For complete API specification with interactive testing, see Swagger: Creditor Payment.
Parameters
Request Body Properties
| Property | Type | Required | Description |
|---|---|---|---|
account | string | No** | Account ID (readonly, automatically set from case/creditor) |
creditor | string | Yes | Creditor ID |
case | string | Yes* | Case ID to register payment for (mutually exclusive with invoice_number) |
invoice_number | string | Yes* | Invoice number to resolve case (mutually exclusive with case) |
currency | string | Yes | Currency code (currently only "SEK" supported) |
amount | number | Yes | Payment amount |
bank_transaction_date | string | Yes | Date of the bank transaction (RFC 1123 format) |
client_registration_date | string | No | When payment was registered (RFC 1123 format, defaults to current timestamp) |
creditor_payment_reference | string | No | Reference for payment tracking |
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 payment |
_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")*** |
_payment_status | string | Yes | Payment process status (e.g. "completed")*** |
settled_amount | number | No | The amount that was actually settled |
status | string | No | Processing status: "completed", "warning", or "error" |
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 |
booking_date | string | No | Date when payment was settled (RFC 1123 format) |
*) 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 Payment