Difference between revisions of "API/Services/CreateAccount"

Revision as of 14:57, 10 September 2014

Create Account

Purpose Create a new account as a child of the callers account. This is a slightly more complex version than the one in Minimal.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:CreateComplexAccount>
        <ser:LicenceeUsername>?</ser:LicenceeUsername>
        <ser:AccountType>?</ser:AccountType>
        <ser:PrimaryContact>
           <ser:Detail>
              <ser:Title>?</ser:Title>
              <ser:FirstName>?</ser:FirstName>
              <ser:LastName>?</ser:LastName>
              <ser:AddressLine1>?</ser:AddressLine1>
              <ser:AddressLine2>?</ser:AddressLine2>
              <ser:AddressLine3>?</ser:AddressLine3>
              <ser:Suburb>?</ser:Suburb>
              <ser:State>?</ser:State>
              <ser:Postcode>?</ser:Postcode>
              <ser:Country>?</ser:Country>
              <ser:EmailAddress>?</ser:EmailAddress>
              <ser:PhoneNumber>?</ser:PhoneNumber>
              <ser:MobileNumber>?</ser:MobileNumber>
              <ser:FaxNumber>?</ser:FaxNumber>
              <ser:Website>?</ser:Website>
           </ser:Detail>
           <ser:CumulusUser>
              <ser:UserName>?</ser:UserName>
              <ser:Password>?</ser:Password>
           </ser:CumulusUser>
        </ser:PrimaryContact>
        <ser:AccountContactType>
           <ser:Type>?</ser:Type>
        </ser:AccountContactType>
        <ser:AccountOrganisation>
           <ser:OrgName>?</ser:OrgName>
           <ser:OrgTradingName>?</ser:OrgTradingName>
           <ser:OrgType>?</ser:OrgType>
           <ser:OrgIdentifier>?</ser:OrgIdentifier>
           <ser:OrgIdentifierType>?</ser:OrgIdentifierType>
        </ser:AccountOrganisation>
        <ser:BillingContact>
           <ser:Detail>
              <ser:Title>?</ser:Title>
              <ser:FirstName>?</ser:FirstName>
              <ser:LastName>?</ser:LastName>
              <ser:AddressLine1>?</ser:AddressLine1>
              <ser:AddressLine2>?</ser:AddressLine2>
              <ser:AddressLine3>?</ser:AddressLine3>
              <ser:Suburb>?</ser:Suburb>
              <ser:State>?</ser:State>
              <ser:Postcode>?</ser:Postcode>
              <ser:Country>?</ser:Country>
              <ser:EmailAddress>?</ser:EmailAddress>
              <ser:PhoneNumber>?</ser:PhoneNumber>
              <ser:MobileNumber>?</ser:MobileNumber>
              <ser:FaxNumber>?</ser:FaxNumber>
              <ser:Website>?</ser:Website>
           </ser:Detail>
        </ser:BillingContact>
        <ser:AccountReference>?</ser:AccountReference>
     </ser:CreateComplexAccount>
  </soapenv:Body>

Important notes:

- AccountType needs to be ‘End User’

- CumulusUser-Username has to be the fully qualified domain name i.e. username@domain.com.au

- CumulusUser-Password needs to be a minimum of 6 characters

- AccountContactType needs to be Either ‘Individual’ or ‘Organisation’. In case of ‘Organisation’ ‘Org’ can be used as alternative option.

- OrgIdentifierType needs to be one of ‘ABN’, ‘ACN’, ‘RBN’ or ‘TFN’

- OrgIdentifier is the value attached to the type. i.e. for ‘ABN’ you would put your ABN number here.

- Account reference will be stored against the account as an optional piece of text.

- This will automatically place the default account profile of your SP against the account. If you need a non-default profile, this will need to be managed manually via the Cumulus interface.

- OrgType is an integer value and can accept any of the below. If not given default will be 29 ‘Company’