Finance Payout

Få tillgång till aggregerad borgenärsutbetalningsinformation i Amili-systemet. Finansutbetalningar representerar den konsoliderade finansiella datan för betalningar till borgenärer, grupperade efter kategori (kapital, ränta, avgifter, provisioner) och finansperiod.

Varje utbetalning spårar totala belopp, momsberäkningar, utbetalningsstatus och ger en sammanfattning uppdelad per artikeltyp. Utbetalningar är länkade till individuella finansutbetalningsspecifikationer som innehåller detaljerad transaktionsdata.

Finance Payout endpoints

• GET /finance--payouts - Lista alla utbetalningar (paginerade)
• GET /finance--payouts/{id} - Hämta en specifik utbetalning

Se Finance Payout Specification för att komma åt detaljerad transaktionsdata och Finance Examples för detaljerade användningsexempel.

Relation till Finance Payout Specifications

Finansutbetalningar och finansutbetalningsspecifikationer har en förälder-barn-relation:

• Finance Payout (förälder) = Aggregerad sammanfattning av en utbetalning till en borgenär
• Finance Payout Specification (barn) = Individuella transaktionsrader som utgör utbetalningen

Nyckelfält synkroniseras automatiskt via kaskaduppdatering:

• När payout_date sätts på en utbetalning uppdateras alla relaterade specifikationer
• När payout_reference ändras uppdateras alla relaterade specifikationer
• När finance_interval ändras uppdateras fältet payout_interval i specifikationerna

Användningsfall:

• Visa totala belopp → Använd GET /finance--payouts
• Visa uppdelning per artikel → Använd fältet summary i GET /finance--payouts
• Visa individuella transaktioner → Använd GET /finance--payout-specifications med where={"payout": "{payout_id}"}

Se Finance Examples för kompletta arbetsflödesexempel.

Exempelförfrågan

Nedan är ett exempel på att hämta finansutbetalningar för en specifik borgenär.

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

Headers:

X-API-Key: your-access-token

Response:

{
  "_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
  }
}

Parametrar

Query-parametrar

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-frågefilter (t.ex. {"creditor": "686e6ed854377058c2dd10bd"})
projection	string	JSON-fältprojektion (t.ex. {"amount": 1, "summary": 1})

Se Pagination and Queries för detaljerad information.

Responsfält

Fält	Typ	Krävs	Beskrivning
_id	string	Ja	Unik identifierare (ObjectId)
_created	string	Ja	Tidsstämpel för skapande (RFC 1123-format)
_updated	string	Ja	Tidsstämpel för senaste uppdatering (RFC 1123-format)
_etag	string	Ja	Entity tag för samtidighetskontroll
creditor	string	Ja	Borgenärs-ID (ObjectId)
currency	string	Ja	Valutakod (för närvarande stöds endast "SEK")
payout_reference	string	Ja	Referensidentifierare för utbetalningen
ready_for_payout	boolean	Ja	Om utbetalningen är redo att exporteras till banksystemet (standard: false)
bank_payout_request	string	Nej	ID för bankutbetalningsförfrågan (ObjectId) - sätts när utbetalning exporteras till banksystemet
payout_date	string	Nej	När bankutbetalningsförfrågan skapades (RFC 1123-format)
banking_account	string	Nej	Bankkonto-ID (ObjectId) för utbetalningen
ledger_account	number	Nej	Huvudbokskonto nummer (1900-1999)
amount	number	Nej	Basbelopp exklusive moms
vat_amount	number	Nej	Momsbelopp
total_amount	number	Nej	Totalt belopp (amount + vat_amount)
summary	object	Nej	Uppdelning per artikeltyp (se Summary-struktur nedan)
creditor_payment_reference	string	Nej	Anpassad betalningsreferens för borgenär (endast systemfält)
finance_category	string	Nej	Finansiell utbetalningskategori (se Finanskategorier nedan)*
finance_interval	string	Nej	Utbetalningsintervall (se Finansintervall nedan)*
finance_period_start_date	string	Nej	Startdatum för finansperiod (RFC 1123-format)
finance_period_end_date	string	Nej	Slutdatum för finansperiod (RFC 1123-format)
finance_period_day	number	Nej	Dag på året (1-366) - endast för dagligt intervall
finance_period_week	number	Nej	Veckonummer (1-53) - endast för veckovis intervall
finance_period_month	number	Nej	Månadsnummer (1-12) - endast för månadsvis intervall
finance_period_quarter	number	Nej	Kvartalsnummer (1-4) - för dagliga, veckovisa, månadsvisa, kvartalsvisa intervall
finance_period_half_year	number	Nej	Halvårsnummer (1-2) - för dagliga, veckovisa, månadsvisa, kvartalsvisa intervall
finance_period_year	number	Nej	År (t.ex. 2025)
document	object	Nej	Självfaktura/kvitto PDF för borgenärsprovision (se Dokumentstruktur nedan)

Summary-struktur

Fältet summary innehåller en uppdelning av utbetalningen per artikeltyp. Varje artikel har:

Fält	Typ	Beskrivning
count	number	Antal specifikationer
amount	number	Totalt basbelopp (exkl. moms)
vat_amount	number	Totalt momsbelopp
total_amount	number	Totalt belopp (inkl. moms)

Exempel (Kapitalutbetalning):

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

Exempel (Ränteutbetalning):

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

Exempel (Borgenärsprovision):

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

Dokumentstruktur

Fältet document innehåller information om den genererade självfaktura/kvitto PDF (endast för borgenärsprovisionsutbetalningar):

Fält	Typ	Beskrivning
file	string	Mediafil-ID (ObjectId)
content_type	string	MIME-typ (application/pdf)
name	string	Filnamn
length	number	Filstorlek i bytes

Vanliga artiklar

Artiklar som kan förekomma i fältet summary:

Artikel	Beskrivning
capital	Huvudsakligt skuldbelopp
interest	Räntekostnader
reminder	Påminnelseavgifter
cost	Inkassokostnader
debt_collection	Inkassoavgifter
enforcement	Verkställighetsavgifter
amortization_setup	Avbetalningsuppsättningsavgifter
amortization_advice	Avbetalningsaviseringsavgifter
amortization_reminder	Avbetalningspåminnelseavgifter
commission	Provisionsavgifter
commission_intercompany	Koncerninterna provisionsavgifter
finance_refund	Finansiella återbetalningar

Finanskategorier

Tillåtna värden för fältet finance_category i borgenärsutbetalningar:

Kategori	Beskrivning
capital	Insamlade kapitalbelopp
interest	Insamlad ränta
creditor_commission	Provisionsavgifter debiterade borgenär
creditor_outlay	Borgenärsutlägg

Finansintervall

Intervall	Beskrivning
daily	Dagligt utbetalningsintervall
weekly	Veckovis utbetalningsintervall
monthly	Månadsvis utbetalningsintervall
quarterly	Kvartalsvis utbetalningsintervall

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