Skip to Content

Xero WorkflowMax Connection Details

Introduction

Connector Version

This documentation is based on version 21.0.8663 of the connector.

Get Started

Xero WorkflowMax Version Support

The connector leverages the XeroWorkflowMax API to enable bidirectional access to XeroWorkflowMax.

Establish a Connection

Connect to Xero WorkflowMax

Authenticate via OAuth Authentication

Use the OAuth authentication standard to connect to Xero WorkflowMax API. You can authenticate with a user account. The connector facilitates this as described below.

Use a User Account to Authenticate to Xero WorkflowMax

The user account flow requires the authenticating user to interact with Xero WorkflowMax via the browser.

Custom Credentials

Since connecting with embedded credentials is deprecated, you must register an app to obtain the OAuthClientId and OAuthClientSecret.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Use OAuth Authentication

Use the OAuth authentication standard to connect to Xero WorkflowMax V3 API. You can authenticate with OAuth 2.0. The connector facilitates this as described below.

Custom Credentials

To connect with connector, you must register an app to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

You should create a custom OAuth app to change the information displayed when users log into the Xero WorkflowMax OAuth endpoint to grant permissions to the connector.

Use a Service Account to Connect to Xero WorkflowMax

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the connector.

You need to create an OAuth application in this flow. You can then connect to Xero WorkflowMax data that the service account has permission to access. See Custom Credentials for an authentication guide.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Custom Credentials

You can use a custom OAuth app to authenticate with a service account or a user account. See Using OAuth Authentication for more information.

Authenticate with a User Account
Desktop Authentication with a Custom OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId: Set this to the client ID assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.
  • CallbackURL: Set this to http://localhost:33333.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Headless Machines

Use OAuth on a Headless Machine

The following sections show how to authenticate a headless server or another machine on which the connector cannot open a browser. You can authenticate with a user account or with a service account.

Authenticate with a User Account

To authenticate with a user account, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the OAuth credentials for your custom OAuth app.

Use the Credentials for a Custom OAuth App

Create a Custom OAuth App

Creating a custom OAuth app is mandatory in the headless OAuth flow.

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

Set the following properties on the headless machine:

  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • CallbackURL: Set this to http://localhost:33333.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

After the OAuth settings file is generated, set the following properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthSettingsLocation: Set this to a writable text file.
  • OAuthClientId: Set this to the client ID assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.
  • CallbackURL: Set this to http://localhost:33333.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Create a Custom OAuth App

To properly set up a Xero Workflow Max application follow the instructions below.

Register an Application

To obtain the OAuth client credentials, the Client ID, and Client Secret follow these steps below:

  1. Go to Xero WorkflowMax App Manager
  2. On top-right corner click New App.
  3. Select Web App.
  4. Add the redirect URL to OAuth 2.0 redirect URI field for example: http://localhost:33333 which is our internal callback URL.
  5. Fill the other form fields as desired.
  6. Click on Create App.
  7. Click Save and you will be redirected to the your new app page.
  8. Scroll to the bottom and you will find the Client ID.
  9. Click on Generate a secret to create your Client Secret.
Set the right permissions

A new Staff Privilege has been added to control who has permission to connect your Account to 3rd Party Addons. Any Staff with Administrator Privileges can assign this new Privilege to themselves or other Administrators. Follow these steps below for each Staff member you want to be able to authorise connections to 3rd Party Addons.

  1. Go to Xero WorkflowMax Staff Settings
  2. Search for the Staff Member that you would like to add this permission to and click on it.
  3. If the Staff does not have Administrator privilege under Admin Privileges, you will have to check the box and click Save. You will be redirected to the staff list where you will have to click on the staff member again.
  4. Scroll to the bottom under API Access Privileges, check the box on Authorise 3rd Party Full Access and click Save.
  5. Now the staff selected has access to the Xero Workflow Max V3 API

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Xero WorkflowMax connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

User Defined Views

The Xero WorkflowMax connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Clients WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Xero WorkflowMax APIs.

Key Features

  • The connector models Xero WorkflowMax entities like Clients, Suppliers, and Jobs as relational views, allowing you to write SQL to query Xero WorkflowMax data.
  • Stored procedures allow you to execute operations to Xero WorkflowMax.
  • Live connectivity to these objects means any changes to your Xero WorkflowMax account are immediately reflected when using the connector.

Custom Fields

The XeroWOrkflowMax driver supports custom fields. To be able to retrieve and update custom fields IncludeCustomFields must be set as a connection property. Keep in mind that the driver will be slow when getting custom fields as it fetches them one by one. To improve performance try to specify the ID of the resource you are trying to query.

Collaborative Query Processing

The connector offloads as much of the SELECT statement processing as possible to Xero WorkflowMax and then processes the rest of the query in memory. API limitations and requirements are also documented in this section.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Tables

The connector models the data in Xero WorkflowMax into a list of tables that can be queried using standard SQL statements.

Generally, querying Xero WorkflowMax tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Xero WorkflowMax Connector Tables

Name Description
ClientContacts Return a list of all contacts of clients.
ClientGroups Return a list of all client groups
Clients Return a list of all clients.
Costs Return a list of all costs
JobCosts Return a list of all costs of jobs.
JobNotes Return a list of all notes of a job
Jobs Return a list of all jobs.
JobTasks Return a list of all tasks of jobs.
Leads Return a list of all leads.
PurchaseOrderDrafts Return a list of all draft purchase orders
PurchaseOrders Return a list of all purchase orders
StaffList Return a list of all staff members
SupplierContacts Return a list of all suppliers.
Suppliers Return a list of all suppliers.
Times Return a list of all time sheets.

ClientContacts

Return a list of all contacts of clients.

Select

The connector 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 ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientContacts WHERE UUID IN ('3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9', 'd807cf4c-a2b9-428a-82e7-124b4f3ddab4')
Insert

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

INSERT INTO ClientContacts (ClientUUID, Name) VALUES ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', 'Rambo')
Update

You can update a ClientContact by specifying the ClientContact UUID:

UPDATE ClientContacts SET Name = 'Arnold' WHERE UUID='3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Delete

Delete a ClientContact by specifying the ClientContact UUID:

DELETE FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Columns
Name Type ReadOnly Description
ClientUUID String False The ID of the client
UUID [KEY] String True The ID of the contact which belongs to the client
Name String False The name of the contact
Mobile String False Mobile number of the contact
Email String False Email of the contact
Phone String False Phone number of the contact
Position String False The position of the contact
Salutation String False Salutation is used following 'Dear...
Addressee String False The addresse of the contact
IsPrimary String False Determines if this contact is the main contact used by client Yes | No

ClientGroups

Return a list of all client groups

Select

The connector 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.

Clients

Return a list of all clients.

Select

The connector 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.
  • Name supports 'CONTAINS'.

UUID column 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 Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Clients WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
SELECT * FROM Clients WHERE CONTAINS(Name, 'Brian')
SELECT * FROM Clients WHERE ModifiedSince='2012-06-05T06:00:00'
Insert

Name is required to insert. The following query creates a new Clients:

INSERT INTO Clients (Name) VALUES ('some name')
Update

You can update by specifying the Clients UUID:

UPDATE Clients SET Name='Arnold' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Delete

Delete a Client by specifying the Client UUID:

DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Archive a Client by specifying the Client UUID and setting Archive=true:

DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND Archive=true
Columns
Name Type ReadOnly Description
UUID [KEY] String True The ID of the client.
Name String False The name of the client.
Email String False The email of the client.
Address String False The address of the client.
City String False The city where the client is located.
Region String False The region where the client is located.
PostCode String False The postal code of where the client is located.
Country String False The country where the client is located.
PostalAddress String False The address of the postal office.
PostalCity String False The city where the postal office is located.
PostalRegion String False The region where the postal office is located.
PostalPostCode String False The postal code of the postal office.
PostalCountry String False The country where the postal office is located.
Phone String False The phone number of the client.
Fax String False The fax number of the client.
Website String False The website associated with the client.
ReferralSource String False Source the client was referred by.
ExportCode String False The export code (such as an account code / tax code) associated with the client.
IsProspect String False Determines if the client is a potential customer
AccountManagerUUID String False Optional - ID of staff member.
AccountManagerName String True Name of staff member.
TypeName String True The type of client
TypeCostMarkup String True The markup % of the type of client
TypePaymentTerm String True The payment terms of the type of client
TypePaymentDay String True The payment day / number of days of the type of client
FirstName String False Optional for individuals, firstname of the individual
LastName String False Optional for individuals, LastName of the individual
OtherName String False Optional for individuals, OtherName of the individual
DateOfBirth Datetime False Optional for individuals, date of birth of the individual
BillingClientUUID String False Used in cases where the client is different than the billing client.
BillingClientName String False Billing client name.
JobManagerUUID String False optional - ID of staff member
JobManagerName String True Name of staff member.
TaxNumber String False Identifying number used for tax purposes
CompanyNumber String False The company registration number.
BusinessNumber String False Name of Business Structure (as per Admin)
BalanceMonth String False e.g. Jan, 1, Feb, 2, Mar, 3 etc
PrepareGST String False Yes or No
GSTRegistered String False Yes or No
GSTPeriod String False 1, 2, 6
GSTBasis String False Invoice, Payment, Hybrid
ProvisionalTaxBasis String False Standard Option, Estimate Option, Ratio Option
ProvisionalTaxRatio String False Tax ratio for the client when the Ratio option is selected for ProvisionalTaxBasis.
SignedTaxAuthority String False Yes or No (NZ clients only)
TaxAgent String False Name of Tax Agent (as per Admin) (NZ clients only)
AgencyStatus String False With EOT, Without EOT, Unlinked (NZ clients only)
ReturnType String False IR3, IR3NR, IR4, IR6, IR7, IR9, PTS (NZ clients only)
PrepareActivityStatement String False Yes or No (AU clients only)
PrepareTaxReturn String False Yes or No (AU clients only)
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ModifiedSince String Used for filtering clients from their last time modified.
Archive Boolean Used for archiving a Client not deleting it completely

Costs

Return a list of all costs

Select

The connector 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 Costs WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Costs WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26av43')
Insert

Description, UnitPrice, UnitCost are required to insert. The following query creates a new Cost:

INSERT INTO Costs (Description, UnitPrice, UnitCost) VALUES ('decr', 100, 200)
Update

You can update a Cost by specifying the Cost UUID:

UPDATE Costs SET UnitPrice='101' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Delete

Delete a Cost by specifying the Cost UUID:

DELETE FROM Costs WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columns
Name Type ReadOnly Description
UUID [KEY] String True The ID of the Cost.
Description String False The description related to the cost.
Code String False The code of the unit.
Note String False The note related to the cost.
UnitCost Float False Cost per unit.
UnitPrice Float False Price per unit.
SupplierUUID String False Determines the supplier identifier.
SupplierName String True Determines the supplier name.

JobCosts

Return a list of all costs of jobs.

Select

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again.

In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

The connector 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:

  • JobID 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 JobCosts WHERE JobID='J000002'
SELECT * FROM JobCosts WHERE JobID IN ('J000001', 'J000002')
Insert

JobID, Date, Description, Quantity, UnitCost, UnitPrice are required to insert. The following query creates a new JobCost:

INSERT INTO JobCosts (JobID, Date, Description, Quantity, UnitCost, UnitPrice) VALUES ('J000002', '2019-07-17T00:00:00', 'Maybach', '123', 30, 50)
Columns
Name Type ReadOnly Description
JobID String False Job Identifier related to the cost.
UUID [KEY] String True Cost identifier.
Date Datetime False The date when the cost was created.
Description String False The description related to the cost.
Code String False The code of the unit.
Note String False The note related to the cost.
Quantity Double False Product quantity.
UnitCost Float False Cost per unit.
UnitPrice Float False Price per unit.
SupplierUUID String False Determines the supplier identifier.
SupplierName String True Determines the supplier name.
Billable String True Determines if the cost is billable or not true(default) | false.

JobNotes

Return a list of all notes of a job

Select

The connector will process all filters client side.

Insert

JobID, Title, Text are required to insert. The following query creates a new JobNote:

INSERT INTO JobNotes (JobID, Title, Text) VALUES ('J000001', '133193699', 'some notes')
Columns
Name Type ReadOnly Description
JobID String False The ID of the job which has the note.
UUID [KEY] String True The note identifier.
Title String False The title of the note.
Text String False The text of the note.
Folder String False The folder where the note is.
Date Datetime True The date on which the note was created.
CreatedBy String True The name of the staff who created the note.
Comments String True All comments in a note in xml format.
Public String False Determines if the note is public to staff members. True | False

Jobs

Return a list of all jobs.

Select

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again.

In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

The connector 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:

  • Id supports the = operator.
  • AssignedStaffUUID supports the = operator.
  • ClientUUID 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 Jobs WHERE CreatedDate>='2020-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12'
SELECT * FROM Jobs WHERE ID='J000001'
SELECT * FROM Jobs WHERE AssignedStaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ID IN ('23423', '34534')
SELECT * FROM Jobs WHERE AssignedStaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a8f6', '9d382fcf-7013-4d97-8dd8-c08e8b26a4d2')
SELECT * FROM Jobs WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6i1')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Invoices.
-When specifying CreatedDate the connector will retrieve the current and archived Jobs.

Insert

Name, ClientUUID, StartDate, DueDate are required to insert. The following query creates a new Job:

INSERT INTO Jobs (Name, ClientUUID, StartDate, DueDate) VALUES ('Job Name', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Update

You can update by specifying the Job ID:

UPDATE Jobs SET StartDate='2007-07-16T00:00:00' WHERE Id='J000003'
Delete

Delete a Job by specifying the Job ID:

DELETE FROM Jobs WHERE ID='J000003'
Columns
Name Type ReadOnly Description
ID [KEY] String False Job identifier.
Name String False The name of the job.
Description String False The description related to the job.
State String True The state of the job.
ClientOrderNumber String False Order number assoicated with this job.
StartDate Datetime False The date when the job has started.
DueDate Datetime False The date when the job should be completed.
CompletedDate Datetime False The date when the job has been completed.
ClientUUID String False The client identifier related to the job.
ClientName String False The client name related to the job.
ContactUUID String False The client identifier related to the job.
ContactName String False The client name related to the job.
ManagerUUID String False The manager identifier related to the job.
ManagerName String False The manager name related to the job.
PartnerUUID String False The partner identifier related to the job.
PartnerName String False The partner name related to the job.
AssignedStaff String True List of staff members assigned to the job in xml format.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
TemplateUUID String Used while inserting a job to determine its initial template.
CategoryUUID String Used while inserting a job to determine its initial category.
AssignedStaffUUID String Used to filter jobs based on the staff member assigned.
CreatedDate Date Used to filter jobs from their date of creation.

JobTasks

Return a list of all tasks of jobs.

Select

The connector 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:

  • Complete supports the = operator.
  • CreatedDate supports the '<=,<,=,>,>=' operators.
SELECT * FROM JobTasks WHERE Complete=False
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11'
SELECT * FROM JobTasks WHERE CreatedDate='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11' AND Complete=true
Insert

EstimatedMinutes, TaskID, JobID, Name, StartDate, DueDate are required to insert. The following query creates a new JobTask:

INSERT INTO JobTasks (EstimatedMinutes, TaskUUID, JobID, Name, StartDate, DueDate) VALUES ('100', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'J000002', '21910642', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Columns
Name Type ReadOnly Description
JobID String True The job identifier related to the task.
UUID [KEY] String True The task identifier.
TaskUUID String True The task identifier references Tasks.ID.
Name String True The name of the task.
Description String True The description related to the task.
EstimatedMinutes Int True The estimated time for completing the task.
ActualMinutes Int True Actual time passed.
Completed Boolean True Determine if the task is completed or not.
Billable Boolean True Determines if the task is billable or not true(default) | false.
CreatedDate Date True Determines the datetime when the task has started.
DueDate Date True Determines the datetime when the task should be finished.
AssignedStaffUUID String True List of staff members assigned to the job in xml format
Label String False Used while inserting to determine a label to the task.

Leads

Return a list of all leads.

Select

The connector 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 connector will retrieve only your current Leads.
-When specifying CreatedDate the connector 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.

PurchaseOrderDrafts

Return a list of all draft purchase orders

Select

The connector will process all filters client side.

Insert

To insert into PurchaseOrderDrafts you will need to insert temporary at least one PurchaseOrderCost which will serve as items for the PurchaseOrder. You can do that by denoting the table name as PurchaseOrderCosts#TEMP. After inserting to the temporary table you can execute an insert to PurchaseOrders by setting PurchaseOrderCosts = PurchaseOrderCosts#TEMP as in the query below. JobID, SupplierUUID, Date, PurchaseOrderCosts are required to insert. The following queries are needed to create a new PurchaseOrder with 2 PurchaseOrderCost items:

INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrderDrafts (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Alternatively you can execute an INSERT operation on PurchaseOrder by setting the value for PurchaseOrderCosts as a xml string of items in the following structure:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Columns
Name Type ReadOnly Description
ID [KEY] String False The purchase order identifier.
Description String False The description related to the purchase order.
State String False The state of the purchase order.
CreatedDate Datetime True The date when the purchase order was created.
DeliveryAddress String False Delivery address for the purchase order.
Amount Float True The amount to pay.
AmountTax Float True The tax amount to pay.
AmountIncludingTax Float True The total amount to pay including tax.
SupplierUUID String False The supplier identifier related to the purchase order.
SupplierName String True The supplier name related to the purchase order.
JobID String False The job identifier related to the purchase order.
JobName String True The job name related to the purchase order.
PurchaseOrderCosts String False Lists all purchase orders costs, xml format.

PurchaseOrders

Return a list of all purchase orders

Select

The connector 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:

  • Id supports the = operator.
  • JobID 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 PurchaseOrders WHERE ID='2512811'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate='2000-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12'
SELECT * FROM PurchaseOrders WHERE ID IN ('23423', '34534')
SELECT * FROM PurchaseOrders WHERE JobID IN ('23423', '34534')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current PurchaseOrders.
-When specifying CreatedDate the connector will retrieve the current and archived PurchaseOrders.

Insert

To insert into PurchaseOrders you will need to insert temporary at least one PurchaseOrderCost which will serve as items for the PurchaseOrder. You can do that by denoting the table name as PurchaseOrderCosts#TEMP. After inserting to the temporary table you can execute an insert to PurchaseOrders by setting PurchaseOrderCosts = PurchaseOrderCosts#TEMP as in the query below. JobID, SupplierUUID, Date, PurchaseOrderCosts are required to insert. The following queries are needed to create a new PurchaseOrder with 2 PurchaseOrderCost items:

INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrders (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Alternatively you can execute an INSERT operation on PurchaseOrder by setting the value for PurchaseOrderCosts as a xml string of items in the following structure:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Columns
Name Type ReadOnly Description
ID [KEY] String False The purchase order identifier.
Description String False The description related to the purchase order.
State String False The state of the purchase order.
CreatedDate Datetime True The date when the purchase order was created.
DeliveryAddress String False Delivery address for the purchase order.
Amount Float True The amount to pay.
AmountTax Float True The tax amount to pay.
AmountIncludingTax Float True The total amount to pay including tax.
SupplierUUID String False The supplier identifier related to the purchase order.
SupplierName String True The supplier name related to the purchase order.
JobID String False The job identifier related to the purchase order.
JobName String True The job name related to the purchase order.
PurchaseOrderCosts String False Lists all purchase orders costs, xml format.

StaffList

Return a list of all staff members

Select

The connector 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 StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM StaffList WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a9f6')
Insert

Name is required to insert. The following query creates a new StaffList member:

INSERT INTO StaffList (Name) VALUES ('J000002')
Update

You can update a Staff member by specifying the Staff member UUID:

UPDATE StaffList SET Email='hey@gmail.com', Phone='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Delete

Delete a Staff member by specifying the Staff member UUID:

DELETE FROM StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columns
Name Type ReadOnly Description
UUID [KEY] String True The staff member identifier.
Name String False The staff member name.
Email String False The staff member email.
Phone String False The staff member phone number.
Mobile String False The staff member mobile number.
Address String False The staff member address.
PayrollCode String False Payroll code for the staff member.

SupplierContacts

Return a list of all suppliers.

Select

The connector 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 SupplierContacts WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5hj')
SELECT * FROM SupplierContacts WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Insert

SupplierUUID, Name are required to insert. The following query creates a new SupplierContact:

INSERT INTO SupplierContacts (SupplierUUID, Name) VALUES ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'ckemi')
Update

You can update a SupplierContact by specifying the SupplierContact UUID:

UPDATE SupplierContacts SET Name='hey@gmail.com', Mobile='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columns
Name Type ReadOnly Description
SupplierUUID String False The ID of the supplier.
UUID [KEY] String True The ID of the contact which belongs to the supplier.
Name String False The name of the contact.
Mobile String False The mobile number of the contact.
Email String False The email of the contact.
Phone String False The phone number of the contact.
Position String False The position of the contact.

Suppliers

Return a list of all suppliers.

Select

The connector 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 Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Suppliers WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')
Insert

Name is required to insert. The following query creates a new Supplier:

INSERT INTO Suppliers (Name) VALUES ('Arnold')
Update

You can update by specifying the UUID:

UPDATE Suppliers SET Address='hey@hey.com', City='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Delete

Delete a Supplier by specifying the Supplier UUID:

DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Archive a Supplier by specifying the Supplier UUID and setting Archive=true in the query:

DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' and Archive=true
Columns
Name Type ReadOnly Description
UUID [KEY] String True The ID of the supplier.
Name String False The name of the supplier.
Address String False The address of the supplier.
City String False The city where the supplier is located.
Region String False The region where the client is located.
PostCode String False The postal code of where the supplier is located.
Country String False The country where the supplier is located.
PostalAddress String False The address of the postal office.
PostalCity String False The city where the postal office is located.
PostalRegion String False The region where the postal office is located.
PostalPostCode String False The postal code of the postal office.
PostalCountry String False The country where the postal office is located.
Phone String False The phone number of the supplier.
Fax String False The fax number of the supplier.
Website String False The website of the supplier.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Archive String Used for archiving a supplier not deleting it completely

Times

Return a list of all time sheets.

Select

The connector 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:

The connector 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.
  • JobID supports the = operator.
  • StaffID 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 Times WHERE JobID='J000001'
SELECT * FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Times WHERE CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE StaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE StaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE JobID IN ('J000001', 'J000002')
Insert

JobID, TaskID, StaffID, Date, Minutes are required to insert. The following query creates a new Time entry:

INSERT INTO Times (JobID, TaskUUID, StaffUUID, Date, Minutes) VALUES ('J000001', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5e8', '2019-06-27T00:00:00', '240')
Update

You can update by specifying the UUID:

UPDATE Times SET Date='2019-06-27T00:00:00', Minutes='240' WHERE UUID='250193564'
Delete

Delete a Time entry by specifying the UUID:

DELETE FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columns
Name Type ReadOnly Description
UUID [KEY] String False The ID of the timesheet entry.
JobID String False The ID of the job related to the timesheet entry.
JobName String True The name of the job related to the timesheet entry.
TaskUUID String False The ID of the task related to the timesheet entry.
TaskName String True The name of the task related to the timesheet entry.
StaffUUID String False The ID of the staff related to the timesheet entry.
StaffName String True The name of the staff related to the timesheet entry.
CreatedDate Datetime False The date of the timesheet entry .
Minutes Int False The minutes of how much the timesheet entry will last.
Note String False The note related to the timesheet entry.
Billable Boolean False Boolean indicating if this time is billable or not.
Start Time False The start time of the timesheet entry.
End Time False The time when the timesheet entry ended.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Xero WorkflowMax Connector Views

Name Description
Categories Return a list of all categories
ClientDocuments Return a list of all documents of the clients.
ClientNotes Return all notes of clients
InvoiceDrafts Return a list of draft invoices
InvoicePayments Return a list of invoice payments
Invoices Return a list of invoices
InvoicesJobTask Return a list of invoices related to Tasks.
JobDocuments Return a list of all documents of a job
JobMilestones Return all milestones of jobs
LeadCategories Return a list of lead categories
PurchaseOrderCosts Return all purchase order costs
QuoteDrafts Return a list of all draft quotes
Quotes Return a list of all quotes
QuotesCost Return a list of quotes related to costs.
QuotesOption Return a list of quotes related to options.
QuotesTask Return a list of quotes related to Tasks.
Tasks Return a list of all tasks
Templates Return a list of all templates

Categories

Return a list of all categories

Select

The connector will process all filters client side.

Columns
Name Type Description
UUID [KEY] String The ID of the category
Name String The name of the category

ClientDocuments

Return a list of all documents of the clients.

Select

The connector 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:

  • ClientUUID supports the = operator.

To execute a SELECT query to ClientDocuments you must provide the ClientUUID as a WHERE condition. Specifically, the following are processed server-side:

SELECT * FROM ClientDocuments WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

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 ClientDocuments WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
Columns
Name Type Description
ClientUUID [KEY] String The ID of the client which has the document.
Title String The title of the document.
Text String The note relating to the document.
Folder String The folder where the document is.
Date Datetime The date on which the document was created.
CreatedBy String The name of the staff who created the document.
URL String The URL used to direct download the document.

ClientNotes

Return all notes of clients

Select

The connector will process all filters client side.

Columns
Name Type Description
ClientUUID [KEY] String The ID of the Client which has the notes.
Title String The title of the note.
Text String The text on the note.
Folder String The folder where the note is.
Date Date The date on which the note was created.
CreatedBy String The name of the staff who created the document.

InvoiceDrafts

Return a list of draft invoices

Select

The connector will process all filters client side.

Columns
Name Type Description
UUID [KEY] String The name of the category
Type String Determines the type of the invoice.
Status String Status of the invoice Approved, Paid, Draft, Cancelled
JobID String Id of the job associated with this Invoice.
CreatedDate Date Determines the date when the invoice was created.
DueDate Date Determines the due date for the invoice.
Amount Float The amount to pay.
AmountTax Float The tax amount to pay.
AmountIncludingTax Float The total amount to pay including tax.
AmountPaid Float Determine the amount which has already been paid.
AmountOutstanding Float Determines the amount thats left to pay.
ClientUUID String Client identifier related to the invoice.
ClientName String Client name related to teh invoice.
ContactUUID String Contact identifier of the client related to the invoice.
ContactName String Contact name of the client related to the invoice.

InvoicePayments

Return a list of invoice payments

Select

The connector will process all filters client side.

Columns
Name Type Description
InvoiceID [KEY] String The identifier of the invoice
Date Date The date of the payment
Amount Float The amount that has been payed.
Reference String The reference of the payment

Invoices

Return a list of invoices

Select

The connector 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:

  • 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 Invoices WHERE CreatedDate>='2019-08-07' and CreatedDate<='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate>='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate='2019-08-07'

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Invoices.
-When specifying CreatedFrom and CreatedTo the connector will retrieve the current and archived Invoices.

Columns
Name Type Description
ID [KEY] String The name of the category
Type String Determines the type of the invoice.
Status String Status of the invoice Approved, Paid, Draft, Cancelled
JobID String Id of the job associated with this Invoice.
CreatedDate Date Determines the date when the invoice was created.
DueDate Date Determines the due date for the invoice.
Amount Float The amount to pay.
AmountTax Float The tax amount to pay.
AmountIncludingTax Float The total amount to pay including tax.
AmountPaid Float Determine the amount which has already been paid.
AmountOutstanding Float Determines the amount thats left to pay.
ClientUUID String Client identifier related to the invoice.
ClientName String Client name related to teh invoice.
ContactUUID String Contact identifier of the client related to the invoice.
ContactName String Contact name of the client related to the invoice.

InvoicesJobTask

Return a list of invoices related to Tasks.

Select

The connector will process all filters client side except InvoiceID.

SELECT * FROM InvoicesJobTask
Select * from InvoicesJobTask where InvoiceID = 'I000123'
Select * from InvoicesJobTask where InvoiceID IN ('I000124', 'I000123')
Columns
Name Type Description
InvoiceID [KEY] String The identifier of the invoice
Name String The Name of the task related to the invoice.
Description String The Description of the task related to the invoice.
Minutes Int The Minutes of the task related to the invoice.
BillableRate Double The BillableRate of the task related to the invoice.
Billable String The Billable of the task related to the invoice.
Amount Double The Amount of the task related to the invoice.
AmountTax Double The AmountTax of the task related to the invoice.
AmountIncludingTax Double The AmountIncludingTax of the task related to the invoice.

JobDocuments

Return a list of all documents of a job

Select

The connector 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:

  • JobID 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 JobDocuments WHERE JobID='J000001'
SELECT * FROM JobDocuments WHERE JobID IN ('23423', '34534')
Columns
Name Type Description
JobID [KEY] String The ID of the job which has the document.
Title String The title of the document.
Text String The note relating to the document.
Folder String The folder where the document is.
Date Datetime The date on which the document was created.
CreatedBy String The name of the staff who created the document.
URL String The URL used to direct download the document.

JobMilestones

Return all milestones of jobs

Select

The connector will process all filters client side.

Columns
Name Type Description
JobID [KEY] String The ID of the job related to the milestone.
Date Date The date which the mileston refers.
Description String The description related to the milestone.
Completed Boolean Determines if the milestone has been completed or not.

LeadCategories

Return a list of lead categories

Select

The connector will process all filters client side.

Columns
Name Type Description
UUID [KEY] String The UUID of the category
Name String The name of the category

PurchaseOrderCosts

Return all purchase order costs

Select

The connector will process all filters client side.

Insert

Description, Quantity, UnitCost, Code, Note are required to insert into the temporary table. The following query creates a new PurchaseOrderCost entry in memory:

INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('hey descr', 4, 50, '123', 'note')

After inserting to PurchaseOrderCosts#TEMP, you have all the items you need to insert the PurchaseOrder. See PurchaseOrders for more details on inserting to Purchase Orders.

Columns
Name Type Description
PurchaseOrderID [KEY] String Since costs don't have an identifier this is the Purchase order identifier which references PurchaseOrders.ID
Description String The description related to teh cost
Code String The code of the unit.
Quantity Int Product quantity.
UnitCost Float Cost per unit.
Amount Float The amount to pay.
AmountTax Float The tax amount to pay.
AmountIncludingTax Float The total amount to pay including tax.
Note String The note related to the cost.

QuoteDrafts

Return a list of all draft quotes

Select

The connector will process all filters client side.

Columns
Name Type Description
ID [KEY] String The quote identifier.
Type String The type of the quote.
State String The state of the quote.
CreatedDate Datetime The date when the quote was created.
ValidDate Datetime The date till the quote is valid.
Budget String The budget for the quote.
OptionExplanation String A description to explain the options related to the quote.
EstimatedCost Float Estimated cost amount.
EstimatedCostTax Float Estimated tax cost amount.
EstimatedCostIncludingTax Float Estimated total amount including tax.
AmountTax Float Amount to pay.
AmountIncludingTax Float Tax amount to pay.
Amount Float Total amount to pay including tax.
ClientUUID String The Client identifier which is related to the quote.
ClientName String The Client name which is related to the quote.
ContactUUID String The contact ID of the client which is related to the quote.
ContactName String The contact name of the client which is related to the quote.

Quotes

Return a list of all quotes

Select

The connector 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:

  • Id supports the = operator.
  • CreatedDate supports the '<=,<,=,>,>=' operators.

All filterable columns except CreatedDate 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 Quotes WHERE ID='Q000001'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Quotes WHERE CreatedDate='2000-12-12'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12'
SELECT * FROM Quotes WHERE ID IN ('Q000001', 'Q000002')

Notes:

-When executing a simple SELECT * query the connector will retrieve only your current Quotes.
-When specifying CreatedDate the connector will retrieve the current and archived Quotes.

Columns
Name Type Description
ID [KEY] String The quote identifier.
Type String The type of the quote.
State String The state of the quote.
CreatedDate Datetime The date when the quote was created.
ValidDate Datetime The date till the quote is valid.
Budget String The budget for the quote.
OptionExplanation String A description to explain the options related to the quote.
EstimatedCost Float Estimated cost amount.
EstimatedCostTax Float Estimated tax cost amount.
EstimatedCostIncludingTax Float Estimated total amount including tax.
AmountTax Float Amount to pay.
AmountIncludingTax Float Tax amount to pay.
Amount Float Total amount to pay including tax.
ClientUUID String The Client identifier which is related to the quote.
ClientName String The Client name which is related to the quote.
ContactUUID String The contact ID of the client which is related to the quote.
ContactName String The contact name of the client which is related to the quote.

QuotesCost

Return a list of quotes related to costs.

Select

The connector will process all filters client side except QuoteID.

Select * from QuotesCost
Select * from QuotesCost where QuoteID = 'Q000123'
Select * from QuotesCost where QuoteID IN ('Q000124', 'Q000123')
Columns
Name Type Description
QuoteID [KEY] String The identifier of the Quote.
Description String The Description of the task related to the costs.
Note String The Note of the task related to the costs.
Code String The Code of the task related to the costs.
Billable String The Billable of the task related to the costs.
Quantity Int The Quantity of the task related to the costs.
UnitCost Double The UnitCost of the task related to the costs.
UnitPrice Double The UnitPrice of the task related to the costs.
Amount Double The Amount of the task related to the costs.
AmountTax Double The AmountTax of the task related to the costs.
AmountIncludingTax Double The AmountIncludingTax of the task related to the costs.

QuotesOption

Return a list of quotes related to options.

Select

The connector will process all filters client side except QuoteID.

Select * from QuotesOption
Select * from QuotesOption where QuoteID = 'Q000123'
Select * from QuotesOption where QuoteID IN ('Q000124', 'Q000123')
Columns
Name Type Description
QuoteID [KEY] String The identifier of the Quote.
Description String The Description of the task related to the options.
Note String The Note of the task related to the options.
Code String The Code of the task related to the options.
Quantity Int The Quantity of the task related to the options.
UnitCost Double The UnitCost of the task related to the options.
UnitPrice Double The UnitPrice of the task related to the options.
Amount Double The Amount of the task related to the options.
AmountTax Double The AmountTax of the task related to the options.
AmountIncludingTax Double The AmountIncludingTax of the task related to the options.

QuotesTask

Return a list of quotes related to Tasks.

Select

The connector will process all filters client side except QuoteID.

Select * from QuotesTask
Select * from QuotesTask where QuoteID = 'Q000123'
Select * from QuotesTask where QuoteID IN ('Q000124', 'Q000123')
Columns
Name Type Description
QuoteID [KEY] String The identifier of the Quote.
Name String The Name of the task related to the Quote.
Description String The Description of the task related to the Quote.
EstimatedMinutes Int The Minutes of the task related to the Quote.
BillableRate Double The BillableRate of the task related to the Quote.
Billable String The Billable of the task related to the Quote.
Amount Double The Amount of the task related to the Quote.
AmountTax Double The AmountTax of the task related to the Quote.
AmountIncludingTax Double The AmountIncludingTax of the task related to the Quote.

Tasks

Return a list of all tasks

Select

The connector 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 Tasks WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Tasks WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6g9')
Columns
Name Type Description
UUID [KEY] String Task identifier.
Name String The task name
Description String The task description.

Templates

Return a list of all templates

Select

The connector will process all filters client side.

Columns
Name Type Description
UUID [KEY] String The template identifier.
Name String The templates name.

Stored Procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Xero WorkflowMax Connector Stored Procedures

Name Description
ApplyJobTemplate Apply an additional template to a job
ChangeJobStatus Used to change job status
ChangeTaskStatus Used to change task status completed or opened
CreateJobEstimate Used to create a job estimate
CreateJobQuote Used to create a job quote.
DeleteAllCosts Used to delete all costs.
GetOAuthAccessToken Gets an authentication token from Xero WorkflowMax.
GetOAuthAuthorizationURL Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
ManageClientGroupMembers Manage the members of a client group
ManageJobMembers Manage the members of a job.
ManageStaffLogin Enable or disable staff members login.
ManageTaskStaff Manage the staff members of a task
RefreshOAuthAccessToken Refreshes the OAuth access token used for authentication with various Basecamp services.
UploadClientDocument Upload a document to a Client
UploadJobDocument Upload a document to a Job

ApplyJobTemplate

Apply an additional template to a job

Input
Name Type Description
JobID String The ID of the Job
TemplateUUID String The UUID of the template to apply
TaskMode String TaskMode describes how tasks are added to the job. AddNew: tasks are always added to the job (default). AppendExisting: where the same task already exists on the job, the template task will be appended to the details of the existing task, otherwise the task will be added to the job
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

ChangeJobStatus

Used to change job status

Input
Name Type Description
JobID String The ID of the Job
State String The value of the state element is that in the Interface Code field for each Job State as defined in Admin
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

ChangeTaskStatus

Used to change task status completed or opened

Input
Name Type Description
TaskUUID String The UUID of the Task
State String Set this to complete/reopen to mark a Task as completed or not.
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CreateJobEstimate

Used to create a job estimate

Input
Name Type Description
JobID String The ID of the Job
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

CreateJobQuote

Used to create a job quote.

Input
Name Type Description
JobID String The ID of the Job
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

DeleteAllCosts

Used to delete all costs.

Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

GetOAuthAccessToken

Gets an authentication token from Xero WorkflowMax.

Input
Name Type Description
AuthMode String The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP.
Scope String A comma-separated list of permissions to request from the user. Please check the Xero WorkflowMax API for a list of available permissions.
CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Xero WorkflowMax app settings. Only needed when the Authmode parameter is Web.
Verifier String The verifier returned from Xero WorkflowMax after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State String Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Xero WorkflowMax authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
Result Set Columns
Name Type Description
OAuthAccessToken String The access token used for communication with Xero WorkflowMax.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in the case of Xero WorkflowMax.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.
TenantId String The ID associated with a Xero WorkflowMax tenant, which is needed, alongside an OAuthAccessToken, to authenticate an OAuth app to Xero WorkflowMax.

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input
Name Type Description
CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Xero WorkflowMax app settings.
Scope String A comma-separated list of scopes to request from the user. Please check the Xero WorkflowMax API documentation for a list of available permissions.
State String Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Xero WorkflowMax authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
Result Set Columns
Name Type Description
URL String The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

ManageClientGroupMembers

Manage the members of a client group

Input
Name Type Description
ClientGroupUUID String ID of Group to add client to
Add String ID of client to add to group
Remove String ID of client to remove from group
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

ManageJobMembers

Manage the members of a job.

Input
Name Type Description
JobID String ID of Job to add/remove staff members
Add String UUID of Staff member to add
Remove String UUID of Staff member to remove
Operation String Specify an operation from the following : -ChangeStaff to add/remove staff members from job -ChangeManager to add/remove manager from job -ChangePartner to add/remove partner from job
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

ManageStaffLogin

Enable or disable staff members login.

Input
Name Type Description
StaffUUID String The UUID of the Staff member
Status String disable/enable
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

ManageTaskStaff

Manage the staff members of a task

Input
Name Type Description
JobID String ID of Job related to the task.
TaskUUID String UUID of Task to add/remove staff members
Add String UUID of Staff to add to Task
Remove String UUID of Staff to remove from Task
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with various Basecamp services.

Input
Name Type Description
OAuthRefreshToken String The refresh token returned with the previous access token.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Basecamp. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

UploadClientDocument

Upload a document to a Client

Input
Name Type Description
ClientUUID String The ID of the client where the document will be uploaded.
Title String Title of the document
Text String The note relating to the document
Folder String The folder where the document is going to be uploaded
FileName String Filename of the file
LocalFile String Full file path to the file which is going to be uploaded
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

UploadJobDocument

Upload a document to a Job

Input
Name Type Description
JobID String The ID of the job where the document will be uploaded.
Title String Title of the document
Text String The note relating to the document
Folder String The folder where the document is going to be uploaded
Public String Determines if document is open to the public
FileName String Filename of the file
LocalFile String Full file path to the file which is going to be uploaded
Result Set Columns
Name Type Description
Success String This value shows a boolean indication of whether the operation was successful or not.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Xero WorkflowMax:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Clients table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Clients'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateJobEstimate stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateJobEstimate' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Clients table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Clients'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:xeroworkflowmax:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
TenantId Xero Workflow Max Tenant ID.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Other

Property Description
IncludeCustomFields Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.

Miscellaneous

Property Description
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
TenantId Xero Workflow Max Tenant ID.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

TenantId

Xero Workflow Max Tenant ID.

Data Type

string

Default Value

""

Remarks

If for any reason you are trying to use an AccessToken to authenticate you should note that the Xero authentication requires a tenant ID to be passed as a header for each API Request.

Retrieve the TenantId using the GetOAuthAccessToken stored procedure.

Alternatively, you may retrieve the TenantId as follows:

  1. Create a new request in an API Development tool like Postman.
  2. Set the URL to https://api.xero.com/connections
  3. Set Authorization header to "Bearer " + access_token and finally execute the request.
  4. The response will show 1 or more connection informations to Xero.
  5. Find the connection which has "tenantType": "WORKFLOWMAX" and get its TenantId.
  6. Set this connection property to the newly acquired TenantId.

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\XeroWorkflowMax Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\XeroWorkflowMax Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Other

This section provides a complete list of the Other properties you can configure.

Property Description
IncludeCustomFields Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.

IncludeCustomFields

Determines if Custom Fields should be included as table columns or not. Including CustomFields will impact the performance.

Data Type

string

Default Value

false

Remarks

It is possible to create custom fields in Xero WorkflowMax. To retrieve their values you can set IncludeCustomFields=true as a connection property. Doing so will list the custom fields created as table columns. These custom fields can also be updated for ex.

UPDATE Costs SET CF_1='new CF value' WHERE ID='CostID'

Note: You can still update custom fields even when a specific table doesn't support UPDATE operation.

Custom Fields are very expensive. They require one request per record to retrieve. For this reason, they are disabled by default.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.