Client

Client represents a customer using your service. Client object allows you to perform the following operations:

  • Retrieve a specific client or a list of clients
  • Create a client
  • Update a client
  • Delete a client

  • cURL
  • NODE.JS
  • PHP
  • C#
  • PYTHON
  • JAVA
NameDescriptionFormatAttributes
nameClient or customer namestringFilterable, Sortable
MaxLength = 65
addressAddress of a client Address
assignedGroups []List of assigned groups AssignedGroup
clientSinceDate when the business was initiated between the company and the client in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
companyClient's company namestringMaxLength = 55
createdByIdIdentifier of the user who created this objectuuidFilterable
createdOnDate and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
currencyIdIdentifier of the client's currency multiplieruuid
currencyNameName of a currency, e.g., U.S.Dollar, British Poundstring
customFields []Represents a list of custom fields CustomFieldData
defaultGroupName of the default groupstring
defaultGroupIdIdentifier of the group to which a client belongsuuid
feeScheduleIdRepresents the fee schedule identifier. Fee schedules are unique fee structures with special bill rates and cost rates by employee, activity item, expense item or groupuuidFilterable
feeScheduleNameName of the fee schedulestringFilterable, Sortable
firstNameFirst name of a clientstringMaxLength = 45
idObject identifieruuidFilterable
lastNameLast name of the clientstringMaxLength = 45
lastUpdatedLast updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
lastUpdatedByIdIdentifier of the user who last updated this objectuuidFilterable
mainExpenseTaxMain expense tax applied to the expense amount on a client invoicedouble
mainServiceTaxMain service tax applied to the labor/service amount on a client invoicedouble
managerName of the employee who is a manager of the clientstringFilterable, Sortable
managerIdIdentifier of a client manageruuidFilterable
memoRecords any extra information of a client for recapitulationstring
messageOnInvoiceCustom message printed on a client invoicestring
middleInitialMiddle initial of the clientstringMaxLength = 1
objectStateRepresents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
statusCurrent status of the client, e.g., Active or InActive Status Filterable, Sortable
taxIdRepresents a federal tax identifier.string
termName of the termstring
termIdIdentifier of a term (frequency) with which a client will make a paymentuuid
tokenRepresents the token for update operationsint32
typeGets or sets the type. ClientType
versionImplements concurrency on this objectbyte

Use this method to retrieve a list of clients. Optionally pass where, orderBy and page as the query parameters to filter the result. The fields parameter is used to request a flat subset of the model and the expand parameter is used to request nested properties in the model. The expand parameter is used to request nested properties in the model.

Request URL
base_url/client

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
fields Query Specifies the model properties you want in the response bodystring
where Query Specifies only those records that match an expression in the query.string
orderBy Query Specifies the order of the records.string
page Query Specifies the page number and number of records on each page.string
expand Query Specifies the nested model properties you want in the response bodystring
Response Body
NameDescriptionFormat
name Client or customer namestring
address Address of a client Address
assignedGroups []List of assigned groups AssignedGroup
clientSince Date when the business was initiated between the company and the client in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
company Client's company namestring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
currencyId Identifier of the client's currency multiplieruuid
currencyName Name of a currency, e.g., U.S.Dollar, British Poundstring
customFields []Represents a list of custom fields CustomFieldData
defaultGroup Name of the default groupstring
defaultGroupId Identifier of the group to which a client belongsuuid
feeScheduleId Represents the fee schedule identifier. Fee schedules are unique fee structures with special bill rates and cost rates by employee, activity item, expense item or groupuuid
feeScheduleName Name of the fee schedulestring
firstName First name of a clientstring
id Object identifieruuid
lastName Last name of the clientstring
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
mainExpenseTax Main expense tax applied to the expense amount on a client invoicedouble
mainServiceTax Main service tax applied to the labor/service amount on a client invoicedouble
manager Name of the employee who is a manager of the clientstring
managerId Identifier of a client manageruuid
memo Records any extra information of a client for recapitulationstring
messageOnInvoice Custom message printed on a client invoicestring
middleInitial Middle initial of the clientstring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
status Current status of the client, e.g., Active or InActive Status
taxId Represents a federal tax identifier.string
term Name of the termstring
termId Identifier of a term (frequency) with which a client will make a paymentuuid
token Represents the token for update operationsint32
type Gets or sets the type. ClientType
version Implements concurrency on this objectbyte
Example Request
Example Response
[
  {
    "name": "Client",
    "address": {
      "entityId": "31d44adb-c80c-4414-8b03-5259af0216f5",
      "entityType": null,
      "name": "Address",
      "city": "city",
      "communications": [
        {
          "addressId": "3830b5ad-56d7-422e-84c7-6482ce298258",
          "typeId": "1eb9f524-173f-4874-9593-4daa8e70368f",
          "value": "value",
          "createdById": "9bb0c145-d43f-45fe-a3b8-e43cf3557f12",
          "createdOn": "2021-10-05T10:43:11Z",
          "id": "1c1cfd1a-e197-4ada-841c-4b63948bf823",
          "lastUpdated": "2021-10-05T10:43:11Z",
          "lastUpdatedById": "29e3c1f8-19af-4030-b918-7782c6942a5b",
          "objectState": null,
          "sortOrder": 0,
          "token": 0,
          "typeName": "typeName",
          "version": "U3dhZ2dlciByb2Nrcw=="
        }
      ],
      "country": "country",
      "createdById": "c874d096-de4d-4a62-8c30-cd226dc8e101",
      "createdOn": "2021-10-05T10:43:11Z",
      "id": "574f09e3-f40a-469c-a07a-49b21a449fcd",
      "isDefault": true,
      "lastUpdated": "2021-10-05T10:43:11Z",
      "lastUpdatedById": "8b05d828-d05c-4f4a-828b-6323b197014e",
      "objectState": null,
      "sortOrder": 0,
      "state": "state",
      "street1": "street1",
      "street2": "street2",
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw==",
      "zip": "zip"
    },
    "assignedGroups": [
      {
        "description": "AssignedGroup Description",
        "id": "5f2e08a6-f591-4914-afbb-cf8b719d9e8e",
        "name": "AssignedGroup"
      }
    ],
    "clientSince": "2021-10-05T10:43:12Z",
    "company": "company",
    "createdById": "fb0c23a7-db2d-49a1-889c-212ac2d34f13",
    "createdOn": "2021-10-05T10:43:12Z",
    "currencyId": "eb1e2aa6-17f2-41e9-99b5-edd23a80f0ae",
    "currencyName": "currencyName",
    "customFields": [
      {
        "definitionId": "595ccb0e-516b-4a92-b2ba-64807e33536d",
        "createdById": "a0fea6ca-00f4-4556-b4ca-fa30d82cf845",
        "createdOn": "2021-10-05T10:43:12Z",
        "description": "CustomFieldData Description",
        "id": "b594e3d7-c0d5-4cc7-b4cc-5b92b5a82230",
        "label": "label",
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "a3737a29-70d5-48cb-9124-0f91a5534da8",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "defaultGroup": "defaultGroup",
    "defaultGroupId": "5bdec9ec-9eab-460b-9a86-0c2a0e705de9",
    "feeScheduleId": "6ba3a6b2-f1f8-4d8e-8764-cf90fd3b0e61",
    "feeScheduleName": "feeScheduleName",
    "firstName": "John",
    "id": "00713f90-0cf3-4fdb-aed1-35bb7fa2307c",
    "lastName": "Doe",
    "lastUpdated": "2021-10-05T10:43:12Z",
    "lastUpdatedById": "bbd5005a-af5f-4eb4-9f84-a69715a3eb3b",
    "mainExpenseTax": 1,
    "mainServiceTax": 1,
    "manager": "manager",
    "managerId": "0f0721a4-764e-4ee0-8abc-5c98bc783ef6",
    "memo": "memo",
    "messageOnInvoice": "messageOnInvoice",
    "middleInitial": "middleInitial",
    "objectState": null,
    "status": null,
    "taxId": "taxId",
    "term": "term",
    "termId": "8fc67e11-5917-4c8b-9970-98c7d1c13348",
    "token": 0,
    "type": null,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Use this method to retrieve a specific client. Pass id as the parameter.

Request URL
base_url/client/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Client identifierstring
Response Body
NameDescriptionFormat
name Client or customer namestring
address Address of a client Address
assignedGroups []List of assigned groups AssignedGroup
clientSince Date when the business was initiated between the company and the client in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
company Client's company namestring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
currencyId Identifier of the client's currency multiplieruuid
currencyName Name of a currency, e.g., U.S.Dollar, British Poundstring
customFields []Represents a list of custom fields CustomFieldData
defaultGroup Name of the default groupstring
defaultGroupId Identifier of the group to which a client belongsuuid
feeScheduleId Represents the fee schedule identifier. Fee schedules are unique fee structures with special bill rates and cost rates by employee, activity item, expense item or groupuuid
feeScheduleName Name of the fee schedulestring
firstName First name of a clientstring
id Object identifieruuid
lastName Last name of the clientstring
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
mainExpenseTax Main expense tax applied to the expense amount on a client invoicedouble
mainServiceTax Main service tax applied to the labor/service amount on a client invoicedouble
manager Name of the employee who is a manager of the clientstring
managerId Identifier of a client manageruuid
memo Records any extra information of a client for recapitulationstring
messageOnInvoice Custom message printed on a client invoicestring
middleInitial Middle initial of the clientstring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
status Current status of the client, e.g., Active or InActive Status
taxId Represents a federal tax identifier.string
term Name of the termstring
termId Identifier of a term (frequency) with which a client will make a paymentuuid
token Represents the token for update operationsint32
type Gets or sets the type. ClientType
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "name": "Client",
  "address": {
    "entityId": "045677ad-40e8-4d04-ae4d-751394db33a6",
    "entityType": null,
    "name": "Address",
    "city": "city",
    "communications": [
      {
        "addressId": "edb47a5c-19c3-4b70-aceb-fccbeed171e4",
        "typeId": "9a9447df-08f8-46eb-b6ad-e565a58508cf",
        "value": "value",
        "createdById": "337b1f03-3bbd-4911-be5c-11e41f398ee4",
        "createdOn": "2021-10-05T10:43:12Z",
        "id": "1052d7b4-ad60-4dd7-8bc5-ce2274105607",
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "ae552fd8-e20f-4a6f-8a23-9f6e2362fac9",
        "objectState": null,
        "sortOrder": 0,
        "token": 0,
        "typeName": "typeName",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "country": "country",
    "createdById": "f7a3f578-eb4b-46fc-941e-d98ea5e053f7",
    "createdOn": "2021-10-05T10:43:12Z",
    "id": "f866c524-5395-453f-8a2a-a7edc9128aa6",
    "isDefault": true,
    "lastUpdated": "2021-10-05T10:43:12Z",
    "lastUpdatedById": "35060e35-a656-422e-a61d-a1bf44049d6c",
    "objectState": null,
    "sortOrder": 0,
    "state": "state",
    "street1": "street1",
    "street2": "street2",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw==",
    "zip": "zip"
  },
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "39b7ada0-5f5a-44f0-bb6c-cb71af90d6e2",
      "name": "AssignedGroup"
    }
  ],
  "clientSince": "2021-10-05T10:43:12Z",
  "company": "company",
  "createdById": "43beb59e-4307-4b7c-b62f-6d9780b1f723",
  "createdOn": "2021-10-05T10:43:12Z",
  "currencyId": "cbbd2168-35d4-40d5-a5f5-32b07d2ab094",
  "currencyName": "currencyName",
  "customFields": [
    {
      "definitionId": "08c665f5-9213-4395-9eb3-af530850a89b",
      "createdById": "c916a43c-313d-4cf6-9d7f-757cc1902d3a",
      "createdOn": "2021-10-05T10:43:12Z",
      "description": "CustomFieldData Description",
      "id": "7d14509b-9dd5-465b-9b2c-678d06a175a4",
      "label": "label",
      "lastUpdated": "2021-10-05T10:43:12Z",
      "lastUpdatedById": "c64e6f57-6552-469b-913e-72815b3ed4ae",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "f1b4cbb8-3934-4e70-8e39-fc0ffb7bfb37",
  "feeScheduleId": "350ab452-8b04-484c-9d6e-ada3d68e0bab",
  "feeScheduleName": "feeScheduleName",
  "firstName": "John",
  "id": "cf49f16e-08cc-4ed9-bedc-4f2084c14a35",
  "lastName": "Doe",
  "lastUpdated": "2021-10-05T10:43:12Z",
  "lastUpdatedById": "3df2acc6-6a71-4c14-93cd-e5cfdd3fad50",
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "manager": "manager",
  "managerId": "f1edebd7-ffc6-40ef-9c38-a179105f32fa",
  "memo": "memo",
  "messageOnInvoice": "messageOnInvoice",
  "middleInitial": "middleInitial",
  "objectState": null,
  "status": null,
  "taxId": "taxId",
  "term": "term",
  "termId": "a592eb0a-35f5-416c-a9f6-a72bdbbb33d7",
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to retrieve the list of contacts assigned to this client.

Request URL
base_url/client/{id}/contacts

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
fields Query string
where Query string
orderBy Query Specifies the order of the recordsstring
page Query Specifies the page number and number of records on each pagestring
id Path Client identifierstring
expand Query Specifies the nested model properties you want in the response bodystring
Response Body
NameDescriptionFormat
contactName User friendly identifier of a contactstring
entityId Identifier of an entityuuid
entityType Determines the entity type ModuleNames
address []List of addresses associated with a contact Address
company Contact's company namestring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
customFields []List of custom fields in the contacts CustomFieldData
department Name of the department in which the client contact worksstring
firstName First name of a contactstring
id Object identifieruuid
isPrimaryContact Indicates whether a client contact is main (primary) or notboolean
lastName Last name of a contactstring
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
memo Represents a memo to record additional information about a client contactstring
middleInitial Middle initial of a contactstring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
salutation Salutation used for a client contactstring
title Job or professional title of a client contactstring
token Represents the token for update operationsint32
version Implements concurrency on this objectbyte
Example Request
Example Response
[
  {
    "contactName": "contactName",
    "entityId": "217fee67-2a6f-464b-88e7-1e9b400391e3",
    "entityType": null,
    "address": [
      {
        "entityId": "baa3b4da-7ff6-4901-a226-802a26b47143",
        "entityType": null,
        "name": "Address",
        "city": "city",
        "communications": [
          {
            "addressId": "c78d9cac-d705-4c33-80d0-88b4681f5d79",
            "typeId": "0e5756f0-b3be-4c5f-b300-4ec5642d3ddd",
            "value": "value",
            "createdById": "31919fcb-60dd-4672-8b00-e7b30b12cb50",
            "createdOn": "2021-10-05T10:43:12Z",
            "id": "56ee415a-4b2a-4f91-8fe9-2cabda7a67bf",
            "lastUpdated": "2021-10-05T10:43:12Z",
            "lastUpdatedById": "b4870290-a484-4264-9a66-a87d99689c0c",
            "objectState": null,
            "sortOrder": 0,
            "token": 0,
            "typeName": "typeName",
            "version": "U3dhZ2dlciByb2Nrcw=="
          }
        ],
        "country": "country",
        "createdById": "4f049794-0f95-4e15-9509-0f5cf68ab430",
        "createdOn": "2021-10-05T10:43:12Z",
        "id": "d258fced-59e1-4259-bd11-9432a7a5ab78",
        "isDefault": true,
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "01bda565-536c-482e-94b0-c513e4e6a3f8",
        "objectState": null,
        "sortOrder": 0,
        "state": "state",
        "street1": "street1",
        "street2": "street2",
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw==",
        "zip": "zip"
      }
    ],
    "company": "company",
    "createdById": "e5902705-a914-492b-8751-8f071b9110b7",
    "createdOn": "2021-10-05T10:43:12Z",
    "customFields": [
      {
        "definitionId": "6bcf8b03-22e5-4eae-a304-f35817695b7a",
        "createdById": "450e65e1-7ea8-4169-884c-ffb59c7084cb",
        "createdOn": "2021-10-05T10:43:12Z",
        "description": "CustomFieldData Description",
        "id": "d66e79ff-906e-4db7-8e53-a71f95c8a0c6",
        "label": "label",
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "a0075a5f-87ab-41ec-a613-0912c4c759de",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "department": "department",
    "firstName": "John",
    "id": "76f0fc6c-c473-4655-b626-8db8707f23d6",
    "isPrimaryContact": true,
    "lastName": "Doe",
    "lastUpdated": "2021-10-05T10:43:12Z",
    "lastUpdatedById": "0299a133-507d-434f-adaa-9ec965a3c95d",
    "memo": "memo",
    "middleInitial": "middleInitial",
    "objectState": null,
    "salutation": "salutation",
    "title": "title",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Use this method to save the client. Pass client as the parameter.

Request URL
base_url/client

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Client objectClient
Response Body
NameDescriptionFormat
name Client or customer namestring
address Address of a client Address
assignedGroups []List of assigned groups AssignedGroup
clientSince Date when the business was initiated between the company and the client in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
company Client's company namestring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
currencyId Identifier of the client's currency multiplieruuid
currencyName Name of a currency, e.g., U.S.Dollar, British Poundstring
customFields []Represents a list of custom fields CustomFieldData
defaultGroup Name of the default groupstring
defaultGroupId Identifier of the group to which a client belongsuuid
feeScheduleId Represents the fee schedule identifier. Fee schedules are unique fee structures with special bill rates and cost rates by employee, activity item, expense item or groupuuid
feeScheduleName Name of the fee schedulestring
firstName First name of a clientstring
id Object identifieruuid
lastName Last name of the clientstring
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
mainExpenseTax Main expense tax applied to the expense amount on a client invoicedouble
mainServiceTax Main service tax applied to the labor/service amount on a client invoicedouble
manager Name of the employee who is a manager of the clientstring
managerId Identifier of a client manageruuid
memo Records any extra information of a client for recapitulationstring
messageOnInvoice Custom message printed on a client invoicestring
middleInitial Middle initial of the clientstring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
status Current status of the client, e.g., Active or InActive Status
taxId Represents a federal tax identifier.string
term Name of the termstring
termId Identifier of a term (frequency) with which a client will make a paymentuuid
token Represents the token for update operationsint32
type Gets or sets the type. ClientType
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "name": "Client",
  "address": {
    "entityId": "4dd35bfb-23c4-4da9-8502-e4f45727f36c",
    "entityType": null,
    "name": "Address",
    "city": "city",
    "communications": [
      {
        "addressId": "8f8065a7-0e97-4892-a4c0-4135b694bfbf",
        "typeId": "b7ef74d0-e9bc-4424-9704-6cf4a5619107",
        "value": "value",
        "createdById": "1b357e1e-43cf-4795-b2c8-260f2c67f984",
        "createdOn": "2021-10-05T10:43:12Z",
        "id": "f5fc1b5f-da8f-4cca-ac98-e108c7883065",
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "1b279789-d9e0-4156-81ea-a69f25054af6",
        "objectState": null,
        "sortOrder": 0,
        "token": 0,
        "typeName": "typeName",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "country": "country",
    "createdById": "05f3b016-bd53-4056-8023-e2040d7b01b7",
    "createdOn": "2021-10-05T10:43:12Z",
    "id": "319646c7-912c-46f4-9ac3-93725f4aaec3",
    "isDefault": true,
    "lastUpdated": "2021-10-05T10:43:12Z",
    "lastUpdatedById": "46acbb4d-848c-416d-8513-87bcd88714dc",
    "objectState": null,
    "sortOrder": 0,
    "state": "state",
    "street1": "street1",
    "street2": "street2",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw==",
    "zip": "zip"
  },
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "fc4eb1e5-22c7-4b7e-a436-a7e1fb078cd4",
      "name": "AssignedGroup"
    }
  ],
  "clientSince": "2021-10-05T10:43:12Z",
  "company": "company",
  "createdById": "6ba12257-4a22-4496-bff6-30497c4c502c",
  "createdOn": "2021-10-05T10:43:12Z",
  "currencyId": "4fb7ae5a-0e77-4be6-a806-325f126e6e01",
  "currencyName": "currencyName",
  "customFields": [
    {
      "definitionId": "f1ad4263-e20b-4534-b226-370a032d4157",
      "createdById": "41076153-9ca4-4ea6-804f-4565717d06a1",
      "createdOn": "2021-10-05T10:43:12Z",
      "description": "CustomFieldData Description",
      "id": "86a72e31-51d8-4883-9f7c-45471151b73e",
      "label": "label",
      "lastUpdated": "2021-10-05T10:43:12Z",
      "lastUpdatedById": "34c2602b-3524-4dc7-bcc2-0c1b60277ce1",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "c887802f-03d6-400c-987f-eb58273942e2",
  "feeScheduleId": "b0a00851-5727-4896-b021-4a021da9caa8",
  "feeScheduleName": "feeScheduleName",
  "firstName": "John",
  "id": "eaba3092-e32a-492a-a328-8db3ab20cd19",
  "lastName": "Doe",
  "lastUpdated": "2021-10-05T10:43:12Z",
  "lastUpdatedById": "6c720099-3f37-4e9e-a2f4-af122659bced",
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "manager": "manager",
  "managerId": "38398940-3802-4ae4-9017-78a0b3755314",
  "memo": "memo",
  "messageOnInvoice": "messageOnInvoice",
  "middleInitial": "middleInitial",
  "objectState": null,
  "status": null,
  "taxId": "taxId",
  "term": "term",
  "termId": "4710a798-4feb-47c5-bdd6-67472ac71d3f",
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to save multiple clients. Pass model as the parameter.

Request URL
base_url/client/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Client objectClientBatchRequest
Response Body
NameDescriptionFormat
batchSize Represents the number of entities in a batchint64
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
progress Represents the total number of entities processedint64
status Represents the status of a job e.g., ready, running, completed, or terminatedstring
token Represents the token for update operationsint32
type Represents the type of a job e.g., create, update, or deletestring
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "batchSize": 0,
  "createdById": "3a755166-4223-4fb7-9215-979d4ff4e7a3",
  "createdOn": "2021-10-05T10:43:12Z",
  "id": "6521ccfa-8e2f-4384-ac0e-83016d0718ea",
  "lastUpdated": "2021-10-05T10:43:12Z",
  "lastUpdatedById": "41a6d8dd-214c-4ab3-b6b4-e140f1414c4b",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to update a client. Pass id and client as the parameters.

Request URL
base_url/client/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Client identifierstring
body Body Client objectClient
Response Body
NameDescriptionFormat
name Client or customer namestring
address Address of a client Address
assignedGroups []List of assigned groups AssignedGroup
clientSince Date when the business was initiated between the company and the client in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
company Client's company namestring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
currencyId Identifier of the client's currency multiplieruuid
currencyName Name of a currency, e.g., U.S.Dollar, British Poundstring
customFields []Represents a list of custom fields CustomFieldData
defaultGroup Name of the default groupstring
defaultGroupId Identifier of the group to which a client belongsuuid
feeScheduleId Represents the fee schedule identifier. Fee schedules are unique fee structures with special bill rates and cost rates by employee, activity item, expense item or groupuuid
feeScheduleName Name of the fee schedulestring
firstName First name of a clientstring
id Object identifieruuid
lastName Last name of the clientstring
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
mainExpenseTax Main expense tax applied to the expense amount on a client invoicedouble
mainServiceTax Main service tax applied to the labor/service amount on a client invoicedouble
manager Name of the employee who is a manager of the clientstring
managerId Identifier of a client manageruuid
memo Records any extra information of a client for recapitulationstring
messageOnInvoice Custom message printed on a client invoicestring
middleInitial Middle initial of the clientstring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
status Current status of the client, e.g., Active or InActive Status
taxId Represents a federal tax identifier.string
term Name of the termstring
termId Identifier of a term (frequency) with which a client will make a paymentuuid
token Represents the token for update operationsint32
type Gets or sets the type. ClientType
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "name": "Client",
  "address": {
    "entityId": "caa7a50d-b035-47d2-acda-bbf1f7f5a890",
    "entityType": null,
    "name": "Address",
    "city": "city",
    "communications": [
      {
        "addressId": "c72a5a70-bfce-4a9b-947c-c22a5ee0f4e3",
        "typeId": "ef409f4c-b5a6-414c-a7d9-05bdcb6833b9",
        "value": "value",
        "createdById": "b2539ff6-12c1-4323-bcbd-eb42f97503dc",
        "createdOn": "2021-10-05T10:43:12Z",
        "id": "f4034cd1-1f1d-4c0c-bd27-f835cad5166a",
        "lastUpdated": "2021-10-05T10:43:12Z",
        "lastUpdatedById": "fd582406-7eb7-4d15-a2b9-e6d6785efa3c",
        "objectState": null,
        "sortOrder": 0,
        "token": 0,
        "typeName": "typeName",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "country": "country",
    "createdById": "e52f316d-72be-4723-8156-4f39f6892446",
    "createdOn": "2021-10-05T10:43:12Z",
    "id": "b2253ebe-3b0a-4a46-a7c4-68410773703a",
    "isDefault": true,
    "lastUpdated": "2021-10-05T10:43:12Z",
    "lastUpdatedById": "e0440baf-bf5e-48f8-acd4-7a6be5c42db4",
    "objectState": null,
    "sortOrder": 0,
    "state": "state",
    "street1": "street1",
    "street2": "street2",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw==",
    "zip": "zip"
  },
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "8dc49c0d-9b81-49b4-a6b8-ff2b4338160f",
      "name": "AssignedGroup"
    }
  ],
  "clientSince": "2021-10-05T10:43:12Z",
  "company": "company",
  "createdById": "bdce597e-6f54-4c04-9150-8b6fd5af80b4",
  "createdOn": "2021-10-05T10:43:12Z",
  "currencyId": "1d774c85-0288-4fa2-a8a4-bbc90b9f63ba",
  "currencyName": "currencyName",
  "customFields": [
    {
      "definitionId": "0b1fa598-1744-4aa4-b0b6-112d1ec060cb",
      "createdById": "43e02473-55a3-48f5-b3d2-ba613b63515b",
      "createdOn": "2021-10-05T10:43:12Z",
      "description": "CustomFieldData Description",
      "id": "f29788e7-2055-4c9b-a8f7-44335e79ff1f",
      "label": "label",
      "lastUpdated": "2021-10-05T10:43:12Z",
      "lastUpdatedById": "e252b2fe-6d85-414d-9b10-cbb185808368",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "0c242905-383f-4ab9-9c06-e2234379b079",
  "feeScheduleId": "7e301774-0438-45ac-9b7f-6deacbece3fe",
  "feeScheduleName": "feeScheduleName",
  "firstName": "John",
  "id": "eacca765-0b2c-4b8d-b67f-7740c565af7b",
  "lastName": "Doe",
  "lastUpdated": "2021-10-05T10:43:12Z",
  "lastUpdatedById": "1a06a78e-98dc-45ab-b09c-461c219cbc75",
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "manager": "manager",
  "managerId": "7fd93e60-6754-4bc3-a176-eb2925dfd7ae",
  "memo": "memo",
  "messageOnInvoice": "messageOnInvoice",
  "middleInitial": "middleInitial",
  "objectState": null,
  "status": null,
  "taxId": "taxId",
  "term": "term",
  "termId": "936877e1-2453-4986-a61a-cea34b7a538e",
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to delete a specific client. Pass id as the parameter.

Request URL
base_url/client/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Client identifierstring
Example Request

Use this method to perform partial modifications to a client. Pass id and patch document as parameters.

Request URL
base_url/client/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Client

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Client identifierstring
body Body A document containing an array of objects with each object representing a single operationClientPatchDocument
Response Body
NameDescriptionFormat
Example Request
Example Response