Marketplace help
Icon

Xero

download Download CloverDX Library (clib)

Easily connect live Xero data to CloverDX. This library contains components for getting data from Xero Accounting API. The library supports obtaining data from Xero Accounting API. There are two main groups of functionality - Contextual Connectors allowing to solve specific use cases and Generic Components to get raw Xero data.

Properties
Author
CloverDX
Library version
1.0
Compatible
CloverDX 5.17 and newer
Label
Xero
Tags
reader wrangler xero accounting data-source-connector

Connectors

Get Accounts Payable

Provides supplier invoices

Ports

Port Used for
Output 0 Output invoice data
Output 1 Output invoice payments data
Output 2 Output invoice credit notes data
Output 3 Errors

Get Accounts Payable Near Due Date

Allows you to get supplier invoices with coresponding customer details with due date in the next 7 days. Number of days can be changed as optional input parameter.

Optional input filter conditions

  • Date - Number of days before due date, default value set to 7

Ports

Port Used for
Output 0 Output invoice data
Output 1 Output contact data
Output 2 Output contact address data
Output 3 Output contact phone data

Get Accounts Receivable

Provides customer invoices

Ports

Port Used for
Output 0 Output invoice data
Output 1 Output invoice payments data
Output 2 Output invoice credit notes data
Output 3 Errors

Get Accounts Receivable After Due Date

Allows you to get supplier invoices with coresponding customer details with due date in the last 7 days. Number of days can be changed as optional input parameter.

Optional input filter conditions

  • Date - Number of days after due date, default value set to 7

Ports

Port Used for
Output 0 Output invoice data
Output 1 Output contact data
Output 2 Output contact address data
Output 3 Output contact phone data

GET Accounts

Allows you to retrieve the accounts with optional filter conditions. API full details

Optional input filter conditions

  • Name - Optional filter by account name
  • Status - Optional filter by account status
  • Type - Optional filter by account type

Ports

Port Used for
Output 0 Output account data
Output 1 Output API call data
Output 2 Errors

GET Bank Transactions

Allows you to retrieve any spend or receive money transactions with optional filter condition. API full details

Optional input filter conditions

  • Type - Optional filter by transaction type

Ports

Port Used for
Output 0 Output bank transaction data
Output 1 Output API call data
Output 2 Errors

GET Contacts

Allows you to retrieve the contacts with optional filter conditions. API full details

Optional input filter conditions

  • Name - Optional filter by contact name
  • Email Address - Optional filter by email

Ports

Port Used for
Output 0 Output contact data
Output 1 Output contact address data
Output 2 Output contact phone data
Output 3 Output API call data
Output 4 Errors

GET Credit Notes

Allows you to retrieve the credit notes data. API full details

Ports

Port Used for
Output 0 Output credit note data
Output 1 Output API call data
Output 2 Errors

GET Invoices

Allows you to retrieve the invoices with optional filter conditions. API full details

Optional input filter conditions

  • Name - Optional filter by account name
  • Status - Optional filter by account status
  • Type - Optional filter by account type

Ports

Port Used for
Output 0 Output invoice data
Output 1 Output invoice payments data
Output 2 Output invoice credit notes data
Output 3 Output API call data
Output 4 Errors

GET Journals

Allows you to retrieve the journal data. API full details

Ports

Port Used for
Output 0 Output journal data
Output 1 Output journal line data
Output 2 Output API call data
Output 3 Errors

GET Manual Journals

Allows you to retrieve the manual journals data. API full details

Ports

Port Used for
Output 0 Output manual journal data
Output 1 Output API call data
Output 2 Errors

GET Payments

Allows you to retrieve the payments data. API full details

Optional input filter conditions

  • Payment type - Optional filter by type
  • Status - Optional filter by status
  • Date - Optional filter by date - greater than type of condition (e.g. 2020-01-01 will be evaluated as Date>DateTime(2020, 01, 01))

Ports

Port Used for
Output 0 Output payment data
Output 1 Output API call data
Output 2 Errors

Online installation (Server connected to Internet)

  1. In Server Console, navigate to Libraries > Install library from repository
  2. Select Library Repository dropdown > CloverDX Marketplace
  3. Check the box next to the libraries you want to install (if there are any dependencies, you can install all of them once - see Requirements above)
  4. Click Install

Offline installation (Server without Internet connection)

  1. Download all the libraries you need from the CloverDX Marketplace (including dependencies, see Requirements above). You should get a ".clib" file for each library
  2. Transfer the ".clib" file(s) to your offline Server machine (USB stick, ...)
  3. In Server Console, navigate to Libraries > Install library from repository > Down arrow for more options > Browse local files...
  4. Select the downloaded .clib files on your disk and install

Configuration

Xero Library setup video

Please watch this step by step video on how to install and configure the Xero library in three easy steps:

1) Create account on Xero development console

2) Create connection in CloverDX sandbox

Info for setup OAuth2 connection:

3) Import and setup Library from CloverDX marketplace