Finance Payout Specification

Access payout specifications in the Amili system. Payout specifications define how collected funds are disbursed to creditors, including bank account details, payout frequency, and minimum amounts.

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.

Example Request

Below is an example of retrieving payout specifications.

URL: GET /finance--payout-specifications

Headers:

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

Request Body: None (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"
}

Parameters

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the payout specification
_created	string	Yes	Creation timestamp
_updated	string	Yes	Last update timestamp
_status	string	Yes	Request status (e.g. "OK")*
creditor	string	Yes	Creditor ID
account	string	Yes	Account ID
bank_account	object	Yes	Bank account details
payout_frequency	string	Yes	Payout frequency (e.g. "weekly")*
payout_day	string	Yes	Payout day (e.g. "friday")*
minimum_payout_amount	number	Yes	Minimum amount required for payout
currency	string	Yes	Currency code (currently only "SEK" supported)
is_active	boolean	Yes	Whether specification is active

Bank Account Properties

Property	Type	Required	Description
account_number	string	Yes	Bank account number
clearing_number	string	Yes	Bank clearing number
bank_name	string	Yes	Name of the bank
iban	string	Yes	IBAN number
swift	string	Yes	SWIFT/BIC code

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