The Xero Middleware integration is a free feature available to all Access PaySuite DDCMS customers. Before setting up, review the requirements below to confirm the integration is suitable for your account.
For a full overview of the integration, see the Xero User Guide.
Before you begin
Xero user permissions — The Xero user who connects the integration must have Standard or Adviser level user permissions in Xero. Users with Sales Invoice only access cannot access the Middleware. This is a requirement set by Xero, as the connecting user must be authorised to use the API.
API credentials — You will need a Client Code (also referred to as an API Key), an API Secret, and Service User Number (SUN) information to complete the Middleware configuration. These are unique to your account and will be provided to you securely. You do not need to source these yourself.
System limits
Maximum 10,000 contacts in Xero. Exceeding this may cause errors with the Middleware.
Maximum 1,000 invoices per month. If you raise more than this, the Middleware integration will not be suitable for your account.
Contract type limitation
The Xero Middleware only supports ad hoc Direct Debit contracts.
Please note the following before proceeding with setup:
Each collection requires a corresponding invoice raised in Xero, which determines the payment amount and collection date.
Monthly, annual, and rolling Direct Debits cannot be set up through the Middleware. If your customers pay a fixed amount on a set date, the Xero Middleware is not suitable for your needs.
Any additional payments not tied to a Xero invoice must be added manually in Access PaySuite DDCMS.
Where a customer has multiple invoices, each invoice will trigger a separate Direct Debit collection.
Get started
This integration is not self-service. Setup and configuration is handled on your behalf, and you will be provided with the API credentials needed once complete.
📌Note: To request setup of the Xero Middleware integration, please contact us via the Access Digital Assistant and request to speak with a member of the support team.
Next steps
Once your credentials have been provided, you are ready to complete the setup.
See the following articles:
