Finance Payout Specification

Få tillgång till finansiella transaktionsspecifikationer i Amili-systemet. Finance payout specifications är detaljerade finansiella poster som skapas under betalningsavveckling och representerar uppdelningen av insamlade medel per kategori (kapital, ränta, avgifter, provisioner) som bidrar till creditor-utbetalningar.

Varje specification spårar en enskild finansiell transaktion med dess belopp, momsberäkningar, bokföringsdatum och referenser till relaterat case eller inkassoprocess.

Finance Payout Specification endpoints

GET /finance--payout-specifications - Lista alla payout specifications (paginerad)
GET /finance--payout-specifications/{id} - Hämta en specifik payout specification

Se Creditor för att komma åt creditors som tar emot utbetalningar och Finance Examples för detaljerade användningsexempel.

Exempel Request

Nedan är ett exempel på att hämta finance payout specifications med paginering.

URL: GET /finance--payout-specifications?page=1&max_results=20&sort=-_created

Headers:

x-api-key: {your_access_token}
Content-Type: application/json

Request Body: Ingen (GET request)

Response Code: 200 OK

Response Body:

json

{
  "_items": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "_created": "Wed, 11 Jun 2025 14:00:18 GMT",
      "_updated": "Wed, 11 Jun 2025 14:00:18 GMT",
      "_etag": "a1b2c3d4e5f678901234567890123456",
      "creditor": "686e6ed854377058c2dd10bd",
      "creditor_name": "Example Creditor AB",
      "currency": "SEK",
      "amount": 60.0,
      "vat_amount": 15.0,
      "total_amount": 75.0,
      "article": "reminder",
      "state": "reminder",
      "booking_date": "Wed, 11 Jun 2025 00:00:00 GMT",
      "finance_category": "creditor_commission",
      "invoice_number": "INV-2025-020",
      "reference_number": "25020",
      "payout_reference": "Creditor Commission",
      "payout_date": "Fri, 13 Jun 2025 00:00:00 GMT",
      "payout": "507f1f77bcf86cd799439099"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "_created": "Wed, 11 Jun 2025 14:00:17 GMT",
      "_updated": "Wed, 11 Jun 2025 14:00:17 GMT",
      "_etag": "b2c3d4e5f67890123456789012345678",
      "creditor": "686e6ed854377058c2dd10bd",
      "creditor_name": "Example Creditor AB",
      "currency": "SEK",
      "amount": 1064.0,
      "vat_amount": 0.0,
      "total_amount": 1064.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Wed, 11 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "invoice_number": "INV-2025-020",
      "reference_number": "25020"
    }
  ],
  "_meta": {
    "page": 1,
    "max_results": 20,
    "total": 162
  }
}

Parametrar

Query Parameters

Standard Eve paginerings- och filtreringsparametrar stöds:

Parameter	Typ	Beskrivning
`page`	number	Sidnummer (standard: 1)
`max_results`	number	Objekt per sida (standard: 25, max: 100)
`sort`	string	Sorteringsfält (prefix med `-` för fallande, t.ex. `-_created`)
`where`	string	JSON query-filter (t.ex. `{"creditor": "686e6ed854377058c2dd10bd"}`)
`projection`	string	JSON fältprojektion (t.ex. `{"amount": 1, "article": 1}`)

Se Pagination and Queries för detaljerad information.

Response Properties

Property	Typ	Obligatorisk	Beskrivning
`_id`	string	Ja	Unik identifierare för payout specification
`_created`	string	Ja	Skapandetidsstämpel (RFC 1123 format)
`_updated`	string	Ja	Senaste uppdateringstidsstämpel (RFC 1123 format)
`_etag`	string	Ja	Entity tag för samtidighetskontroll
`creditor`	string	Ja	Creditor ID (ObjectId)
`creditor_name`	string	Nej	Creditor-namn (kaskaduppdaterad från creditor)
`currency`	string	Ja	Valutakod (för närvarande endast "SEK" stöds)
`amount`	number	Ja	Basbelopp (exklusive moms)
`vat_amount`	number	Ja	Momsbelopp
`total_amount`	number	Ja	Totalt belopp (amount + vat_amount)
`article`	string	Ja	Typ av avgift (t.ex. "capital", "interest", "reminder")*
`state`	string	Nej	Case-status när specification skapades (t.ex. "reminder", "debt_collection")*
`state_date`	string	Nej	Statusdatum när specification skapades (RFC 1123 format)
`booking_date`	string	Nej	Bokföringsdatum från underliggande åtgärd (RFC 1123 format)
`finance_category`	string	Nej	Finansiell utbetalningskategori (t.ex. "capital", "interest", "creditor_commission")*
`payout`	string	Nej	Payout ID (ObjectId) om specification har schemalagts för utbetalning
`payout_reference`	string	Nej	Referenstext för utbetalningen (kaskaduppdaterad från payout)
`payout_date`	string	Nej	Schemalagt utbetalningsdatum (RFC 1123 format, kaskaduppdaterad från payout)
`payout_interval`	string	Nej	Finansintervall för utbetalningen (t.ex. "daily", "weekly", kaskaduppdaterad från payout)
`reference_number`	string	Nej	Referensnummer från relaterat case/inkasso
`invoice_number`	string	Nej	Fakturanummer (om enskild faktura)
`invoice_numbers`	array	Nej	Fakturanummer (om flera fakturor)
`references`	object	Nej	Referenser till relaterade dokument (case, debt_collection, enforcement, etc.)

Common Articles

Article	Beskrivning
`capital`	Huvudsaklig skuldbelopp
`interest`	Räntekostnader
`reminder`	Påminnelseavgifter
`cost`	Inkassokostnader

Common Finance Categories

Category	Beskrivning
`capital`	Insamlade kapitalbelopp
`interest`	Insamlad ränta
`creditor_commission`	Provisionsavgifter debiterade creditor
`amili_commission`	Amilis provision från inkasso

Common States

State	Beskrivning
`initializing`	Case initialiseras
`reminder`	Case är i påminnelsefas
`debt_collection`	Case är i inkassofas
`enforcement`	Case är i verkställighetsfas
`debt_surveillance`	Case är i skuldbevakning

*) För komplett lista över värden och detaljer, se Finance Payout Specification

Finance Payout Specification ​