Suppliers

Return a list of all suppliers.

Select

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

UUID supports the '=' operator.

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

SELECT * FROM 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 = '[email protected]', 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