SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

CreateCustomerSimple

Customer Module

Customers API

Requires Authentication
Requires the permission:Customer-Setup.ADD
The following routes are available for this service:
POST/Customers/simple/createCreate a customer recordAcCustomerID is primary key
CreateCustomerSimple Parameters:
NameParameterData TypeRequiredDescription
CustomerbodyCustomerSimpleNo
CustomerSimple Parameters:
NameParameterData TypeRequiredDescription
CustomerRecordformAcCustomerSimpleNo
AcCustomerSimple Parameters:
NameParameterData TypeRequiredDescription
AcCustomerIDformstringYesCustomer ID
AcCustomerNameformstringYesCustomer Name
AcTermIDformstringYesTerm ID
AcAreaIDformstringYesArea ID
AcCusGroupIDformstringYesCustomer Group ID
AcCusUDGroupIDformstringYesCustomer User Define Group ID
BillingAddress1formstringNoBilling Address 1
BillingAddress2formstringNoBilling Address 2
BillingAddress3formstringNoBilling Address 3
BillingAddress4formstringNoBilling Address 4
BillingTel1formstringNoBilling Phone 1
BillingTel2formstringNoBilling Phone 2
BillingFax1formstringNoBilling Fax 1
BillingFax2formstringNoBilling Fax 2
BillingPostalCodeformstringNoBilling Postal Code
BillingContact1formstringNoBilling Contact 1
BillingContact2formstringNoBilling Contact 2
BillingEmailformstringNoBilling Email Address
BillingHomePageformstringNoBilling Home Page
IsActiveformstringYesIs Active? (Y/N)
NotesformstringNoNotes
AcCustomerNickNameformstringYesCustomer Nickname
DateOfBirthformDateTimeYesDate of Birth
IsMemberformstringYesIs Member? (Y/N)
GenderformstringYesGender (M/F)
MemberNoformstringYesMember Number
MobileNoformstringNoMobile Number
IdentityNoformstringYesIdentity Number
MemberJoinDateformDateTimeYesMember Join Date
MemberExpireDateformDateTimeYesMember Expiry Date
AcMemberEthnicIDformstringYesMember Ethnic (Race) ID
AcMemberIncomeIDformstringYesMember Income ID
AcMemberOccupationIDformstringYesMember Occupation ID
PriceCodeformstringYesPrice Code. (Value valid from 1 - 5)
AcSalesmanIDformstringYesSalesman ID
MemberNotesformstringNoNotes
EditDateformDateTimeNoEditDate
CreateCustomerSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerformCustomerSimpleNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Customers/simple/create HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCustomerSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:CustomerRecord>
      <d2p1:AcAreaID>String</d2p1:AcAreaID>
      <d2p1:AcCusGroupID>String</d2p1:AcCusGroupID>
      <d2p1:AcCusUDGroupID>String</d2p1:AcCusUDGroupID>
      <d2p1:AcCustomerID>String</d2p1:AcCustomerID>
      <d2p1:AcCustomerName>String</d2p1:AcCustomerName>
      <d2p1:AcCustomerNickName>String</d2p1:AcCustomerNickName>
      <d2p1:AcMemberEthnicID>String</d2p1:AcMemberEthnicID>
      <d2p1:AcMemberIncomeID>String</d2p1:AcMemberIncomeID>
      <d2p1:AcMemberOccupationID>String</d2p1:AcMemberOccupationID>
      <d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
      <d2p1:AcTermID>String</d2p1:AcTermID>
      <d2p1:BillingAddress1>String</d2p1:BillingAddress1>
      <d2p1:BillingAddress2>String</d2p1:BillingAddress2>
      <d2p1:BillingAddress3>String</d2p1:BillingAddress3>
      <d2p1:BillingAddress4>String</d2p1:BillingAddress4>
      <d2p1:BillingContact1>String</d2p1:BillingContact1>
      <d2p1:BillingContact2>String</d2p1:BillingContact2>
      <d2p1:BillingEmail>String</d2p1:BillingEmail>
      <d2p1:BillingFax1>String</d2p1:BillingFax1>
      <d2p1:BillingFax2>String</d2p1:BillingFax2>
      <d2p1:BillingHomePage>String</d2p1:BillingHomePage>
      <d2p1:BillingPostalCode>String</d2p1:BillingPostalCode>
      <d2p1:BillingTel1>String</d2p1:BillingTel1>
      <d2p1:BillingTel2>String</d2p1:BillingTel2>
      <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
      <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:IdentityNo>String</d2p1:IdentityNo>
      <d2p1:IsActive>String</d2p1:IsActive>
      <d2p1:IsMember>String</d2p1:IsMember>
      <d2p1:MemberExpireDate>0001-01-01T00:00:00</d2p1:MemberExpireDate>
      <d2p1:MemberJoinDate>0001-01-01T00:00:00</d2p1:MemberJoinDate>
      <d2p1:MemberNo>String</d2p1:MemberNo>
      <d2p1:MemberNotes>String</d2p1:MemberNotes>
      <d2p1:MobileNo>String</d2p1:MobileNo>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PriceCode>String</d2p1:PriceCode>
    </d2p1:CustomerRecord>
  </Customer>
</CreateCustomerSimple>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCustomerSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:CustomerRecord>
      <d2p1:AcAreaID>String</d2p1:AcAreaID>
      <d2p1:AcCusGroupID>String</d2p1:AcCusGroupID>
      <d2p1:AcCusUDGroupID>String</d2p1:AcCusUDGroupID>
      <d2p1:AcCustomerID>String</d2p1:AcCustomerID>
      <d2p1:AcCustomerName>String</d2p1:AcCustomerName>
      <d2p1:AcCustomerNickName>String</d2p1:AcCustomerNickName>
      <d2p1:AcMemberEthnicID>String</d2p1:AcMemberEthnicID>
      <d2p1:AcMemberIncomeID>String</d2p1:AcMemberIncomeID>
      <d2p1:AcMemberOccupationID>String</d2p1:AcMemberOccupationID>
      <d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
      <d2p1:AcTermID>String</d2p1:AcTermID>
      <d2p1:BillingAddress1>String</d2p1:BillingAddress1>
      <d2p1:BillingAddress2>String</d2p1:BillingAddress2>
      <d2p1:BillingAddress3>String</d2p1:BillingAddress3>
      <d2p1:BillingAddress4>String</d2p1:BillingAddress4>
      <d2p1:BillingContact1>String</d2p1:BillingContact1>
      <d2p1:BillingContact2>String</d2p1:BillingContact2>
      <d2p1:BillingEmail>String</d2p1:BillingEmail>
      <d2p1:BillingFax1>String</d2p1:BillingFax1>
      <d2p1:BillingFax2>String</d2p1:BillingFax2>
      <d2p1:BillingHomePage>String</d2p1:BillingHomePage>
      <d2p1:BillingPostalCode>String</d2p1:BillingPostalCode>
      <d2p1:BillingTel1>String</d2p1:BillingTel1>
      <d2p1:BillingTel2>String</d2p1:BillingTel2>
      <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
      <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:IdentityNo>String</d2p1:IdentityNo>
      <d2p1:IsActive>String</d2p1:IsActive>
      <d2p1:IsMember>String</d2p1:IsMember>
      <d2p1:MemberExpireDate>0001-01-01T00:00:00</d2p1:MemberExpireDate>
      <d2p1:MemberJoinDate>0001-01-01T00:00:00</d2p1:MemberJoinDate>
      <d2p1:MemberNo>String</d2p1:MemberNo>
      <d2p1:MemberNotes>String</d2p1:MemberNotes>
      <d2p1:MobileNo>String</d2p1:MobileNo>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PriceCode>String</d2p1:PriceCode>
    </d2p1:CustomerRecord>
  </Customer>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CreateCustomerSimpleResponse>