Finance Payout Specification

Access financial transaction specifications in the Amili system. Finance payout specifications are detailed financial entries created during payment settlement, representing the breakdown of collected funds by category (capital, interest, fees, commissions) that contribute to creditor payouts.

Each specification tracks a single financial transaction with its amounts, VAT calculations, booking date, and references to the related case or debt collection process.

Finance Payout Specification endpoints

• GET /finance--payout-specifications - List all payout specifications (paginated)
• GET /finance--payout-specifications/{id} - Get a specific payout specification

See Creditor for accessing the creditors that receive payouts and Finance Examples for detailed usage examples.

Examples

For working code examples and detailed usage guides, see Finance & Payout Examples.

For complete API specification with interactive testing, see Swagger: Finance Payout Specification.

Parameters

Query Parameters

Standard Eve pagination and filtering parameters are supported:

Parameter	Type	Description
page	number	Page number (default: 1)
max_results	number	Items per page (default: 25, max: 100)
sort	string	Sort field (prefix with - for descending, e.g. -_created)
where	string	JSON query filter (e.g. {"creditor": "686e6ed854377058c2dd10bd"})
projection	string	JSON field projection (e.g. {"amount": 1, "article": 1})

See Pagination and Queries for detailed information.

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the payout specification
_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
creditor	string	Yes	Creditor ID (ObjectId)
creditor_name	string	No	Creditor name (cascade updated from creditor)
currency	string	Yes	Currency code (currently only "SEK" supported)
amount	number	Yes	Base amount (excluding VAT)
vat_amount	number	Yes	VAT amount
total_amount	number	Yes	Total amount (amount + vat_amount)
article	string	Yes	Type of charge (e.g. "capital", "interest", "reminder")*
state	string	No	Case state when specification was created (e.g. "reminder", "debt_collection")*
state_date	string	No	State date when specification was created (RFC 1123 format)
booking_date	string	No	Booking date from underlying action (RFC 1123 format)
finance_category	string	No	Financial payout category (e.g. "capital", "interest", "creditor_commission")*
payout	string	No	Payout ID (ObjectId) if specification has been scheduled for payout
payout_reference	string	No	Reference identifier for the payout (cascade updated from payout)
payout_date	string	No	Scheduled payout date (RFC 1123 format, cascade updated from payout)
payout_interval	string	No	Finance interval of the payout (e.g. "daily", "weekly", cascade updated from payout)
reference_number	string	No	Reference number from the related case/debt collection
invoice_number	string	No	Invoice number (if single invoice)
invoice_numbers	array	No	Invoice numbers (if multiple invoices)
references	object	No	References to related documents (case, debt_collection, enforcement, etc.)

Common Articles

Article	Description
capital	Principal debt amount
interest	Interest charges
reminder	Reminder fees
cost	Collection costs

Common Finance Categories

Category	Description
capital	Principal amounts collected
interest	Interest collected
creditor_commission	Commission fees charged to creditor
creditor_outlay	Creditor outlays

Common States

State	Description
initializing	Case is being initialized
reminder	Case is in reminder phase
debt_collection	Case is in debt collection phase
enforcement	Case is in enforcement phase
debt_surveillance	Case is in debt surveillance phase

*) For complete list of values and details, please see Finance Payout Specification