Client

Service for registering client.

RegisterClient

Register new client

Examples

Sample usage in C# with generated client: 
ClientClient client = new ClientClient();
RegisterClientRequest registerClientRequest = new RegisterClientRequest
{
IDNumber = "490709-8299",
FullName = "ClientFullName",
Street = "Streetofcreditor",
City = "Cityofcreditor",
ZipCode = "12345",
CountryCode = "SE",
LanguageCode = "SE",
CurrencyCode = "SEK",
CountryCodeOfOperation = "SE"
};
RegisterClientResult registerClientResult = new RegisterClientResult();
client.RegisterClient(new SessionHeader(), registerClientRequest, out registerClientResult);
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:RegisterClient>
            <urn:client>
                <urn:City>City</urn:City>
                <urn:CountryCode>SV</urn:CountryCode>
                <urn:CurrencyCode>SEK</urn:CurrencyCode>
                <urn:FullName>ClientName</urn:FullName>
                <urn:IDNumber>556655-6659</urn:IDNumber>
                <urn:LanguageCode>EN</urn:LanguageCode>
                <urn:Street>Street</urn:Street>
                <urn:ZipCode>54140</urn:ZipCode>
            </urn:client>
        </urn:RegisterClient>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • client Mandatory

    Client identification parameters.
    Object

    RegisterClient

    RegisterClient class

    • RegisterClientRequest

      Register client request
      Object

      RegisterClientRequest

      General class for representing input of method RegisterClient.

      • Bankaccounts

        List of creditor bank accounts.
        Array
        Object

        PartyBankAccount

        Party bank account information

        • AccessGroups

          AccessGroups value.

          string

        • AccountBalance

          Account balance value.

          decimal

        • AccountingCode

          Accounting code.

          string

        • AccountingCodeOverpayments

          Accounting code, overpayments.

          string

        • AccountingCodeUnspecified

          Accounting code, unspecified.

          string

        • AllowDisbursementsFrom Mandatory

          Is disbursement allowed from this account.

          bool

        • AllowDisbursementsTo Mandatory

          Is disbursement allowed to this account.

          bool

        • AllowPayments Mandatory

          Account payment allowance type.
          Enum

          BankAccountAllowPayments

          How bank account will allow payments.

          • No

            Not at all.

          • AllowPayments

            Allow payments.

          • AllowNettings

            Allow nettings.

        • Bank

          Bank reference code (dat_party.referencecode (partytypeid = _BANK)).

          string

        • BankAccountClass

          Bank account class, corresponding to one of predefined codes (cfg_bankaccountclass.bankaccountclasscode)

          string

        • BankAccountNo Mandatory

          Account number.

          string

        • BankAccountOwnerType Mandatory

          Account owner type.
          Enum

          BankAccountOwnerType

          Type of owner for bank account.

          • Solicitor

            Solicitor.

          • Creditor

            Creditor.

          • Debtor

            Debtor.

        • BankCode

          Account code.

          string

        • BankDescription

          Bank description.

          string

        • BIC

          BIC.

          string

        • BLZ

          BLZ.

          string

        • BusinessAccount Mandatory

          Is a business account.

          bool

        • City

          City.

          string

        • Condition

          Condition value.

          string

        • CountryCode Mandatory

          Account country code.

          string

        • CurrencyCode Mandatory

          Currency code, e.g. SEK, NOK, EUR etc.

          string

        • Description Mandatory

          Account description.

          string

        • IBAN

          IBAN.

          string

        • InternalCode Mandatory

          Account internal code.

          string

        • OCRDefinition

          OCR definition.

          string

        • PowerOfAttourney Mandatory

          PowerOfAttourney flag.

          bool

        • SWIFT

          SWIFT.

          string

        • ThirdPartyRemittance Mandatory

          Third party remitance flag.

          bool

        • ZipCode

          Zip code.

          string

      • CellularPhone

        Cellular phone.

        string

      • City Mandatory

        City.

        string

      • Contract

        Creditor contract.
        Object

        CreditorContract

        Holds creditor contract details.

        • CancelDate

          Contract cancel date.

          DateTime

        • ContractCancelReason

          Contract cancel reason.

          string

        • ContractLength

          Contract duration (month).

          int

        • ContractNumber

          Contract number.

          string

        • ContractType

          Contract type.
          Enum

          CreditorContractType

          Type of creditor contract types.

          • Continuous

            Continuous.

          • Limited

            Limited.

        • CustomerCategory

          Customer category id (lookup to cfg_customercategory).

          int

        • EndDate

          Contract expiration date.

          DateTime

        • Instructions

          Contract instructions.

          string

        • InvoiceDate

          Contract invoice date.

          DateTime

        • InvoiceItem

          Invoice item number.

          string

        • Note

          Contract note.

          string

        • PeriodFee

          Contract period fee.

          decimal

        • PeriodLength

          Contract period duration (month).

          int

        • StartDate Mandatory

          Contract commencement date.

          DateTime

      • CountryCode Mandatory

        Country code.

        string

      • CountryCodeOfOperation Mandatory

        Country code of operation.

        string

      • CreditorReference

        Party reference code.

        string

      • CRMUser

        CRM user (usercode from dat_user).

        string

      • CurrencyCode Mandatory

        Currency code.

        string

      • DefaultCultureCode

        Default culture code.

        string

      • Email

        Email.

        string

      • ExtraFields

        List of creditor extra fields.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • FactoringLoan

        Factoring loan.
        Object

        FactoringLoan

        Factoring loan description.

        • Autopercent Mandatory

          Auto percent value (a percentage from 0 to 100).

          decimal

        • DecisionDate Mandatory

          Decision date.

          DateTime

        • InterestCode Mandatory

          Interest code value (cfg_interest).

          string

        • InterestRate Mandatory

          Interest rate value.

          decimal

        • Limit Mandatory

          Limit value.

          decimal

        • LimitFee

          Limit fee amount.

          decimal

        • LimitFeeDate

          Limit fee date.

          DateTime

        • LimitFeeInterval

          Limit fee interval.

          int

        • LimitFeeInvoiceItem

          Limit fee invoice item number.

          string

        • LimitFeePartOfPeriod Mandatory

          Limit fee part of period flag.

          bool

        • LimitFeePartOfPeriodAmount Mandatory

          Limit fee part of period amount.

          decimal

        • Maxpercent Mandatory

          Max percent value (a percentage from 0 to 100).

          decimal

        • Note

          Note.

          string

        • OurReference

          Our reference value.

          string

        • YourReference

          Your reference value.

          string

      • FullName Mandatory

        Creditor full name.

        string

      • GLNNumber

        GLN number.

        string

      • HouseNumber

        House number.

        string

      • HouseNumberExtention

        House number extention.

        string

      • IDNumber Mandatory

        Creditor ID number.

        string

      • InformalName

        Creditor informal name.

        string

      • InternalPhone

        Internal phone.

        string

      • InvoiceSenderId

        Invoice sender id.

        string

      • JuridicalType

        Juridical type of creditor
        Enum

        JuridicalType

        Type of person, juridically.

        • NaturalPerson

          Actual person.

        • JuridicalPerson

          Juridical person, e.g a company.

      • LanguageCode Mandatory

        Language code.

        string

      • LedgerType

        Ledger type.
        Enum

        CreditorLedgerType

        Type of creditor ledger types.

        • LedgerOnCreditor

          New ledger on creditor.

        • LedgerOnParentCreditor

          Use ledger on parent creditor.

        • LedgerOnSolicitor

          Use ledger on solicitor.

      • LEINumber

        LEI number.

        string

      • Logotype

        Base64-encoded logo.

        string

      • MunicipalCode

        Municipal code.

        string

      • NACECode

        NACE code.

        string

      • Parameters

        List of creditor parameters.
        Array
        Object

        PartyParameter

        Holds party parameter value information.

        • ParameterCode Mandatory

          Parameter code.

          string

        • Value Mandatory

          Parameter value.

          string

      • ParentReference

        Parent party reference code.

        string

      • StateCode

        State code.

        string

      • Street Mandatory

        Street name.

        string

      • Telefax

        Telefax.

        string

      • TemplateAccountChart

        Template account chart (description from dat_ledger).

        string

      • TemplateParameters

        Template parameters name (to copy solicitor template).

        string

      • TemplatePricelist

        Template pricelist (comma separated list of template names from dat_pricelist) .

        string

      • Users

        List of creditor users.
        Array
        Object

        PartyUser

        Party user information

        • CellularPhone

          Cellular phone

          string

        • City

          City

          string

        • CountryCode Mandatory

          Country code

          string

        • Email

          Email

          string

        • Fax

          Fax

          string

        • FullName Mandatory

          Full name

          string

        • HomePhone

          Home phone

          string

        • HouseNumber

          House number

          string

        • HouseNumberExtention

          House number extention

          string

        • InternalPhone

          Internal phone

          string

        • LanguageCode Mandatory

          Language code, e.g. en, sv etc.

          string

        • Password

          Password (will be generated automatically if it is not specified).

          string

        • StateCode

          State code

          string

        • Street

          Street

          string

        • UserName

          User name

          string

        • UserRole

          User role (cfg_userrole.rolecode). Will be set to INVOICE by default if it is not specified.

          string

        • WorkPhone

          Work phone

          string

        • ZipCode

          Zip code

          string

      • VATNumber

        VAT number.

        string

      • VATType

        VAT type code (cfg_vattype).

        string

      • WebLogotype

        Base64-encoded weblogo.

        string

      • WorkPhone

        Work phone.

        string

      • ZipCode Mandatory

        Zip code.

        string

Output

Client guid.
Error codes:
  • ERROR CODES SHOULD BE SPECIFIED HERE
Object

RegisterClientResponse

RegisterClient response.

  • RegisterClientResult

    Results of RegisterClient.
    Object

    RegisterClientResult

    General class for representing method output.

    • ClientGuid Mandatory

      Client unique identifier.

      string

    • Result Mandatory

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string