POST customer

POST New Customer or Prospect

Request Information

URI Parameters

None.

Body Parameters

Interprise.Web.Services.Models.CustomerInput

Name	Description	Type	Additional information
CustomerCode	Optional custom customer code to use	string	None.
CustomerName	Name of the customer, mandatory when contact first name and contact last name is not specified.	string	None.
Contact_Firstname	Contact first name, mandatory when customer name is not specified.	string	None.
Contact_Lastname	Contact last name, mandatory when customer name is not specified.	string	None.
Telephone	Telephone, optional	string	None.
TelephoneExtension	Telephone extension, optional	string	None.
Fax	Fax, optional	string	None.
FaxExtension	Fax extension, optional	string	None.
Email	Email address, optional	string	None.
CustomerTypeCode	Customer type, optional	string	None.
IsProspect	Indicates if a prospect or customer will be created. Default is customer	boolean	None.
IsActive	Status, optional. Default to True when not specified	boolean	None.
IsCreditHold	Credit on hold, optional. Default to False when not specified	boolean	None.
IsAllowBackOrder	Allow Back ordering, optional. Default to True when not specified	boolean	None.
TaxNumber	Tax Number or Vat Number	string	None.
BusinessLicense	Business License or Company Registration	string	None.
CurrencyCode	Customer currency code, optional	string	None.
SalesRepGroupName	Sales Rep, optional	string	None.
BillingAddress	Billing address of the customer, mandatory	Interprise.Web.Services.Models.CustomerInput+CreateBillingAddressInput	None.
ShippingAddress	Shipping address of the customer, mandatory	Interprise.Web.Services.Models.CustomerInput+CreateShippingAddressInput	None.
CustomFields	Collection of all the custom fields in a Customer table	Collection of Interprise.Web.Services.Models.CustomField	None.

Request Formats

{
  "customerCode": "sample string 1",
  "customerName": "sample string 2",
  "contact_Firstname": "sample string 3",
  "contact_Lastname": "sample string 4",
  "telephone": "sample string 5",
  "telephoneExtension": "sample string 6",
  "fax": "sample string 7",
  "faxExtension": "sample string 8",
  "email": "sample string 9",
  "customerTypeCode": "sample string 10",
  "isProspect": true,
  "isActive": true,
  "isCreditHold": true,
  "isAllowBackOrder": true,
  "taxNumber": "sample string 11",
  "businessLicense": "sample string 12",
  "currencyCode": "sample string 13",
  "salesRepGroupName": "sample string 14",
  "billingAddress": {
    "address": "sample string 1",
    "city": "sample string 2",
    "county": "sample string 3",
    "postalCode": "sample string 4",
    "country": "sample string 5",
    "classCode": "sample string 6"
  },
  "shippingAddress": {
    "shipToName": "sample string 1",
    "isActive": true,
    "address": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postalCode": "sample string 5",
    "country": "sample string 6",
    "telephone": "sample string 7",
    "telephoneExtension": "sample string 8",
    "fax": "sample string 9",
    "faxExtension": "sample string 10",
    "email": "sample string 11",
    "classCode": "sample string 12"
  },
  "customFields": [
    {
      "field": "sample string 1",
      "value": {}
    },
    {
      "field": "sample string 1",
      "value": {}
    }
  ]
}

<CustomerInput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerCode>sample string 1</CustomerCode>
  <CustomerName>sample string 2</CustomerName>
  <Contact_Firstname>sample string 3</Contact_Firstname>
  <Contact_Lastname>sample string 4</Contact_Lastname>
  <Telephone>sample string 5</Telephone>
  <TelephoneExtension>sample string 6</TelephoneExtension>
  <Fax>sample string 7</Fax>
  <FaxExtension>sample string 8</FaxExtension>
  <Email>sample string 9</Email>
  <CustomerTypeCode>sample string 10</CustomerTypeCode>
  <IsProspect>true</IsProspect>
  <IsActive>true</IsActive>
  <IsCreditHold>true</IsCreditHold>
  <IsAllowBackOrder>true</IsAllowBackOrder>
  <TaxNumber>sample string 11</TaxNumber>
  <BusinessLicense>sample string 12</BusinessLicense>
  <CurrencyCode>sample string 13</CurrencyCode>
  <SalesRepGroupName>sample string 14</SalesRepGroupName>
  <SalesRepGroupCode>sample string 15</SalesRepGroupCode>
  <BillingAddress>
    <Address>sample string 1</Address>
    <City>sample string 2</City>
    <County>sample string 3</County>
    <PostalCode>sample string 4</PostalCode>
    <Country>sample string 5</Country>
    <ClassCode>sample string 6</ClassCode>
  </BillingAddress>
  <ShippingAddress>
    <ShipToName>sample string 1</ShipToName>
    <IsActive>true</IsActive>
    <Address>sample string 2</Address>
    <City>sample string 3</City>
    <County>sample string 4</County>
    <PostalCode>sample string 5</PostalCode>
    <Country>sample string 6</Country>
    <Telephone>sample string 7</Telephone>
    <TelephoneExtension>sample string 8</TelephoneExtension>
    <Fax>sample string 9</Fax>
    <FaxExtension>sample string 10</FaxExtension>
    <Email>sample string 11</Email>
    <ClassCode>sample string 12</ClassCode>
  </ShippingAddress>
  <CustomFields>
    <CustomField>
      <Field>sample string 1</Field>
      <Value />
    </CustomField>
    <CustomField>
      <Field>sample string 1</Field>
      <Value />
    </CustomField>
  </CustomFields>
</CustomerInput>

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerInput'.

Response Information

Resource Description

Interprise.Web.Services.Http.MetadataOfInterprise.Web.Services.Models.CustomerInput

Name	Description	Type	Additional information
data		Interprise.Web.Services.Http.DataNodeOfInterprise.Web.Services.Models.CustomerInput	None.
links		Interprise.Web.Services.Http.LinksNode	None.

Response Formats

application/json, text/json

Sample not available.