GetAccounts

Filter inputs

Name
Type
Description
MandatoryAvailable from versionAdditional information
BrickIdsGuid[]

Filter by array of BrickIds. BrickId is the internal id of an account.




OwnersGuid[]Filter accounts by owners.


AllocationProfileGuidFilter accounts for a certain allocation profile.


AccountNosString[]Filter accounts by account numbers in BFS.


ExternalReferencesString[]Filter accounts by external references in BFS.


OwnerAccountLabelsString[]Filter accounts by account labels in BFS.


AccountStatusInteger

Filter accounts by account status

1=Open

2=Closed

4=Hidden (hidden on customer front end)





AccountTypeKeysString[]Get all accounts for one or more account types


AccountWorldsString[]Get accounts with chosen AccountWorlds.
2.28Available AccountWorlds: 
  • SystemAccount
  • CustodyAccount
ResellerNosString[]CustomerNo for reseller


ResellersGuid[]Ids of resellers for accounts


CreatedDateFromDateTimeWhen used, both from date and to date should be provided in the request


CreatedDateToDateTime


AccountCommentsString[]Filter accounts by account comments
2.02
InsuranceOwnersGuid[]Filter accounts by Insurance Owners. Only available if addon Insurance Accounts is enabled.
2.07
InsuredsGuid[]Filter accounts by Insureds. Only available if addon Insurance Accounts is enabled.
2.07
InsurancePayersGuid[]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
FirstPaymentAgeIntegerThe age of the person when the first payout should start
2.09
FirstPaymentDateFromDateTimeFromDate for First date for payout
2.09
FirstPaymentDateToDateTimeFromDate for First date for payout
2.09
PaymentIntervalKeyStringInterval for payouts
2.09
PaymentLengthIntegerNumber of total payouts
2.09
PayoutsIntegerNumber of payouts that has been processed
2.09
PayoutsLeftIntegerRemaining number of payouts
2.09
HighWaterMarkDecimalHigh water mark for account
2.12
DecisionMakersGuid[]DecisionMakers for account. DecisionMaker is a reference to a LegalEntity in BFS
2.19Decision Maker
LockedStatusKeyString[]Must be one of these values: 

Open, LockedAdmin, LockedPartner, LockedFront


2.23
IBANsstring[]The International bank account number.
2.30

Response rows (Array) inherits from EntityBase

Name
Type
Description
Available from versionAdditional Information
BrickIdGuid

The BrickId of the account



CreatedDateDateTimeThe date when the account was created2.02.20160429
AccountNoStringThe account number of the account

BaseCurrencyCodeStringThe currency code of the accounts base currency

OwnerAccountLabelStringThe label of the account

OwnerGuidThe BrickId of the owner of the account

AccountTypeKeyStringAccount type of the account

AccountStatusInteger

1=Open

2=Closed

4=Hidden (hidden on customer front end)



AccountWorldStringAccount world of the account2.28
ExternalReferenceStringExternal reference of the account

AllocationProfileGuidThe associated allocation profile (portfolio) of the account

ResellerGuidThe BrickId of the associated reseller for the account

ResellerNoStringThe reseller number of the associated reseller for the account

AccountCommentStringAccount comment of the account2.02
InsuranceOwnerGuidInsurance Owner of the account. Only available if addon Insurance Accounts is enabled.2.07
InsuredGuidInsured of the account. Only available if addon Insurance Accounts is enabled.2.07
InsurancePayerGuidInsurance Payer of the account. Only available if addon Insurance Accounts is enabled.2.07
ContactLegalEntityGuidContact Legal Entity of the account2.07
CustomFieldsObject[]Array of CustomFields2.09CustomFields[]
FirstPaymentAgeIntegerThe age of the person when the first payout should start

FirstPaymentDateDateTimeFirst date for payout

PaymentIntervalKeyStringInterval for payouts

PaymentLengthIntegerNumber of total payouts

PayoutsIntegerNumber of payouts that has been processed

PayoutsLeftIntegerRemaining number of payouts

HighWaterMarkDecimalHigh water mark for account2.12
DecisionMakerGuidDecisionMaker for account. DecisionMaker is a reference to a LegalEntity in BFS2.19Decision Maker
LockedStatusKeyboolTells if the account is locked or not2.23
IBANstringThe International bank account number.2.30



Code examples