Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

Filter inputs

Name
Type
Description
MandatoryAvailable from version
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)




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

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
ContactLegalEntititesGuid[]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

Response rows (Array) inherits from EntityBase

Name
Type
Description
Available from version
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)


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[]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
FirstPaymentDateDateTimeFirst date for payout
PaymentIntervalKeyStringInterval for payouts
PaymentLengthIntegerNumber of total payouts
PayoutsIntegerNumber of payouts that has been processed
PayoutsLeftIntegerRemaining number of payouts



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">
    <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>

Code examples

C# - Get all accounts from a BFS instance
//Use the GetAccounts method to get all accounts in the system and write out account numbers
//in the console
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 accounts = client.GetAccounts(new BFSServiceReference.GetAccountsRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
    
    Fields = new BFSServiceReference.GetAccountFields()
    {
        BrickId = true,
        AccountNo = true,
        BaseCurrencyCode = true,
        OwnerAccountLabel = true,
        Owner = true,
        AccountTypeKey = true,
        AccountStatus = true,
        ExternalReference = true,
        AllocationProfile = true,
    },
});
foreach (var c in accounts.Result)
{
    Console.WriteLine(c.AccountNo);
}
C# - Get all accounts that are open from a BFS instance
//Use the GetAccounts method to get all accounts in the system and write out account numbers
//in the console
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 accounts = client.GetAccounts(new BFSServiceReference.GetAccountsRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
    Args = new BFSServiceReference.GetAccountsArgs()
    {        
        AccountStatus = 1,
    },
    Fields = new BFSServiceReference.GetAccountFields()
    {
        BrickId = true,
        AccountNo = true,
        BaseCurrencyCode = true,
        OwnerAccountLabel = true,
        Owner = true,
        AccountTypeKey = true,
        AccountStatus = true,
        ExternalReference = true,
        AllocationProfile = true,
    },
});
foreach (var c in accounts.Result)
{
    Console.WriteLine(c.AccountNo);
}


Blog stream

Create a blog post to share news and announcements with your team and company.


  • No labels