POST api/abtraccrudapi/CreateClient?user={user}&password={password}&secretKey={secretKey}

Request Information

URI Parameters

Name	Type	Additional information
user	string	Required
password	string	Required
secretKey	string	Required

Body Parameters

APICRUDDataClient

Name	Type	Additional information
ClientID	integer	None.
SiteID	integer	None.
ClientCode	string	None.
ClientName	string	None.
ClientAbbreviation	string	None.
CurrentClient	boolean	None.
BillableClient	boolean	None.
IsSubConsultant	boolean	None.
Website	string	None.
Comment	string	None.
CreateDate	date	None.
Office	APICRUDDataLinkOffice	None.
ClientOwner	APICRUDDataLinkOwner	None.
ClientOwner2	APICRUDDataLinkOwner	None.
ClientOwner3	APICRUDDataLinkOwner	None.
ClientType	APICRUDDataLinkClientType	None.
ClientRating	APICRUDDataLinkClientRating	None.
ClientCategory	APICRUDDataLinkClientCategory	None.
InvDefaultBillRecipient	string	None.
InvDefaultRecipientRole	string	None.
InvDefaultPurchaseOrderRequired	boolean	None.
InvDefaultOrderNo	string	None.
HasJobs	boolean	None.
InvDefaultClientName	string	None.
InvDefaultAddress1	string	None.
InvDefaultAddress2	string	None.
InvDefaultAddress3	string	None.
InvDefaultAddress4	string	None.
InvDefaultAddress5	string	None.
InvDefaultAddressPostCode	string	None.
InvDefaultRecipientEmail	string	None.
IsContact	boolean	None.
rowversion	string	None.
JobInvoicingTerms	string	None.
InvoiceDueDays	integer	None.
InvoiceDueRule	integer	None.
IsMasterClient	boolean	None.
MasterClientID	integer	None.
NeverAddGST	boolean	None.
TaxNumber	string	None.
EInvoiceClient	boolean	None.
CopyInvEmailToInvoice	boolean	None.
Address	Collection of APICRUDDataClientAddress	None.
Contact	Collection of APICRUDDataClientContact	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "SiteID": 2,
  "ClientCode": "sample string 3",
  "ClientName": "sample string 4",
  "ClientAbbreviation": "sample string 5",
  "CurrentClient": true,
  "BillableClient": true,
  "IsSubConsultant": true,
  "Website": "sample string 9",
  "Comment": "sample string 10",
  "CreateDate": "2025-12-11T07:49:55.6754488+00:00",
  "Office": {
    "OfficeID": 1,
    "OfficeName": "sample string 2"
  },
  "ClientOwner": {
    "OwnerID": 1,
    "OwnerAlias": "sample string 2",
    "OwnerEmployee": {
      "EmployeeID": 1,
      "EmployeeCode": "sample string 2",
      "EmployeeName": "sample string 3"
    }
  },
  "ClientOwner2": {
    "OwnerID": 1,
    "OwnerAlias": "sample string 2",
    "OwnerEmployee": {
      "EmployeeID": 1,
      "EmployeeCode": "sample string 2",
      "EmployeeName": "sample string 3"
    }
  },
  "ClientOwner3": {
    "OwnerID": 1,
    "OwnerAlias": "sample string 2",
    "OwnerEmployee": {
      "EmployeeID": 1,
      "EmployeeCode": "sample string 2",
      "EmployeeName": "sample string 3"
    }
  },
  "ClientType": {
    "ClientTypeID": 1,
    "ClientTypeDescription": "sample string 2"
  },
  "ClientRating": {
    "ClientRatingID": 1,
    "ClientRatingCode": "sample string 2"
  },
  "ClientCategory": {
    "ClientCategoryID": 1,
    "ClientCategoryDescription": "sample string 2"
  },
  "InvDefaultBillRecipient": "sample string 11",
  "InvDefaultRecipientRole": "sample string 12",
  "InvDefaultPurchaseOrderRequired": true,
  "InvDefaultOrderNo": "sample string 14",
  "HasJobs": true,
  "InvDefaultClientName": "sample string 16",
  "InvDefaultAddress1": "sample string 17",
  "InvDefaultAddress2": "sample string 18",
  "InvDefaultAddress3": "sample string 19",
  "InvDefaultAddress4": "sample string 20",
  "InvDefaultAddress5": "sample string 21",
  "InvDefaultAddressPostCode": "sample string 22",
  "InvDefaultRecipientEmail": "sample string 23",
  "IsContact": true,
  "rowversion": "sample string 25",
  "JobInvoicingTerms": "sample string 26",
  "InvoiceDueDays": 1,
  "InvoiceDueRule": 1,
  "IsMasterClient": true,
  "MasterClientID": 1,
  "NeverAddGST": true,
  "TaxNumber": "sample string 29",
  "EInvoiceClient": true,
  "CopyInvEmailToInvoice": true,
  "Address": [
    {
      "ClientAddressID": 1,
      "SiteID": 2,
      "Client": {
        "ClientID": 1,
        "ClientCode": "sample string 2",
        "ClientName": "sample string 3"
      },
      "AddressDescription": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "Address4": "sample string 7",
      "Address5": "sample string 8",
      "AddressPostCode": "sample string 9",
      "Phone": "sample string 10",
      "Fax": "sample string 11",
      "AddressCurrent": true,
      "Website": "sample string 13",
      "Post1": "sample string 14",
      "Post2": "sample string 15",
      "Post3": "sample string 16",
      "Post4": "sample string 17",
      "Post5": "sample string 18",
      "PostPostCode": "sample string 19",
      "rowversion": "sample string 20",
      "IsPrimaryAddress": true,
      "CopyAddressToPostalAddress": true
    },
    {
      "ClientAddressID": 1,
      "SiteID": 2,
      "Client": {
        "ClientID": 1,
        "ClientCode": "sample string 2",
        "ClientName": "sample string 3"
      },
      "AddressDescription": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "Address4": "sample string 7",
      "Address5": "sample string 8",
      "AddressPostCode": "sample string 9",
      "Phone": "sample string 10",
      "Fax": "sample string 11",
      "AddressCurrent": true,
      "Website": "sample string 13",
      "Post1": "sample string 14",
      "Post2": "sample string 15",
      "Post3": "sample string 16",
      "Post4": "sample string 17",
      "Post5": "sample string 18",
      "PostPostCode": "sample string 19",
      "rowversion": "sample string 20",
      "IsPrimaryAddress": true,
      "CopyAddressToPostalAddress": true
    }
  ],
  "Contact": [
    {
      "ClientContactID": 1,
      "Client": {
        "ClientID": 1,
        "ClientCode": "sample string 2",
        "ClientName": "sample string 3"
      },
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "SecondName": "sample string 4",
      "GreetingName": "sample string 5",
      "FullName": "sample string 6",
      "Role": "sample string 7",
      "Phone": "sample string 8",
      "Ext": "sample string 9",
      "Fax": "sample string 10",
      "Mobile": "sample string 11",
      "Email": "sample string 12",
      "Comment": "sample string 13",
      "Address": {
        "ClientAddressID": 1,
        "AddressDescription": "sample string 2",
        "DeliveryAddress": "sample string 3",
        "PostalAddress": "sample string 4"
      },
      "ContactIsCurrent": true,
      "ISContactForAccounts": true,
      "ContactIsMainContact": true,
      "UseMailMerge": true,
      "rowversion": "sample string 18"
    },
    {
      "ClientContactID": 1,
      "Client": {
        "ClientID": 1,
        "ClientCode": "sample string 2",
        "ClientName": "sample string 3"
      },
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "SecondName": "sample string 4",
      "GreetingName": "sample string 5",
      "FullName": "sample string 6",
      "Role": "sample string 7",
      "Phone": "sample string 8",
      "Ext": "sample string 9",
      "Fax": "sample string 10",
      "Mobile": "sample string 11",
      "Email": "sample string 12",
      "Comment": "sample string 13",
      "Address": {
        "ClientAddressID": 1,
        "AddressDescription": "sample string 2",
        "DeliveryAddress": "sample string 3",
        "PostalAddress": "sample string 4"
      },
      "ContactIsCurrent": true,
      "ISContactForAccounts": true,
      "ContactIsMainContact": true,
      "UseMailMerge": true,
      "rowversion": "sample string 18"
    }
  ]
}

application/xml, text/xml

Sample:

<APICRUDDataClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abtrac6.Business.Models.APIModels">
  <Address>
    <APICRUDDataClientAddress>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <Address3>sample string 6</Address3>
      <Address4>sample string 7</Address4>
      <Address5>sample string 8</Address5>
      <AddressCurrent>true</AddressCurrent>
      <AddressDescription>sample string 3</AddressDescription>
      <AddressPostCode>sample string 9</AddressPostCode>
      <Client>
        <ClientCode>sample string 2</ClientCode>
        <ClientID>1</ClientID>
        <ClientName>sample string 3</ClientName>
      </Client>
      <ClientAddressID>1</ClientAddressID>
      <CopyAddressToPostalAddress>true</CopyAddressToPostalAddress>
      <Fax>sample string 11</Fax>
      <IsPrimaryAddress>true</IsPrimaryAddress>
      <Phone>sample string 10</Phone>
      <Post1>sample string 14</Post1>
      <Post2>sample string 15</Post2>
      <Post3>sample string 16</Post3>
      <Post4>sample string 17</Post4>
      <Post5>sample string 18</Post5>
      <PostPostCode>sample string 19</PostPostCode>
      <SiteID>2</SiteID>
      <Website>sample string 13</Website>
      <rowversion>sample string 20</rowversion>
    </APICRUDDataClientAddress>
    <APICRUDDataClientAddress>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <Address3>sample string 6</Address3>
      <Address4>sample string 7</Address4>
      <Address5>sample string 8</Address5>
      <AddressCurrent>true</AddressCurrent>
      <AddressDescription>sample string 3</AddressDescription>
      <AddressPostCode>sample string 9</AddressPostCode>
      <Client>
        <ClientCode>sample string 2</ClientCode>
        <ClientID>1</ClientID>
        <ClientName>sample string 3</ClientName>
      </Client>
      <ClientAddressID>1</ClientAddressID>
      <CopyAddressToPostalAddress>true</CopyAddressToPostalAddress>
      <Fax>sample string 11</Fax>
      <IsPrimaryAddress>true</IsPrimaryAddress>
      <Phone>sample string 10</Phone>
      <Post1>sample string 14</Post1>
      <Post2>sample string 15</Post2>
      <Post3>sample string 16</Post3>
      <Post4>sample string 17</Post4>
      <Post5>sample string 18</Post5>
      <PostPostCode>sample string 19</PostPostCode>
      <SiteID>2</SiteID>
      <Website>sample string 13</Website>
      <rowversion>sample string 20</rowversion>
    </APICRUDDataClientAddress>
  </Address>
  <BillableClient>true</BillableClient>
  <ClientAbbreviation>sample string 5</ClientAbbreviation>
  <ClientCategory>
    <ClientCategoryDescription>sample string 2</ClientCategoryDescription>
    <ClientCategoryID>1</ClientCategoryID>
  </ClientCategory>
  <ClientCode>sample string 3</ClientCode>
  <ClientID>1</ClientID>
  <ClientName>sample string 4</ClientName>
  <ClientOwner>
    <OwnerAlias>sample string 2</OwnerAlias>
    <OwnerEmployee>
      <EmployeeCode>sample string 2</EmployeeCode>
      <EmployeeID>1</EmployeeID>
      <EmployeeName>sample string 3</EmployeeName>
    </OwnerEmployee>
    <OwnerID>1</OwnerID>
  </ClientOwner>
  <ClientOwner2>
    <OwnerAlias>sample string 2</OwnerAlias>
    <OwnerEmployee>
      <EmployeeCode>sample string 2</EmployeeCode>
      <EmployeeID>1</EmployeeID>
      <EmployeeName>sample string 3</EmployeeName>
    </OwnerEmployee>
    <OwnerID>1</OwnerID>
  </ClientOwner2>
  <ClientOwner3>
    <OwnerAlias>sample string 2</OwnerAlias>
    <OwnerEmployee>
      <EmployeeCode>sample string 2</EmployeeCode>
      <EmployeeID>1</EmployeeID>
      <EmployeeName>sample string 3</EmployeeName>
    </OwnerEmployee>
    <OwnerID>1</OwnerID>
  </ClientOwner3>
  <ClientRating>
    <ClientRatingCode>sample string 2</ClientRatingCode>
    <ClientRatingID>1</ClientRatingID>
  </ClientRating>
  <ClientType>
    <ClientTypeDescription>sample string 2</ClientTypeDescription>
    <ClientTypeID>1</ClientTypeID>
  </ClientType>
  <Comment>sample string 10</Comment>
  <Contact>
    <APICRUDDataClientContact>
      <Address>
        <AddressDescription>sample string 2</AddressDescription>
        <ClientAddressID>1</ClientAddressID>
        <DeliveryAddress>sample string 3</DeliveryAddress>
        <PostalAddress>sample string 4</PostalAddress>
      </Address>
      <Client>
        <ClientCode>sample string 2</ClientCode>
        <ClientID>1</ClientID>
        <ClientName>sample string 3</ClientName>
      </Client>
      <ClientContactID>1</ClientContactID>
      <Comment>sample string 13</Comment>
      <ContactIsCurrent>true</ContactIsCurrent>
      <ContactIsMainContact>true</ContactIsMainContact>
      <Email>sample string 12</Email>
      <Ext>sample string 9</Ext>
      <Fax>sample string 10</Fax>
      <FirstName>sample string 3</FirstName>
      <FullName>sample string 6</FullName>
      <GreetingName>sample string 5</GreetingName>
      <ISContactForAccounts>true</ISContactForAccounts>
      <Mobile>sample string 11</Mobile>
      <Phone>sample string 8</Phone>
      <Role>sample string 7</Role>
      <SecondName>sample string 4</SecondName>
      <Title>sample string 2</Title>
      <UseMailMerge>true</UseMailMerge>
      <rowversion>sample string 18</rowversion>
    </APICRUDDataClientContact>
    <APICRUDDataClientContact>
      <Address>
        <AddressDescription>sample string 2</AddressDescription>
        <ClientAddressID>1</ClientAddressID>
        <DeliveryAddress>sample string 3</DeliveryAddress>
        <PostalAddress>sample string 4</PostalAddress>
      </Address>
      <Client>
        <ClientCode>sample string 2</ClientCode>
        <ClientID>1</ClientID>
        <ClientName>sample string 3</ClientName>
      </Client>
      <ClientContactID>1</ClientContactID>
      <Comment>sample string 13</Comment>
      <ContactIsCurrent>true</ContactIsCurrent>
      <ContactIsMainContact>true</ContactIsMainContact>
      <Email>sample string 12</Email>
      <Ext>sample string 9</Ext>
      <Fax>sample string 10</Fax>
      <FirstName>sample string 3</FirstName>
      <FullName>sample string 6</FullName>
      <GreetingName>sample string 5</GreetingName>
      <ISContactForAccounts>true</ISContactForAccounts>
      <Mobile>sample string 11</Mobile>
      <Phone>sample string 8</Phone>
      <Role>sample string 7</Role>
      <SecondName>sample string 4</SecondName>
      <Title>sample string 2</Title>
      <UseMailMerge>true</UseMailMerge>
      <rowversion>sample string 18</rowversion>
    </APICRUDDataClientContact>
  </Contact>
  <CopyInvEmailToInvoice>true</CopyInvEmailToInvoice>
  <CreateDate>2025-12-11T07:49:55.6754488+00:00</CreateDate>
  <CurrentClient>true</CurrentClient>
  <EInvoiceClient>true</EInvoiceClient>
  <HasJobs>true</HasJobs>
  <InvDefaultAddress1>sample string 17</InvDefaultAddress1>
  <InvDefaultAddress2>sample string 18</InvDefaultAddress2>
  <InvDefaultAddress3>sample string 19</InvDefaultAddress3>
  <InvDefaultAddress4>sample string 20</InvDefaultAddress4>
  <InvDefaultAddress5>sample string 21</InvDefaultAddress5>
  <InvDefaultAddressPostCode>sample string 22</InvDefaultAddressPostCode>
  <InvDefaultBillRecipient>sample string 11</InvDefaultBillRecipient>
  <InvDefaultClientName>sample string 16</InvDefaultClientName>
  <InvDefaultOrderNo>sample string 14</InvDefaultOrderNo>
  <InvDefaultPurchaseOrderRequired>true</InvDefaultPurchaseOrderRequired>
  <InvDefaultRecipientEmail>sample string 23</InvDefaultRecipientEmail>
  <InvDefaultRecipientRole>sample string 12</InvDefaultRecipientRole>
  <InvoiceDueDays>1</InvoiceDueDays>
  <InvoiceDueRule>1</InvoiceDueRule>
  <IsContact>true</IsContact>
  <IsMasterClient>true</IsMasterClient>
  <IsSubConsultant>true</IsSubConsultant>
  <JobInvoicingTerms>sample string 26</JobInvoicingTerms>
  <MasterClientID>1</MasterClientID>
  <NeverAddGST>true</NeverAddGST>
  <Office>
    <OfficeID>1</OfficeID>
    <OfficeName>sample string 2</OfficeName>
  </Office>
  <SiteID>2</SiteID>
  <TaxNumber>sample string 29</TaxNumber>
  <Website>sample string 9</Website>
  <rowversion>sample string 25</rowversion>
</APICRUDDataClient>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.