Filter inputs
Name | Type | Description | Mandatory | Available from version | Additional information |
---|---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of an account. | |||
Owners | Guid[] | Filter accounts by owners. | |||
AllocationProfile | Guid | Filter accounts for a certain allocation profile. | |||
AccountNos | String[] | Filter accounts by account numbers in BFS. | |||
ExternalReferences | String[] | Filter accounts by external references in BFS. | |||
OwnerAccountLabels | String[] | Filter accounts by account labels in BFS. | |||
AccountStatus | Integer | Filter accounts by account status 1=Open 2=Closed 4=Hidden (hidden on customer front end) | |||
AccountTypeKeys | String[] | Get all accounts for one or more account types | |||
AccountWorlds | String[] | Get accounts with chosen AccountWorlds. | 2.28 | Available AccountWorlds:
| |
ResellerNos | String[] | CustomerNo for reseller | |||
Resellers | Guid[] | Ids of resellers for accounts | |||
CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | |||
CreatedDateTo | DateTime | ||||
AccountComments | String[] | Filter accounts by account comments | 2.02 | ||
InsuranceOwners | Guid[] | Filter accounts by Insurance Owners. Only available if addon Insurance Accounts is enabled. | 2.07 | ||
Insureds | Guid[] | Filter accounts by Insureds. Only available if addon Insurance Accounts is enabled. | 2.07 | ||
InsurancePayers | Guid[] | Filter accounts by Insurance Payers. Only available if addon Insurance Accounts is enabled. | 2.07 | ||
ContactLegalEntitites (will change to ContactLegalEntities in 2.25) | Guid[] | Filter accounts by Contact Legal Entitites | 2.07 | ||
FirstPaymentAge | Integer | The age of the person when the first payout should start | 2.09 | ||
FirstPaymentDateFrom | DateTime | FromDate for First date for payout | 2.09 | ||
FirstPaymentDateTo | DateTime | FromDate for First date for payout | 2.09 | ||
PaymentIntervalKey | String | Interval for payouts | 2.09 | ||
PaymentLength | Integer | Number of total payouts | 2.09 | ||
Payouts | Integer | Number of payouts that has been processed | 2.09 | ||
PayoutsLeft | Integer | Remaining number of payouts | 2.09 | ||
HighWaterMark | Decimal | High water mark for account | 2.12 | ||
DecisionMakers | Guid[] | DecisionMakers for account. DecisionMaker is a reference to a LegalEntity in BFS | 2.19 | ||
LockedStatusKey | String[] | Must be one of these values: Open, LockedAdmin, LockedPartner, LockedFront | 2.23 | ||
IBANs | string[] | The International bank account number. | 2.30 | ||
IsSubjectToContinuousInvestmentAdvice | bool | A flag that marks an account where continuous investment advice is given. This is used when reporting K-Factor values for securities firms among other things. The K-Factor Reporting App is available in our Marketplace. | 2.36 | ||
CounterpartyAccountTypes | CounterpartyAccountType[] | CounterpartyAccountType is an enum which can be: Intermediary or Issuer. | 2.38 | ||
CustodianBrickIds | Guid[] | Filter accounts by Custodians. | 2.41 |
...
Name | Type | Description | Available from version | Additional Information | |||
---|---|---|---|---|---|---|---|
BrickId | Guid | The BrickId of the account | |||||
CreatedDate | DateTime | The date when the account was created | 2.02.20160429 | ||||
AccountNo | String | The account number of the account | |||||
BaseCurrencyCode | String | The currency code of the accounts base currency | |||||
OwnerAccountLabel | String | The label of the account | |||||
Owner | Guid | The BrickId of the owner of the account | |||||
AccountTypeKey | String | Account type of the account | |||||
AccountStatus | Integer | 1=Open 2=Closed 4=Hidden (hidden on customer front end) | |||||
AccountWorld | String | Account world of the account | 2.28 | ||||
ExternalReference | String | External reference of the account | |||||
AllocationProfile | Guid | The associated allocation profile (portfolio) of the account | |||||
Reseller | Guid | The BrickId of the associated reseller for the account | |||||
ResellerNo | String | The reseller number of the associated reseller for the account | |||||
AccountComment | String | Account comment of the account | 2.02 | ||||
InsuranceOwner | Guid | Insurance Owner of the account. Only available if addon Insurance Accounts is enabled. | 2.07 | ||||
Insured | Guid | Insured of the account. Only available if addon Insurance Accounts is enabled. | 2.07 | ||||
InsurancePayer | Guid | Insurance Payer of the account. Only available if addon Insurance Accounts is enabled. | 2.07 | ||||
ContactLegalEntity | Guid | Contact Legal Entity of the account | 2.07 | ||||
CustomFields | Object[] | Array of CustomFields | 2.09 | ||||
FirstPaymentAge | Integer | The age of the person when the first payout should start | |||||
FirstPaymentDate | DateTime | First date for payout | |||||
PaymentIntervalKey | String | Interval for payouts | |||||
PaymentLength | Integer | Number of total payouts | |||||
Payouts | Integer | Number of payouts that has been processed | |||||
PayoutsLeft | Integer | Remaining number of payouts | |||||
HighWaterMark | Decimal | High water mark for account | 2.12 | ||||
DecisionMaker | Guid | DecisionMaker for account. DecisionMaker is a reference to a LegalEntity in BFS | 2.19 | ||||
LockedStatusKey | bool | Tells if the account is locked or not | 2.23 | ||||
IBAN | string | The International bank account number. | 2.30 | ||||
IsSubjectToContinuousInvestmentAdvice | bool | A flag that marks an account where continuous investment advice is given. This is used when reporting K-Factor values for securities firms among other things. The K-Factor Reporting App is available in our Marketplace. | 2.36 | CustodianBrickId | Guid | The Custodian of the account. | |
2.38 | CounterpartyAccountType | CounterpartyAccountType | CounterpartyAccountType is an enum which can be: Intermediary or Issuer. | 2.38 | |||
CustodianBrickId | Guid | The Custodian of the account. | 2.41 |
XML request example
Code Block | ||
---|---|---|
| ||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GetAccounts xmlns="http://tempuri.org/"> <req> <Credentials> <UserName>yourusername</UserName> <Password>yourpassword</Password> </Credentials> <identify>youridentifier</identify> <Args> <AllocationProfile xsi:nil="true" /> <ExternalReferences> <string>1234</string> </ExternalReferences> <AccountStatus xsi:nil="true" /> <CreatedDateFrom xsi:nil="true" /> <CreatedDateTo xsi:nil="true" /> </Args> <Fields> <BrickId>true</BrickId> <AccountNo>true</AccountNo> <BaseCurrencyCode>true</BaseCurrencyCode> <OwnerAccountLabel>true</OwnerAccountLabel> <Owner>true</Owner> <AccountTypeKey>true</AccountTypeKey> <AccountStatus>true</AccountStatus> <ExternalReference>true</ExternalReference> <AllocationProfile>true</AllocationProfile> <AccountComment>true</AccountComment> </Fields> </req> </GetAccounts> </s:Body> </s:Envelope> |
...