Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name
Type
Description
MandatoryAvailable from version
BrickIdGuidNot used.

OwnerAccountLabelString

Label of the account



OwnerGuidOwner of the accountTrue
AccountTypeKeyStringThe account type key of the account. Available account types can be found in BFS admin by navigating to System Data -> Account typesTrue
BaseCurrencyCodeStringThe base currency of the account. Available currencies can be found in BFS admin by navigating to System Data -> CurrenciesTrue
AccountStatusInteger

1=Open

2=Closed

4=Hidden (hidden on customer front end)

True
ExternalReferenceStringExternal reference of the account

AllocationTemplateGuid (Nullable)If the account should be associated with an allocation template

RequestReferenceStringAn external reference that's provided by the requester. Can be used to map the returned BrickId on requesters side.

AcquisitionValueCalculationMethodStringDetermines the method to be used for calculating the acquisition value of positions within the account. Default is "Average" which sums together the value for each purchase and uses that value as the acquisition value for a sale. If nothing is entered as the input it will default to "Average". For some instances "FIFO" will be available as a selection and this will show in the back office GUI.

AccountCommentStringComment for account
2,02
InsuranceOwnerGuid (Nullable)InsuranceOwner for account. Only available if addon Insurance Accounts is enabled.
2.07
InsuredGuid (Nullable)Insured for account. Only available if addon Insurance Accounts is enabled.
2.07
InsurancePayerGuid (Nullable)InsurancePayer for account. Only available if addon Insurance Accounts is enabled.
2.07
ContactLegalEntityGuid (Nullable)ContactLegalEntity for account. From version 2.09 this will be default to owner of the account.
2.07
CustomFieldsObject[]CustomFields is an array of CustomField objects. Each CustomField consists of two strings, FieldName and Value. There are no datatypes associated with these properties, they are just a way for api-users to add custimized data to the object.
2,09
FirstPaymentAgeIntegerThe age of the person when the first payout should start

2,09

FirstPaymentDateDateTimeFirst date for payout
2,09
PaymentIntervalKeyStringInterval for payouts
2,09
PaymentLengthInteger“Number of total payouts
2,09
PayoutsIntegerNumber of payouts that has been processed
2,09
PayoutsLeftIntegerRemaining number of payouts
2,09

...