Finance Payout

Access aggregated creditor payout information in the Amili system. Finance payouts represent the consolidated financial data for payments to creditors, grouping multiple payout specifications by category (capital, interest, fees, commissions) and finance period.

Each payout tracks the total amounts, VAT calculations, payout status, and provides a breakdown summary by article type. Payouts are linked to individual finance payout specifications that contain the detailed transaction-level data.

Finance Payout endpoints

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

See Finance Payout Specification for accessing the detailed transaction-level data and Finance Examples for detailed usage examples.

Relationship to Finance Payout Specifications

Finance payouts and finance payout specifications have a parent-child relationship:

Finance Payout (parent) = Aggregated summary of a payout to a creditor
Finance Payout Specification (child) = Individual transaction lines that make up the payout

Key fields are automatically synchronized via cascade update:

When payout_date is set on a payout, all related specifications are updated
When payout_reference changes, all related specifications are updated
When finance_interval changes, the payout_interval field in specifications is updated

Use cases:

View total amounts → Use GET /finance--payouts
View breakdown by article → Use the summary field in GET /finance--payouts
View individual transactions → Use GET /finance--payout-specifications with where={"payout": "{payout_id}"}

See Finance Examples for complete workflow examples.

Example Request

Below is an example of retrieving finance payouts for a specific creditor.

URL: GET /finance--payouts?where={"creditor":"686e6ed854377058c2dd10bd"}&sort=-_created&max_results=10

Headers:

X-API-Key: your-access-token

Response:

json

{
  "_items": [
    {
      "_id": "507f1f77bcf86cd799439099",
      "_created": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_updated": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_etag": "a1b2c3d4e5f678901234567890123456",
      "creditor": "686e6ed854377058c2dd10bd",
      "currency": "SEK",
      "payout_reference": "65432",
      "ready_for_payout": true,
      "bank_payout_request": "507f1f77bcf86cd799439100",
      "payout_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "amount": 12000.0,
      "vat_amount": 0.0,
      "total_amount": 12000.0,
      "summary": {
        "capital": {
          "count": 12,
          "amount": 12000.0,
          "vat_amount": 0.0,
          "total_amount": 12000.0
        }
      },
      "finance_category": "capital",
      "finance_interval": "daily",
      "finance_period_start_date": "Thu, 12 Jun 2025 00:00:00 GMT",
      "finance_period_end_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "finance_period_day": 164,
      "finance_period_year": 2025
    },
    {
      "_id": "507f1f77bcf86cd799439098",
      "_created": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_updated": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_etag": "b2c3d4e5f67890123456789012345678",
      "creditor": "686e6ed854377058c2dd10bd",
      "currency": "SEK",
      "payout_reference": "65432",
      "ready_for_payout": true,
      "bank_payout_request": "507f1f77bcf86cd799439101",
      "payout_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "amount": 3000.0,
      "vat_amount": 0.0,
      "total_amount": 3000.0,
      "summary": {
        "interest": {
          "count": 8,
          "amount": 3000.0,
          "vat_amount": 0.0,
          "total_amount": 3000.0
        }
      },
      "finance_category": "interest",
      "finance_interval": "daily",
      "finance_period_start_date": "Thu, 12 Jun 2025 00:00:00 GMT",
      "finance_period_end_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "finance_period_day": 164,
      "finance_period_year": 2025
    },
    {
      "_id": "507f1f77bcf86cd799439097",
      "_created": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_updated": "Fri, 13 Jun 2025 08:00:00 GMT",
      "_etag": "c3d4e5f6789012345678901234567890",
      "creditor": "686e6ed854377058c2dd10bd",
      "currency": "SEK",
      "payout_reference": "123456",
      "ready_for_payout": true,
      "bank_payout_request": "507f1f77bcf86cd799439102",
      "payout_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "amount": 240.0,
      "vat_amount": 60.0,
      "total_amount": 300.0,
      "summary": {
        "reminder": {
          "count": 4,
          "amount": 240.0,
          "vat_amount": 60.0,
          "total_amount": 300.0
        }
      },
      "finance_category": "creditor_commission",
      "finance_interval": "daily",
      "finance_period_start_date": "Thu, 12 Jun 2025 00:00:00 GMT",
      "finance_period_end_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "finance_period_day": 164,
      "finance_period_year": 2025,
      "document": {
        "file": "507f1f77bcf86cd799439103",
        "content_type": "application/pdf",
        "name": "self_invoice_2025_164.pdf",
        "length": 45678
      }
    }
  ],
  "_meta": {
    "page": 1,
    "max_results": 10,
    "total": 3
  }
}

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, "summary": 1}`)

See Pagination and Queries for detailed information.

Response Fields

Field	Type	Required	Description
`_id`	string	Yes	Unique identifier (ObjectId)
`_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)
`currency`	string	Yes	Currency code (currently only "SEK" supported)
`payout_reference`	string	Yes	Reference identifier for the payout
`ready_for_payout`	boolean	Yes	Whether the payout is ready to be exported to banking system (default: false)
`bank_payout_request`	string	No	Banking payout request ID (ObjectId) - set when payout is exported to banking system
`payout_date`	string	No	When the bank payout request was created (RFC 1123 format)
`banking_account`	string	No	Banking account ID (ObjectId) for the payout
`ledger_account`	number	No	Ledger account number (1900-1999)
`amount`	number	No	Base amount excluding VAT
`vat_amount`	number	No	VAT amount
`total_amount`	number	No	Total amount (amount + vat_amount)
`summary`	object	No	Breakdown by article type (see Summary Structure below)
`creditor_payment_reference`	string	No	Custom payment reference for creditor (system-only field)
`finance_category`	string	No	Financial payout category (see Finance Categories below)*
`finance_interval`	string	No	Payout interval (see Finance Intervals below)*
`finance_period_start_date`	string	No	Finance period start date (RFC 1123 format)
`finance_period_end_date`	string	No	Finance period end date (RFC 1123 format)
`finance_period_day`	number	No	Day of year (1-366) - only for daily interval
`finance_period_week`	number	No	Week number (1-53) - only for weekly interval
`finance_period_month`	number	No	Month number (1-12) - only for monthly interval
`finance_period_quarter`	number	No	Quarter number (1-4) - for daily, weekly, monthly, quarterly intervals
`finance_period_half_year`	number	No	Half year number (1-2) - for daily, weekly, monthly, quarterly intervals
`finance_period_year`	number	No	Year (e.g. 2025)
`document`	object	No	Self invoice/receipt PDF for creditor commission (see Document Structure below)

Summary Structure

The summary field contains a breakdown of the payout by article type. Each article has:

Field	Type	Description
`count`	number	Number of specifications
`amount`	number	Total base amount (excl. VAT)
`vat_amount`	number	Total VAT amount
`total_amount`	number	Total amount (incl. VAT)

Example (Capital payout):

json

{
  "summary": {
    "capital": {
      "count": 12,
      "amount": 12000.0,
      "vat_amount": 0.0,
      "total_amount": 12000.0
    }
  }
}

Example (Interest payout):

json

{
  "summary": {
    "interest": {
      "count": 8,
      "amount": 3000.0,
      "vat_amount": 0.0,
      "total_amount": 3000.0
    }
  }
}

Example (Creditor commission payout):

json

{
  "summary": {
    "reminder": {
      "count": 4,
      "amount": 240.0,
      "vat_amount": 60.0,
      "total_amount": 300.0
    }
  }
}

Document Structure

The document field contains information about the generated self invoice/receipt PDF (only for creditor commission payouts):

Field	Type	Description
`file`	string	Media file ID (ObjectId)
`content_type`	string	MIME type (application/pdf)
`name`	string	File name
`length`	number	File size in bytes

Common Articles

Articles that can appear in the summary field:

Article	Description
`capital`	Principal debt amount
`interest`	Interest charges
`reminder`	Reminder fees
`cost`	Collection costs
`debt_collection`	Debt collection fees
`enforcement`	Enforcement fees
`amortization_setup`	Amortization setup fees
`amortization_advice`	Amortization advice fees
`amortization_reminder`	Amortization reminder fees
`commission`	Commission fees
`commission_intercompany`	Intercompany commission fees
`finance_refund`	Finance refunds

Finance Categories

Allowed values for finance_category field in creditor payouts:

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

Finance Intervals

Interval	Description
`daily`	Daily payout interval
`weekly`	Weekly payout interval
`monthly`	Monthly payout interval
`quarterly`	Quarterly payout interval

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

Finance Payout ​

Finance Payout endpoints ​

Relationship to Finance Payout Specifications ​

Example Request ​

Parameters ​

Query Parameters ​

Response Fields ​

Summary Structure ​

Document Structure ​

Common Articles ​

Finance Categories ​

Finance Intervals ​

Finance Payout

Finance Payout endpoints

Relationship to Finance Payout Specifications

Example Request

Parameters

Query Parameters

Response Fields

Summary Structure

Document Structure

Common Articles

Finance Categories

Finance Intervals