POST api/v1/clients

Creates the client.

Request Information

URI Parameters

None.

Body Parameters

The client.

Name	Description	Type	Additional information
AddressLine1	The client address line1.	string	String length: inclusive between 0 and 100
AddressLine2	The client address line2.	string	String length: inclusive between 0 and 100
AddressLine3	The client address line3.	string	String length: inclusive between 0 and 100
AddressLine4	The client address line4.	string	String length: inclusive between 0 and 100
Name	The client client name.	string	Required String length: inclusive between 0 and 100
PostCode	The client post code.	string	String length: inclusive between 0 and 50
Country	The client country.	globally unique identifier	None.
Company	The company.	globally unique identifier	None.
TimesheetNotificationAddress	The default email address to sent timesheet notifications	string	None.
ReferenceNumber	External reference number	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AddressLine1": "sample string 1",
  "AddressLine2": "sample string 2",
  "AddressLine3": "sample string 3",
  "AddressLine4": "sample string 4",
  "Name": "sample string 5",
  "PostCode": "sample string 6",
  "Country": "5083d3a4-f100-4ed9-848f-d1bdedf2296b",
  "Company": "55b7d5e5-9269-4e6e-81a5-b8a698b33aca",
  "TimesheetNotificationAddress": "sample string 9",
  "ReferenceNumber": "sample string 10"
}

application/xml, text/xml

Sample:

<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 1</AddressLine1>
  <AddressLine2>sample string 2</AddressLine2>
  <AddressLine3>sample string 3</AddressLine3>
  <AddressLine4>sample string 4</AddressLine4>
  <Company>55b7d5e5-9269-4e6e-81a5-b8a698b33aca</Company>
  <Country>5083d3a4-f100-4ed9-848f-d1bdedf2296b</Country>
  <Name>sample string 5</Name>
  <PostCode>sample string 6</PostCode>
  <ReferenceNumber>sample string 10</ReferenceNumber>
  <TimesheetNotificationAddress>sample string 9</TimesheetNotificationAddress>
</Client>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created client.

ClientViewModel

Name	Description	Type	Additional information
AddressLine1	The address line1.	string	None.
AddressLine2	The address line2.	string	None.
AddressLine3	The address line3.	string	None.
AddressLine4	The address line4.	string	None.
Name	The client name.	string	None.
PostCode	The post code.	string	None.
Country	The country.	CountryViewModel	None.
Company	The company.	CompanyViewModel	None.
ReferenceNumber	Client Reference Number.	string	None.
TimesheetNotificationAddress	The default email address to sent timesheet notifications	string	None.
ClientGuid	The client unnique identifier	globally unique identifier	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "AddressLine1": "sample string 1",
  "AddressLine2": "sample string 2",
  "AddressLine3": "sample string 3",
  "AddressLine4": "sample string 4",
  "Name": "sample string 5",
  "PostCode": "sample string 6",
  "Country": {
    "Iso3Code": "sample string 1",
    "Name": "sample string 2",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "df576292-96d4-4739-839b-abbcb5b7c715",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "117030fc-1530-47c6-a8c9-0e469e99252d",
    "Uid": "eeeb91a1-ff05-4fba-aa6e-9bb9246eb602",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
    "UpdatedBy": "sample string 5"
  },
  "Company": {
    "Name": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "AddressLine4": "sample string 5",
    "PostCode": "sample string 6",
    "Country": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "df576292-96d4-4739-839b-abbcb5b7c715",
        "Links": [
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          },
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          }
        ],
        "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "117030fc-1530-47c6-a8c9-0e469e99252d",
      "Uid": "eeeb91a1-ff05-4fba-aa6e-9bb9246eb602",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "35606e24-febc-495f-ac83-7001673f36c2",
    "PortalGuid": "f9b15240-dab4-4907-bed8-eda4455de714",
    "CompanyGuid": "d4138730-f265-483c-b4fb-9babeac2f02a",
    "Uid": "b6743c7f-e0a6-47f9-a9fa-acc21cc71ed6",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
    "UpdatedBy": "sample string 13"
  },
  "ReferenceNumber": "sample string 7",
  "TimesheetNotificationAddress": "sample string 8",
  "ClientGuid": "117b9914-8eb1-4f0a-ae1f-634fc8c59783",
  "Uid": "3ff1582d-14eb-4827-aa8f-25224f50d00c",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T14:03:06.0093468+00:00",
  "UpdatedBy": "sample string 11"
}

application/xml, text/xml

Sample:

<ClientViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>3ff1582d-14eb-4827-aa8f-25224f50d00c</Uid>
  <UpdatedBy>sample string 11</UpdatedBy>
  <AddressLine1>sample string 1</AddressLine1>
  <AddressLine2>sample string 2</AddressLine2>
  <AddressLine3>sample string 3</AddressLine3>
  <AddressLine4>sample string 4</AddressLine4>
  <ClientGuid>117b9914-8eb1-4f0a-ae1f-634fc8c59783</ClientGuid>
  <Company>
    <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>b6743c7f-e0a6-47f9-a9fa-acc21cc71ed6</Uid>
    <UpdatedBy>sample string 13</UpdatedBy>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <AddressLine4>sample string 5</AddressLine4>
    <CompanyGuid>d4138730-f265-483c-b4fb-9babeac2f02a</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>eeeb91a1-ff05-4fba-aa6e-9bb9246eb602</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>117030fc-1530-47c6-a8c9-0e469e99252d</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>df576292-96d4-4739-839b-abbcb5b7c715</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Latitude>sample string 7</Latitude>
    <Longitude>sample string 8</Longitude>
    <Name>sample string 1</Name>
    <PortalGuid>f9b15240-dab4-4907-bed8-eda4455de714</PortalGuid>
    <PortalUid>35606e24-febc-495f-ac83-7001673f36c2</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>
    <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>eeeb91a1-ff05-4fba-aa6e-9bb9246eb602</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>117030fc-1530-47c6-a8c9-0e469e99252d</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-10-27T14:03:06.0093468+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>df576292-96d4-4739-839b-abbcb5b7c715</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
  </Country>
  <Name>sample string 5</Name>
  <PostCode>sample string 6</PostCode>
  <ReferenceNumber>sample string 7</ReferenceNumber>
  <TimesheetNotificationAddress>sample string 8</TimesheetNotificationAddress>
</ClientViewModel>