JDBC Driver for Xero WorkflowMax

Build 22.0.8462

Leads

Return a list of all leads.

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.
  • CreatedDate supports the '<=,<,=,>,>=' operators.

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 Leads WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Leads WHERE CreatedDate='2000-12-12'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12'
SELECT * FROM Leads WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5k9')

Notes:
-When executing a simple SELECT * query the driver will retrieve only your current Leads.
-When specifying CreatedDate the driver will retrieve all Leads.

Insert

Name, ClientUUID, OwnerID are required to insert. The following query creates a new Lead:

INSERT INTO Leads (Name, ClientUUID, OwnerUUID) VALUES ('hey', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')

Columns

Name Type ReadOnly Description
UUID [KEY] String True

Lead identifier.

Name String True

The name of the lead.

Description String True

The description of the lead.

State String True

The state of the lead.

CreatedDate Datetime True

The date when the lead was created.

DateWonLost String True

Date this lead was either won or lost.

Category String True

The category of the lead.

EstimatedValue Int True

Estimated value of the lead.

ClientUUID String True

The client identifier related to the lead.

ClientName String True

The client name related to the lead.

ContactUUID String True

The contact ID of the client related to the lead.

ContactName String True

The contact name of the client related to the lead.

OwnerUUID String True

The owner ID related to the lead.

OwnerName String True

The owner name related to the lead.

CategoryUUID String False

Used while inserting to determine a category for the lead.

TemplateUUID String False

Used while inserting to determine a template for the lead.

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