Difference between revisions of "API/Services/CreateAccount"

Revision as of 15:38, 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:

8. AccountType needs to be ‘End User

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

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

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

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

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

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

15. 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.

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

Company Types

17. BillingContact is optional. If BillingContact - Detail - Title value is given then script will check all fields and will add Billing Contact.

18. Country and State needs to be a text value from either name or code.

19. Currently only Australian STATES are supported

20. In case of any other country please use ‘Other’ or ‘oth’ as a state value