Example

{
  "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
  "key": "joes-shop",
  "name": "Joe's Shop",
  "code": "JOE",
  "currency": "USD",
  "notes": "Originally based out of Colorado.",
  "emails": [
    "joe@joesshop.com",
    "jane@joesshop.com"
  ],
  "streetAddress": "500 Main Street \nAtlanta, GA 43003",
  "invoiceDetailsSource": "custom",
  "paymentTermsId": "net_15",
  "invoiceSubject": "Invoice for Professional Services",
  "invoiceNotes": "Please remit payment via ACH to Bank: 009235923",
  "invoiceEmailSubject": "Invoice Ready for Your Review - Payment via ACH",
  "invoiceEmailBody": "Hi, \n\nAn invoice has been prepared for your review. Please remit payment via ACH to Bank: 009235923. \n\nThank you for your business!",
  "isInternal": false,
  "recordStatusId": "active",
  "createdAt": "2022-02-24T16:08:18.640Z",
  "practice": {
    "id": "40f95471-7f7c-4ffa-b838-8dcccab0f54a",
    "name": "Digital Transformation"
  },
  "owner": {
    "id": "db010cff-a6f6-4c4e-8160-b6b7562865ff",
    "name": "Cameron Howe"
  },
  "tags": [
    {
      "id": "8670e0fd-bd7a-457e-bec9-eff2b1c12b78",
      "name": "Tier 1 Client"
    },
    {
      "id": "032901d9-4a10-4ff7-af3a-a04ff6e6e606",
      "name": "Mid-Atlantic Region"
    }
  ],
  "useWorkspaceInvoiceDetails": false,
  "businessUnit": {
        "id": "0e8351ea-6b3c-4307-97cc-196448de0ef1",
        "name": "EU"
  }
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`key`	`slug`	A unique, URL-friendly identifier for the client.
`name`	`string`	The name of the client.
`code`	`string`	The client code.
`currency`	`string`	The currency code for the client.
`notes`	`string`	Any notes that have been given.
`emails`	`array of strings`	A list of invoice email addresses associated with the client.
`streetAddress`	`string`	The invoice street address of the client.
`invoiceDetailsSource`	`string`	A value used to set the source of the `paymentTermsId`, `invoiceSubject`, `invoiceNotes`, `invoiceEmailSubject` and `invoiceEmailBody` properties. Possible values are: `"workspace"`, `"custom"` and `"business_unit"`.
`paymentTermsId`	`string`	The invoice payment terms. Can be any of the following values: `"due_on_receipt"` (Due on receipt), `"net_10"` (Net-10), `"net_15"` (Net-15), `"net_30"` ('Net-30), `"net_45"` ('Net-45), `"net_60"` ('Net-60), or `"net_90"` ('Net-90).
`invoiceSubject`	`string`	The invoice subject.
`invoiceNotes`	`string`	The invoice notes.
`invoiceEmailSubject`	`string`	The invoice email subject.
`invoiceEmailBody`	`string`	The invoice email body.
`isInternal`	`boolean`	A flag used to identify the internal client for a workspace. This client is automatically created on workspace creation.
`recordStatusId`	`string`	The status of the client object. Possible values are: `"active"` (Active) or `"archived"` (Archived).
`createdAt`	`timestamp`	The timestamp when the object was created.
`practice`	`object`	A simple object to the related practice, if defined. See attributes.
`owner`	`object`	The workspace member who is assigned as the relationship owner. See attributes.
`tags`	`array of objects`	The list of associated tags. See attributes.
`useWorkspaceInvoiceDetails`	`boolean`	Legacy. This field is read-only. A flag indicating whether the `invoiceDetailsSource` field is set to `"workspace"` or not.
`businessUnit`	`object`	A simple object to the related business unit, if defined. See attributes.

Practice attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the practice.

Member attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the member.

Tag attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the tag.

Business unit attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the business unit.