Skip to content

ProfileSettlement

AccountProfileSettlement contains settlement settings per symbol which influence the time when settlement actions (such as swap charges, PL calculations, and dividends) are performed. All such settings are defined in AccountProfileSettlementSetting. AccountProfileSettlement has the following attributes and can be accessed via pending config or real-time config:

attributes required default settings attribute type description
id Y – INT The ID of the profile; generated.
name Y – STRING The name of the profile
description N n/a STRING Free text

AccountProfileSettlementSetting

AccountProfileSettlementSetting defines the time when settlement actions (such as swap charges, PL calculations, and dividends) are performed per symbol and currency. AccountProfileSettlementSetting has the below attributes:

attributes required default settings attribute type description
profile Y – INT The name of the profile
symbol Y – VARCHAR The symbol to which the defined settlement settings will be applied, or * as a fallback for all other symbols. An explicit symbol row takes precedence over the fallback.
time Y 17:00:00 VARCHAR A time in HH:mm:ss, interpreted in the configured system timezone. Confirm the supported schedule procedure for daylight-saving transitions. 24:00:00 represents the end of the day. For a positive interval, this is the recurring alignment anchor. For example, 17:05:00 with interval 60 settles every hour at minute 05, starting with the next aligned occurrence; it does not wait until 17:05 the next day. Earlier occurrences are not replayed on startup. Changes take effect after Apply & Restart.
interval Y 1440 INT How often the settlement runs, in minutes. The default 1440 settles once a day at time. The interval has to divide 1440 exactly: for example 60 (every hour), 480 (every 8 hours) or 720 (twice a day), not 100 or 2880. Negative values are not allowed.

0 is allowed for P&L profiles only: closed P&L is then settled immediately when a fill or position update creates it. time still needs a valid HH:mm:ss value. Swap and dividend settlement need an interval greater than 0.
ccy Y USD VARCHAR The CCY setting defines in which currency settlement operations for swaps, dividends, and PL would be booked into wallets. If n/a is defined then the default Account currency configured in AccountGroupSetting will be used.

If settlement processing is delayed, the overdue occurrences are processed close together once it resumes, each using the positions, configuration and conversion rates current at processing time. Missing wallet or profile configuration can interrupt the schedule; after restoring it, verify that settlements have resumed.