Versions Compared

Key

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

...

NameTypeDescription
BrickId The BrickId of the Legal Entity
FirstNamestringThe first name of the Legal Entity
LastNamestringThe last name of the Legal Entity
MiddleNamesstringThe middle name of the Legal Entity
UserNamestringThe username of the Legal Entity
EmailstringThe email of the Legal Entity
PersonalNumberstringThe tax identification number of the Legal Entity
ResellerNostringThe reseller number of the Legal Entity
ResellerIdGuidThe reseller id of the Legal Entity
IsApprovedboolIf true the Legal Entity is approved (activated) in the BFS instance and can login
AddressCitystringThe name of the city where the Legal Entity resides
AddressStreetstringThe name of the street where the Legal Entity resides
AddressZipstringThe postal code where the Legal Entity resides
BICstring 
Commentstring A free text comment that can be used for a Legal Entity
ExternalReferencestring An external reference that can be used for a Legal Entity to for example link the Legal Entity to an external system with the id of the Legal Entity in the external system
PassportNumberstring The passport number of the Legal Entity
PhoneHomestring The phone number of the Legal Entity
PhoneWorkstring The work phone number of the Legal Entity
IsTaxPayerbool If true the Legal Entity will be subject to tax reporting and tax withholding
IsInsuranceCompanybool If the Legal Entity is categorized as an insurance company
IsInsuranceProductSupplierbool If the Legal Entity is categorized as a product supplier for insurance products
IsApprovedForStructsbool If the Legal Entity is approved for investing in structured products
IsVerifiedbool If the Legal Entity is verified according to Know Your Customer regulations
GenderstringValue should be Male, Female, Company
TitlestringValue should be Miss, Mr, Ms, Dr, Mrs
CountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
TaxCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
CustomerNostring The customer number of the Legal Entity

Code examples

Code Block
languagec#
themeRDark
titleC# - Get all legal entities from a BFS instance
linenumberstrue
collapsetrue
//Use the GetPersons method to get all LegalEntities in the BFS instance and write
//the BrickId's and names 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 persons = client.GetPersons(new BFSServiceReference.GetPersonRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
   
    Fields = new BFSServiceReference.GetPersonFields()
    {
        BrickId = true,
        UserName = true,
        FirstName = true,
        LastName = true,
    },
});
foreach (var c in persons.Result)
{
    Console.WriteLine(c.BrickId + "," + c.FirstName + "," + c.LastName);
}

...