JDBC Driver for Xero WorkflowMax

Build 22.0.8462

ClientGroups

Return a list of all client groups

Select

The driver will use the Xero WorkflowMax API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. Specifically, the following are processed server-side:

  • UUID supports the '=' operator.

All filterable columns allow multiple values to be specified by using the IN operator. Response time from the server can be improved by identifying only the rows you want to retrieve.

SELECT * FROM ClientGroups WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientGroups WHERE UUID IN ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', '5a92d62b-089f-4d28-a4d2-c69692edc41a')

Insert

ClientUUID and Name are required to insert. The following query creates a new ClientGroup:

INSERT INTO ClientGroups (Name, ClientUUID, Taxable) VALUES('Clients', '446ddb14-4084-48fc-83bd-76b89125450a', true)

Delete

Delete a ClientGroup by specifying the ClientGroup UUID:

DELETE FROM ClientGroups WHERE UUID='c6ec5c2c-2657-4ce3-b035-022c02b9f19e'

Columns

Name Type ReadOnly Description
UUID [KEY] String True

The Id of the client group

Name String False

The name of the client group

Taxable String False

Optional taxable group setting for Practice Manager users

ClientUUID String False

Used for creating a ClientGroup as it is required to put at least one client denoted by their Client ID.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462