POST api/v1/customer

Create a new customers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
Name	string	Required
VatNumber	string	None.
EanNumber	string	None.
ExternalNumber	string	None.
RequisitionNumber	string	None.
InvoiceEmail	string	None.
Notes	string	None.
Address	AddressDto	None.
ContactInformation	ContactInformationDto	None.
ContactPersons	Collection of ContactPersonDto	None.
ResponsibleUsers	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "customerId": 1,
  "name": "sample string 2",
  "vatNumber": "sample string 3",
  "eanNumber": "sample string 4",
  "externalNumber": "sample string 5",
  "requisitionNumber": "sample string 6",
  "invoiceEmail": "sample string 7",
  "notes": "sample string 8",
  "address": {
    "addressId": 1,
    "name": "sample string 2",
    "address1": "sample string 3",
    "address2": "sample string 4",
    "zipCode": "sample string 5",
    "city": "sample string 6",
    "country": "sample string 7",
    "countryId": 1,
    "attention": "sample string 8"
  },
  "contactInformation": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phoneNumber": "sample string 3",
    "position": "sample string 4",
    "company": "sample string 5"
  },
  "contactPersons": [
    {
      "contactPersonId": 1,
      "customerId": 1,
      "externalNumber": "sample string 2",
      "lastChanged": "2025-12-08T10:16:44.6876557+01:00",
      "email": "sample string 4",
      "phone": "sample string 5",
      "fax": "sample string 6",
      "localPhoneNumber": "sample string 7",
      "cellPhoneNumber": "sample string 8",
      "company": "sample string 9",
      "address": {
        "addressId": 1,
        "name": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "zipCode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "countryId": 1,
        "attention": "sample string 8"
      },
      "customer": {
        "id": 1,
        "externalNumber": "sample string 2",
        "name": "sample string 3"
      },
      "id": 10,
      "name": "sample string 11",
      "position": "sample string 12"
    },
    {
      "contactPersonId": 1,
      "customerId": 1,
      "externalNumber": "sample string 2",
      "lastChanged": "2025-12-08T10:16:44.6876557+01:00",
      "email": "sample string 4",
      "phone": "sample string 5",
      "fax": "sample string 6",
      "localPhoneNumber": "sample string 7",
      "cellPhoneNumber": "sample string 8",
      "company": "sample string 9",
      "address": {
        "addressId": 1,
        "name": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "zipCode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "countryId": 1,
        "attention": "sample string 8"
      },
      "customer": {
        "id": 1,
        "externalNumber": "sample string 2",
        "name": "sample string 3"
      },
      "id": 10,
      "name": "sample string 11",
      "position": "sample string 12"
    }
  ],
  "responsibleUsers": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CustomerCreateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <Address>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <AddressId>1</AddressId>
    <Attention>sample string 8</Attention>
    <City>sample string 6</City>
    <Country>sample string 7</Country>
    <CountryId>1</CountryId>
    <Name>sample string 2</Name>
    <ZipCode>sample string 5</ZipCode>
  </Address>
  <ContactInformation>
    <Company>sample string 5</Company>
    <Email>sample string 2</Email>
    <Name>sample string 1</Name>
    <PhoneNumber>sample string 3</PhoneNumber>
    <Position>sample string 4</Position>
  </ContactInformation>
  <ContactPersons>
    <ContactPersonDto>
      <Name>sample string 11</Name>
      <Position>sample string 12</Position>
      <id>10</id>
      <Address>
        <Address1>sample string 3</Address1>
        <Address2>sample string 4</Address2>
        <AddressId>1</AddressId>
        <Attention>sample string 8</Attention>
        <City>sample string 6</City>
        <Country>sample string 7</Country>
        <CountryId>1</CountryId>
        <Name>sample string 2</Name>
        <ZipCode>sample string 5</ZipCode>
      </Address>
      <CellPhoneNumber>sample string 8</CellPhoneNumber>
      <Company>sample string 9</Company>
      <ContactPersonId>1</ContactPersonId>
      <Customer>
        <ExternalNumber>sample string 2</ExternalNumber>
        <Id>1</Id>
        <Name>sample string 3</Name>
      </Customer>
      <CustomerId>1</CustomerId>
      <Email>sample string 4</Email>
      <ExternalNumber>sample string 2</ExternalNumber>
      <Fax>sample string 6</Fax>
      <LastChanged>2025-12-08T10:16:44.6876557+01:00</LastChanged>
      <LocalPhoneNumber>sample string 7</LocalPhoneNumber>
      <Phone>sample string 5</Phone>
    </ContactPersonDto>
    <ContactPersonDto>
      <Name>sample string 11</Name>
      <Position>sample string 12</Position>
      <id>10</id>
      <Address>
        <Address1>sample string 3</Address1>
        <Address2>sample string 4</Address2>
        <AddressId>1</AddressId>
        <Attention>sample string 8</Attention>
        <City>sample string 6</City>
        <Country>sample string 7</Country>
        <CountryId>1</CountryId>
        <Name>sample string 2</Name>
        <ZipCode>sample string 5</ZipCode>
      </Address>
      <CellPhoneNumber>sample string 8</CellPhoneNumber>
      <Company>sample string 9</Company>
      <ContactPersonId>1</ContactPersonId>
      <Customer>
        <ExternalNumber>sample string 2</ExternalNumber>
        <Id>1</Id>
        <Name>sample string 3</Name>
      </Customer>
      <CustomerId>1</CustomerId>
      <Email>sample string 4</Email>
      <ExternalNumber>sample string 2</ExternalNumber>
      <Fax>sample string 6</Fax>
      <LastChanged>2025-12-08T10:16:44.6876557+01:00</LastChanged>
      <LocalPhoneNumber>sample string 7</LocalPhoneNumber>
      <Phone>sample string 5</Phone>
    </ContactPersonDto>
  </ContactPersons>
  <CustomerId>1</CustomerId>
  <EanNumber>sample string 4</EanNumber>
  <ExternalNumber>sample string 5</ExternalNumber>
  <InvoiceEmail>sample string 7</InvoiceEmail>
  <Name>sample string 2</Name>
  <Notes>sample string 8</Notes>
  <RequisitionNumber>sample string 6</RequisitionNumber>
  <ResponsibleUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResponsibleUsers>
  <VatNumber>sample string 3</VatNumber>
</CustomerCreateDto>

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 'CustomerCreateDto'.

Response Information

Resource Description

CustomerDto

Name	Type	Additional information
Id	integer	None.
ExternalNumber	string	None.
Name	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "externalNumber": "sample string 2",
  "name": "sample string 3"
}

application/xml, text/xml

Sample:

<CustomerDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <ExternalNumber>sample string 2</ExternalNumber>
  <Id>1</Id>
  <Name>sample string 3</Name>
</CustomerDto>