Finance Payout Specification

Få åtkomst till utbetalningsspecifikationer i Amili-systemet. Payout Specifications definierar hur insamlade medel betalas ut till Creditors, inklusive bankkontouppgifter, utbetalningsfrekvens och minimibelopp.

Finance Payout Specification endpoints

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

Se Creditor för att få åtkomst till Creditors som tar emot utbetalningar.

Exempel Request

Nedan är ett exempel på att hämta utbetalningsspecifikationer.

URL: GET /finance--payout-specifications

Headers:

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

Request Body: Ingen (GET request)

Response Code: 200 OK

Response Body:

{
  "_status": "OK",
  "_id": "payout_spec_123456",
  "creditor": "cred_789012",
  "account": "acc_345678",
  "bank_account": {
    "account_number": "1234567890",
    "clearing_number": "1234",
    "bank_name": "Example Bank AB",
    "iban": "SE1234567890123456789012",
    "swift": "EXAMPLESWIFT"
  },
  "payout_frequency": "weekly",
  "payout_day": "friday",
  "minimum_payout_amount": 1000.0,
  "currency": "SEK",
  "is_active": true,
  "_created": "2024-01-01T00:00:00Z",
  "_updated": "2024-01-01T00:00:00Z"
}

Parametrar

Response Properties

Property	Typ	Obligatorisk	Beskrivning
_id	string	Ja	Unik identifierare för payout specification
_created	string	Ja	Skapandetidsstämpel
_updated	string	Ja	Senaste uppdateringstidsstämpel
_status	string	Ja	Request-status (t.ex. "OK")*
creditor	string	Ja	Creditor ID
account	string	Ja	Account ID
bank_account	object	Ja	Bankkontouppgifter
payout_frequency	string	Ja	Utbetalningsfrekvens (t.ex. "weekly")*
payout_day	string	Ja	Utbetalningsdag (t.ex. "friday")*
minimum_payout_amount	number	Ja	Minimibelopp som krävs för utbetalning
currency	string	Ja	Valutakod (för närvarande endast "SEK" stöds)
is_active	boolean	Ja	Om specifikationen är aktiv

Bank Account Properties

Property	Typ	Obligatorisk	Beskrivning
account_number	string	Ja	Bankkontonummer
clearing_number	string	Ja	Bank clearing-nummer
bank_name	string	Ja	Bankens namn
iban	string	Ja	IBAN-nummer
swift	string	Ja	SWIFT/BIC-kod

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