POST Customers

Create a Customer Preferred way: use http post: POST url/Customers

Request Information

URI Parameters

None.

Body Parameters

a customer

InitPro.Ida.Web.Api.Dto.Customer

Name	Description	Type	Additional information
CustomerId	Internal id of Customer - readonly	integer	None.
AddressId	Internal id of Address of Customer - readonly	integer	None.
Reference	Reference that ca be added to a Customer - max size 100 chars	string	None.
CustomerType	defines type of customer - default is Enduser for possible values see your translation in customer section of gui	string	None.
CustomerContactType	defines type of contact - default is no contact for possible values see your translation in customer section of gui	string	None.
CustomerNumber	Customer Number - ID of your Customer - max size 20 chars	string	Required
CompanyName	name of company	string	None.
Department	name od department	string	None.
Salutation	Salutation for possible values see your translation in customer section of gui	string	None.
Title	title	string	None.
FirstName	firstname	string	Required
LastName	lastname	string	Required
PhoneMain	phone number	string	None.
PhoneMobile	mobile phone number	string	None.
Email	email address	string	Required
Fax	fax number	string	None.
Street	street	string	Required
Additional	additional address entry	string	None.
ZipCode	zip code	string	Required
City	city	string	Required
State	state	string	None.
Country	country - use 2 digit country code (ISO 3166-1 alpha-2) - or see your translation in customer section of gui	string	Required
DateOfBirth	birthday ...	date	None.
Language	2-digit Iso (ISO-639-1) code (de, en, fr, it)	string	None.
VatId	VatId of Customer	string	Max length: 36
Vat	VAT of Customer	decimal number	None.
Currency	Currency code (ISO 4217) e.g. EUR, CHF	string	Max length: 3
TermsOfPayment	TermsOfPayment - free text - max length 100 digits	string	Max length: 100
Addresses	additional Addresses, e.g. billing	Collection of InitPro.Ida.Web.Api.Dto.Address	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "AddressId": 2,
  "Reference": "sample string 3",
  "CustomerType": "sample string 4",
  "CustomerContactType": "sample string 5",
  "CustomerNumber": "sample string 6",
  "CompanyName": "sample string 7",
  "Department": "sample string 8",
  "Salutation": "sample string 9",
  "Title": "sample string 10",
  "FirstName": "sample string 11",
  "LastName": "sample string 12",
  "PhoneMain": "sample string 13",
  "PhoneMobile": "sample string 14",
  "Email": "sample string 15",
  "Fax": "sample string 16",
  "Street": "sample string 17",
  "Additional": "sample string 18",
  "ZipCode": "sample string 19",
  "City": "sample string 20",
  "State": "sample string 21",
  "Country": "sample string 22",
  "DateOfBirth": "2025-04-29",
  "Language": "sample string 23",
  "VatId": "sample string 24",
  "Vat": 1.0,
  "Currency": "sample string 25",
  "TermsOfPayment": "sample string 26",
  "Addresses": [
    {
      "AddressId": 1,
      "AddressType": "sample string 2",
      "CompanyName": "sample string 3",
      "Department": "sample string 4",
      "Salutation": "sample string 5",
      "Title": "sample string 6",
      "FirstName": "sample string 7",
      "LastName": "sample string 8",
      "PhoneMain": "sample string 9",
      "PhoneMobile": "sample string 10",
      "Email": "sample string 11",
      "Fax": "sample string 12",
      "Street": "sample string 13",
      "Additional": "sample string 14",
      "ZipCode": "sample string 15",
      "City": "sample string 16",
      "State": "sample string 17",
      "Country": "sample string 18",
      "DateOfBirth": "2025-04-29"
    },
    {
      "AddressId": 1,
      "AddressType": "sample string 2",
      "CompanyName": "sample string 3",
      "Department": "sample string 4",
      "Salutation": "sample string 5",
      "Title": "sample string 6",
      "FirstName": "sample string 7",
      "LastName": "sample string 8",
      "PhoneMain": "sample string 9",
      "PhoneMobile": "sample string 10",
      "Email": "sample string 11",
      "Fax": "sample string 12",
      "Street": "sample string 13",
      "Additional": "sample string 14",
      "ZipCode": "sample string 15",
      "City": "sample string 16",
      "State": "sample string 17",
      "Country": "sample string 18",
      "DateOfBirth": "2025-04-29"
    }
  ]
}

application/xml, text/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InitPro.Ida.Web.Api.Dto">
  <Additional>sample string 18</Additional>
  <AddressId>2</AddressId>
  <Addresses>
    <Address>
      <Additional>sample string 14</Additional>
      <AddressId>1</AddressId>
      <AddressType>sample string 2</AddressType>
      <City>sample string 16</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 18</Country>
      <DateOfBirth>2025-04-29T16:08:30.8636085+02:00</DateOfBirth>
      <Department>sample string 4</Department>
      <Email>sample string 11</Email>
      <Fax>sample string 12</Fax>
      <FirstName>sample string 7</FirstName>
      <LastName>sample string 8</LastName>
      <PhoneMain>sample string 9</PhoneMain>
      <PhoneMobile>sample string 10</PhoneMobile>
      <Salutation>sample string 5</Salutation>
      <State>sample string 17</State>
      <Street>sample string 13</Street>
      <Title>sample string 6</Title>
      <ZipCode>sample string 15</ZipCode>
    </Address>
    <Address>
      <Additional>sample string 14</Additional>
      <AddressId>1</AddressId>
      <AddressType>sample string 2</AddressType>
      <City>sample string 16</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 18</Country>
      <DateOfBirth>2025-04-29T16:08:30.8636085+02:00</DateOfBirth>
      <Department>sample string 4</Department>
      <Email>sample string 11</Email>
      <Fax>sample string 12</Fax>
      <FirstName>sample string 7</FirstName>
      <LastName>sample string 8</LastName>
      <PhoneMain>sample string 9</PhoneMain>
      <PhoneMobile>sample string 10</PhoneMobile>
      <Salutation>sample string 5</Salutation>
      <State>sample string 17</State>
      <Street>sample string 13</Street>
      <Title>sample string 6</Title>
      <ZipCode>sample string 15</ZipCode>
    </Address>
  </Addresses>
  <City>sample string 20</City>
  <CompanyName>sample string 7</CompanyName>
  <Country>sample string 22</Country>
  <Currency>sample string 25</Currency>
  <CustomerContactType>sample string 5</CustomerContactType>
  <CustomerId>1</CustomerId>
  <CustomerNumber>sample string 6</CustomerNumber>
  <CustomerType>sample string 4</CustomerType>
  <DateOfBirth>2025-04-29T16:08:30.8636085+02:00</DateOfBirth>
  <Department>sample string 8</Department>
  <Email>sample string 15</Email>
  <Fax>sample string 16</Fax>
  <FirstName>sample string 11</FirstName>
  <Language>sample string 23</Language>
  <LastName>sample string 12</LastName>
  <PhoneMain>sample string 13</PhoneMain>
  <PhoneMobile>sample string 14</PhoneMobile>
  <Reference>sample string 3</Reference>
  <Salutation>sample string 9</Salutation>
  <State>sample string 21</State>
  <Street>sample string 17</Street>
  <TermsOfPayment>sample string 26</TermsOfPayment>
  <Title>sample string 10</Title>
  <Vat>1</Vat>
  <VatId>sample string 24</VatId>
  <ZipCode>sample string 19</ZipCode>
</Customer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Http Status Code

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.