Creditor Crediting
Issue credits to a case in the Amili system. Used by creditors to credit entire cases, complete invoices, or partial invoice amounts.
Creditor Crediting endpoints
GET /creditor--creditings- List all credits (paginated)GET /creditor--creditings/{id}- Get a specific creditPOST /creditor--creditings- Create a credit request
See Case for accessing the cases that can be credited.
Examples
For working code examples and detailed usage guides, see Creditor Case Actions.
For complete API specification with interactive testing, see Swagger: Creditor Crediting.
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 credit (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 | Amount to credit |
credit_invoice | string | No | Credit invoice ID for traceability |
client_registration_date | string | No | When crediting was performed (RFC 1123 format, defaults to current timestamp) |
creditor_reference | string | No | Reference for crediting 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 credit |
_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 | Credit 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 |
*) 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 Crediting