POST POS/Customers Try Now
Adds the Customer.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|
Body Parameters
The request.
Name | Description | Type | Additional information |
---|---|---|---|
ShippingInfo |
The shipping information.
|
ContactRequest |
Required
|
BillingInfo |
The billing information.
|
ContactRequest |
Required
|
ClientType |
The type of the client.
|
string |
Optional - By default consider as Individual
|
Notes |
The notes.
|
string |
None.
|
IsPreferredVendor |
Indicates whether this instance is preferred vendor.
|
boolean |
None.
|
IsPreferredClient |
Indicates whether this instance is preferred client.
|
boolean |
None.
|
PaymentMethod |
The payment mode.
|
PaymentMode |
None.
|
Tags | Collection of string |
None.
|
|
MasterZoneCode | Zone |
None.
|
Request Formats
application/json, text/json
Sample:
{ "ShippingInfo": { "Company": "", "JobTitle": "", "FirstName": "", "LastName": "", "Address1": "", "Address2": "", "Email": "", "CountryId": "", "Country": "", "StateId": "", "State": "", "City": "", "Zip": "", "TimeZoneId": "", "Phones": [ { "PhoneId": "", "PhoneType": "Home", "Phone": "", "Extension": "", "IsPrimary": true } ], "StateOther": "", "ReferenceId": "" }, "BillingInfo": { "Company": "", "JobTitle": "", "FirstName": "", "LastName": "", "Address1": "", "Address2": "", "Email": "", "CountryId": "", "Country": "", "StateId": "", "State": "", "City": "", "Zip": "", "TimeZoneId": "", "Phones": [ { "PhoneId": "", "PhoneType": "Home", "Phone": "", "Extension": "", "IsPrimary": true } ], "StateOther": "", "ReferenceId": "" }, "ClientType": "", "Notes": "", "IsPreferredVendor": true, "IsPreferredClient": true, "PaymentMethod": "Any", "Tags": [ "" ], "MasterZoneCode": "Any" }
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
CustomerId |
The customer identifier.
|
string |
None.
|
ShippingInfo |
The shipping information.
|
ContactResponse |
None.
|
BillingInfo |
The billing information.
|
ContactResponse |
None.
|
Notes |
The notes.
|
string |
None.
|
IsPreferredVendor |
A value indicating whether this instance is preferred vendor.
|
boolean |
None.
|
IsPreferredClient |
A value indicating whether this instance is preferred client.
|
boolean |
None.
|
PaymentMethod |
The payment mode.
|
PaymentMode |
None.
|
ZoneCode |
The zone.
|
Zone |
None.
|
ClientType |
The type of the client.
|
string |
None.
|
CustomerNumber |
The customer number.
|
long |
None.
|
Tags |
The tags.
|
Collection of string |
None.
|
IsDeleted |
To indicate if customer or contact get deleted.
|
boolean |
None.
|
MasterZonecode | Zone |
None.
|
Response Formats
application/json, text/json
Sample:
{ "CustomerId": "", "ShippingInfo": { "ContactId": "", "CustomerId": "", "Company": "", "JobTitle": "", "FirstName": "", "LastName": "", "Address1": "", "Address2": "", "Email": "", "CountryId": "", "Country": "", "StateId": "", "State": "", "StateOther": "", "City": "", "Zip": "", "ReferenceId": "", "Phones": [ { "PhoneId": "", "PhoneType": "Home", "Phone": "", "Extension": "", "IsPrimary": true, "IsDeleted": true } ], "TimeZoneId": "" }, "BillingInfo": { "ContactId": "", "CustomerId": "", "Company": "", "JobTitle": "", "FirstName": "", "LastName": "", "Address1": "", "Address2": "", "Email": "", "CountryId": "", "Country": "", "StateId": "", "State": "", "StateOther": "", "City": "", "Zip": "", "ReferenceId": "", "Phones": [ { "PhoneId": "", "PhoneType": "Home", "Phone": "", "Extension": "", "IsPrimary": true, "IsDeleted": true } ], "TimeZoneId": "" }, "Notes": "", "IsPreferredVendor": true, "IsPreferredClient": true, "PaymentMethod": "Any", "ZoneCode": "Any", "ClientType": "", "CustomerNumber": 4, "Tags": [ "" ], "IsDeleted": true, "MasterZonecode": "Any" }