Tableau Connector for Xero WorkflowMax

Build 21.0.8137

Clients

Return a list of all clients.

Select

The connector will use the your data source 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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137