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 13 Next »

Inputs (Array of Accounts to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidThis is the unique id of the account that should be updatedYes
OwnerAccountLabelstringThis is the label/title of the account.

AccountStatusint?

1=Open

2=Closed

4=Hidden (hidden on customer front end)

The value given here will be used to update the database



AllocationProfileGuid?This is the unique id of an allocation profile record.

ExternalReferencestringThe value given here will be used to update the database

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

InsuranceOwnerGuid?Only available if addon Insurance Accounts is enabled.
2.07
InsuredGuid?Only available if addon Insurance Accounts is enabled.
2.07
InsurancePayerGuid?Only available if addon Insurance Accounts is enabled.
2.07
ContactLegalEntityGuid?

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
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
ResellerNostringCustomer number of the reseller that is to be accosiated with the account
2.14

Outputs

Name
Type
Description
Available from version
EntitiesArray

All accounts in the request is returned along with each accounts BrickId, OwnerAccountLabel, AccountStatus,AllocationProfile,ExternalReference,RequestReference and array of Errors per account


Code examples

C# - Update an account title
 //Update an account with the UpdateAccount 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.UpdateAccounts(new BFSServiceReference.UpdateAccountsRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
    Fields = new UpdateAccountFields()
    {
      OwnerAccountLabel  = true,      
    },
    Entities = new []
    {
      new UpdateAccount()
      {
          BrickId = bnuseraccountid,
          OwnerAccountLabel = "Test2",         
      },
    },
    
});
foreach (var c in response.Entities)
{
    Console.WriteLine(c.BrickId + "," + c.OwnerAccountLabel + "," + response.Message);
}


Blog stream

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

  • No labels