Accounts

Get Account Allocation

Returns an account's allocations for a run date. Allocations are produced only on business days, so a weekend or holiday run_date returns an empty allocations list. When run_date is omitted, the most recent approved allocation run is used. To get the latest allocations, omit run_date; if you pass a date, use a business day.

get/digital-banking/v1/accounts/{account_id}/allocation

Request

Base URL
https://api.modernfi.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/modernfi/apis/endpoints/docs/digital-banking/v1/accounts/:account_id/allocation/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

string uuid required

string required

Query parameters

id_type'INSTITUTION'

Type of the account id. Institution accounts ids are external ids and come from the institution.

Type of the account id. Must be 'institution' or 'None'.

run_datestring date nullable

The date for which to retrieve allocation data. Must be a business day to return allocations; weekend and holiday dates return an empty list. If not provided, uses the most recent approved allocation run date.

Response

Successful Response

account_idstring required

run_datestring required

Changes

No recorded changes to this operation across all 12 revisions of this API.