Skip to content

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 ​

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 ​

PropertyTypeRequiredDescription
accountstringNo**Account ID (readonly, automatically set from case/creditor)
creditorstringYesCreditor ID
casestringYes*Case ID to credit (mutually exclusive with invoice_number)
invoice_numberstringYes*Invoice number to resolve case (mutually exclusive with case)
currencystringYesCurrency code (currently only "SEK" supported)
amountnumberYesAmount to credit
credit_invoicestringNoCredit invoice ID for traceability
client_registration_datestringNoWhen crediting was performed (RFC 1123 format, defaults to current timestamp)
creditor_referencestringNoReference for crediting tracking
file_import_reportstringNo**File import report ID (readonly, set by system during file imports)
originstringYesOrigin of request (must be "creditor_system")***

Response Properties ​

PropertyTypeRequiredDescription
_idstringYesUnique identifier for the credit
_createdstringYesCreation timestamp (RFC 1123 format)
_updatedstringYesLast update timestamp (RFC 1123 format)
_etagstringYesEntity tag for concurrency control
_statusstringYesRequest status (e.g. "OK")***
_payment_statusstringYesCredit process status (e.g. "completed")***
settled_amountnumberNoThe amount that was actually settled
statusstringNoProcessing status: "completed", "warning", or "error"
status_reason_localestringNoLocale key for status reason message
case_invoice_numberstringNoInvoice number from the case (projection, not same as input field)
case_reference_numberstringNoCase 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