Advertising sustains the DA. Ads are hidden for members. Join today

Contributed module documentation

Xero Sync

This guide expains how to use the Xero Sync module to set up the automated synchronisation of Drupal entities and Xero accounting items.

Xero is a cloud accounting SAAS. It's API allows developers to create and update accounting items like invoices, payments, contacts, etc. A Drupal API for accessing the Xero API is provided by Drupal's Xero API module.

This module Xero Sync uses Xero API to help developers keep specific Drupal entities synchronised with their counterparts on Xero. This module provides no user interface, and almost all use cases will require some custom code.

Xero Sync User Contact

A ready-to-use submodule that syncs Drupal users with Xero contacts.

Setting up syncing for an entity type

An overview of the events subscribers, plugins and hooks you'll use to setup the syncing of entities with Xero.

Finding Xero items that correspond to Drupal entities

How to use Xero Sync's item finder plugins to identify what Xero item corresponds with a given Drupal entity.

Setting the properties of a Xero item based on a Drupal entity

How to specify what values to set in which properties of a Xero item, based on its corresponding Drupal entity.

Setting the fields of a Drupal entity based on a Xero item

How to update a Drupal entity's fields based on its corresponding Xero item.

Limiting syncing to particular entities

Sometimes you don't want to sync every instance of an entity type

Referencing the Xero item that corresponds to a Drupal entity

Using a Xero Sync field to store a reference on a Drupal entity that identifies the synced Xero item.

Understanding the Xero Sync queues

What the queues are, and how to work with them

Advanced usage of Xero Sync's services

If you want to do something unusual, you may need to use directly the services Xero Sync provides

Tags

Guide maintainers

jonathanshaw's picture