POST api/Customers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
code	string	Required String length: inclusive between 0 and 20
name1	string	Required String length: inclusive between 0 and 50
name2	string	String length: inclusive between 0 and 50
name3	string	String length: inclusive between 0 and 50
peselNumber	string	String length: inclusive between 0 and 11
vatNumber	string	String length: inclusive between 0 and 20
country	string	String length: inclusive between 0 and 40
voivodeship	string	String length: inclusive between 0 and 40
city	string	String length: inclusive between 0 and 40
street	string	String length: inclusive between 0 and 40
additionalAdress	string	String length: inclusive between 0 and 44
postCode	string	String length: inclusive between 0 and 10
post	string	None.
houseNumber	string	String length: inclusive between 0 and 10
flatNumber	string	String length: inclusive between 0 and 10
phoneDocument	string	String length: inclusive between 0 and 20
phone1	string	String length: inclusive between 0 and 20
phone2	string	String length: inclusive between 0 and 20
inactive	integer	None.
defaultPrice	integer	None.
final	integer	None.
bankAccountNumber	string	Max length: 51
regon	string	String length: inclusive between 0 and 20
email	string	String length: inclusive between 0 and 127
paymentMethod	string	String length: inclusive between 0 and 20
dateOfPayment	integer	None.
maxPaymentDelay	integer	None.
created	date	None.
updated	date	None.
description	string	None.
countryCode	string	String length: inclusive between 0 and 2
type	integer	None.
companyData	CompanyData	None.
countryIso	string	String length: inclusive between 0 and 9
group	string	String length: inclusive between 0 and 20
type_supplier	integer	None.
type_receiver	integer	None.
type_competitor	integer	None.
type_partner	integer	None.
type_potential	integer	None.
split_payment	integer	None.
attributes	Collection of Attribute	None.
purchaseCategory	string	None.
representativeId	integer	None.
representativeType	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "code": "sample string 2",
  "name1": "sample string 3",
  "name2": "sample string 4",
  "name3": "sample string 5",
  "peselNumber": "sample string 6",
  "vatNumber": "sample string 7",
  "country": "sample string 8",
  "voivodeship": "sample string 9",
  "city": "sample string 10",
  "street": "sample string 11",
  "additionalAdress": "sample string 12",
  "postCode": "sample string 13",
  "post": "sample string 14",
  "houseNumber": "sample string 15",
  "flatNumber": "sample string 16",
  "phoneDocument": "sample string 17",
  "phone1": "sample string 18",
  "phone2": "sample string 19",
  "inactive": 20,
  "defaultPrice": 21,
  "final": 1,
  "bankAccountNumber": "sample string 22",
  "regon": "sample string 23",
  "email": "sample string 24",
  "paymentMethod": "sample string 25",
  "dateOfPayment": 26,
  "maxPaymentDelay": 27,
  "created": "2025-11-08T13:32:47.9950189+01:00",
  "updated": "2025-11-08T13:32:47.9950189+01:00",
  "description": "sample string 30",
  "countryCode": "sample string 31",
  "type": 1,
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  },
  "countryIso": "sample string 32",
  "group": "sample string 33",
  "type_supplier": 1,
  "type_receiver": 1,
  "type_competitor": 1,
  "type_partner": 1,
  "type_potential": 1,
  "split_payment": 1,
  "attributes": [
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    },
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    }
  ],
  "purchaseCategory": "sample string 34",
  "representativeId": 35,
  "representativeType": 36
}

application/xml, text/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <additionalAdress>sample string 12</additionalAdress>
  <attributes>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
  </attributes>
  <bankAccountNumber>sample string 22</bankAccountNumber>
  <city>sample string 10</city>
  <code>sample string 2</code>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <country>sample string 8</country>
  <countryCode>sample string 31</countryCode>
  <countryIso>sample string 32</countryIso>
  <created>2025-11-08T13:32:47.9950189+01:00</created>
  <dateOfPayment>26</dateOfPayment>
  <defaultPrice>21</defaultPrice>
  <description>sample string 30</description>
  <email>sample string 24</email>
  <final>1</final>
  <flatNumber>sample string 16</flatNumber>
  <group>sample string 33</group>
  <houseNumber>sample string 15</houseNumber>
  <id>1</id>
  <inactive>20</inactive>
  <maxPaymentDelay>27</maxPaymentDelay>
  <name1>sample string 3</name1>
  <name2>sample string 4</name2>
  <name3>sample string 5</name3>
  <paymentMethod>sample string 25</paymentMethod>
  <peselNumber>sample string 6</peselNumber>
  <phone1>sample string 18</phone1>
  <phone2>sample string 19</phone2>
  <phoneDocument>sample string 17</phoneDocument>
  <post>sample string 14</post>
  <postCode>sample string 13</postCode>
  <purchaseCategory>sample string 34</purchaseCategory>
  <regon>sample string 23</regon>
  <representativeId>35</representativeId>
  <representativeType>36</representativeType>
  <split_payment>1</split_payment>
  <street>sample string 11</street>
  <type>1</type>
  <type_competitor>1</type_competitor>
  <type_partner>1</type_partner>
  <type_potential>1</type_potential>
  <type_receiver>1</type_receiver>
  <type_supplier>1</type_supplier>
  <updated>2025-11-08T13:32:47.9950189+01:00</updated>
  <vatNumber>sample string 7</vatNumber>
  <voivodeship>sample string 9</voivodeship>
</Customer>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Customer'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.