Skip to end of metadata
Go to start of metadata

Inputs (Array of Accounts) inherits from EntityBase

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


Outputs

Name
Type
Description
Available from version
EntitiesArray

All accounts in the request is returned along with each accounts BrickId, AccountNo and array of Errors per account




XML request example
<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">
    <CreateAccounts xmlns="http://tempuri.org/">
      <req>
        <Credentials>
          <UserName>yourusername</UserName>
          <Password>yourpassword</Password>
        </Credentials>
        <identify>youridentifier</identify>
        <Entities>
          <Account>
            <BrickId>00000000-0000-0000-0000-000000000000</BrickId>
            <OwnerAccountLabel>Test</OwnerAccountLabel>
            <Owner>9eefe173-8d54-4dc3-b8f7-5ac7bccdeec6</Owner>
            <AccountTypeKey>HoldingAccount</AccountTypeKey>
            <BaseCurrencyCode>SEK</BaseCurrencyCode>
            <AccountStatus xsi:nil="true" />
            <AllocationTemplate>00000000-0000-0000-0000-000000000000</AllocationTemplate>
            <ExternalReference>123456789</ExternalReference>
          </Account>
        </Entities>
      </req>
    </CreateAccounts>
  </s:Body>

Code examples

C# - Create an account in a BFS instance
//Create a new account with the CreateAccount method
var client = new BFSServiceReference.bfsapiSoapClient();

var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};

var response = client.CreateAccounts(new BFSServiceReference.CreateAccountRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS    

    Entities = new[]
    {
        new Account()
        {
			AccountTypeKey = "HoldingAccount",
            Owner = bnuserbrickid,
            OwnerAccountLabel = "Test",
            BaseCurrencyCode = "SEK",
            ExternalReference = "123456789",
            AccountStatus = 1,
            RequestReference = "My system reference",
            AcquisitionValueCalculationMethod = "Average",
			CustomFields=new CustomField[]
            {
                new CustomField
                {
                    FieldName = "TestField1",
                    Value = "Testvalue1"
                },
                new CustomField
                {
                    FieldName = "TestField2",
                    Value = "0.25"
                }
            }
        }
    }

});

foreach (var c in response.Entities)
{
    Console.WriteLine(c.AccountNo);
}


Blog Posts