Xero - Private Instance connector icon

Xero - Private Instance Integrations

Online accounting and payroll service. For Private Xero Apps.

01

Low-code orchestration

Connect, compose and ship AI features faster.

02

Multi-tenant deployment

Isolate customer credentials and configurations at scale.

03

Governed access

Apply policies, field controls and audit trails across usage.

04

Embedded experience

Deliver workflows natively inside your product.

CONNECTOR OVERVIEW

Create automations with our Xero - Private Instance connector

Cyclr enables SaaS platforms to integrate their application with hundreds of other platforms. Use Cyclr’s low code integration builder to integrate your application with Xero – Private Instance, so you can provide in-app Xero – Private Instance integrations for your end users.

PRODUCT USE CASES

Top Use Cases for Xero - Private Instance Integrations

Quickly create integrations between your SaaS application and Xero - Private Instance with Cyclr's low code integration builder. Publish your Xero - Private Instance integration into your application using Cyclr's white label embedded integration marketplace.

HR/Payroll

  • Sync employee details from HR to payroll
  • Create a new employee in payroll when a new employee has joined

ORCHESTRATION

How Xero - Private Instance works with Cyclr

Cyclr sits between your SaaS product and Xero - Private Instance to handle authentication, govern access and orchestrate every API call per customer, at scale.

  1. 1

    Your SaaS product

    Your app requests an action for a specific customer.

  2. 2

    Cyclr orchestration

    Cyclr authenticates, applies policies and routes the request.

  3. 3

    Xero - Private Instance

    Xero - Private Instance processes the request and returns a response to your app.

Customer-specific authentication · Governed data movement · Centralized visibility and audit

CONNECTOR COVERAGE

Available connector capabilities

Explore Xero - Private Instance methods you can orchestrate through Cyclr.

Journals7

Create Manual Journal

Action

Use this method to create a manual journal.

Get Manual Journal

Action

Gets details of the specified Manual Journal.

Get Journal

Action

Gets details of the specified Journal.

List Manual Journals

Action

Returns a list of Manual Journals.

List Updated Manual Journals

Action

Returns a list of new and updated Manual Journals since last run time.

List Journals

Action

Returns a list of Journals. A maximum of 100 journals will be returned.

List Updated Journals

Action

Returns a list of new and updated Journals since last run time. A maximum of 100 journals will be returned.

Payments6

Get Payment

Action

Retrieve the details of a specified payment.

List Updated Payments

Action

Retrieve the full chart of new and updated payments since last run time.

Apply Payment To Invoice

Action

Apply a payment to an approved AR or AP invoice.

Get Payment History

Action

View a summary of the actions made by all users to a specified payment.

List Payments

Action

Retrieve the full chart of payments.

Reverse Payment

Action

Reverse payments to invoices, credit notes, prepayments & overpayments. Note that payments created via batch payments and receipts are not supported.

Organisations2

Get Tenants

Action

Gets the names of the tenants (organisations) that are accessible by this Connector.

Get Organisation

Action

Gets details of the Organisation.

Items2

List Updated Items

Action

Retrieves a list of new and updated items since last run time.

List Items

Action

Retrieves a list of items.

Accounts8

Get Accounts by Code

Action

Retrieve an account with the given code.

Add Account

Action

Adds a new Account

Update Account

Action

Updates an Account

List Accounts

Action

Retrieve the full chart of accounts.

Get Account

Action

Gets details of the specified Account.

List Updated Accounts

Action

Retrieve the full chart of new and updated accounts since last run time.

Get Accounts by Type

Action

Retrieve the full chart of accounts.

Delete Account

Action

Deletes the specified Account.

Repeating Invoices3

List Repeating Invoice History

Action

Retrieves a history of repeating invoice.

Get Repeating Invoice

Action

Retrieves a repeating invoice.

List Repeating Invoices

Action

Retrieves a list of repeating invoices.

Bank Transactions3

Get Bank Transaction

Action

Get the details of the specified Bank Transaction.

List Updated Bank Transactions

Action

List new and updated bank transactions since last run time.

List Bank Transactions

Action

List bank transactions.

Contacts5

Update Contact

Action

Allows you to update an existing contact.

List Contacts

Action

Allows you to retrieve a list of contacts.

Create Contact

Action

Allows you to create a new contact.

List Updated Contacts

Action

Allows you to retrieve a list of new and updated contacts since last run time.

Get Contact

Action

Allows you to retrieve a details of the specified Contact.

Reports1

Get Balance Sheet

Action

Returns a balance sheet for the end of the month of the specified date. YTD values are shown too.

Purchase Orders6

Update Purchase Order

Action

Update an existing purchase order.

List Updated Purchase Orders

Action

Retrieves a list of all new and updated purchase orders since last run time.

Create Purchase Order

Action

Create a new purchase order.

List Purchase Orders

Action

Retrieves a list of all purchase orders.

Get Purchase Order

Action

Retrieves the details of a specific purchase order.

Delete Purchase Order

Action

Mark an existing purchase order as deleted.

Tax Rates5

Update Tax Rate

Action

Update a Tax Rate.

Get Tax Rate

Action

Returns details of the specified Tax Rate.

List Tax Rates by Type

Action

Returns details of the specified Tax Rate.

List Tax Rates

Action

Returns a list of Tax Rates.

Create Tax Rate

Action

Creates a Tax Rate.

Attachments1

Upload Attachment

Action

Upload attachment to document.

Invoices10

List AP Invoices

Action

Retrieves a list of AP invoices.

Create Invoice

Action

Allows you to create an invoice.

Update Invoice

Action

Allows you to update an invoice.

List Invoices

Action

Retrieves a list of invoices.

Get Invoice

Action

Get details of the specified Invoice.

List Updated Invoices

Action

Retrieves a list of new and updated invoices since last run time.

List Updated AP Invoices

Action

Retrieves a list of new and updated AP invoices since last run time.

List AR Invoices

Action

Retrieves a list of AR invoices.

List Updated AR Invoices

Action

Retrieves a list of new and updated AR invoices since last run time.

List AP Invoices

Action

Retrieves a list of AP invoices.

TECHNICAL DETAILS

Xero - Private Instance integration and API details

Review the sourced authentication and API behaviour used when configuring customer-facing Xero - Private Instance integrations in Cyclr.

API and authentication

API host
Not specified
Authentication
See Connector in Console
Credentials

Review the connector installation fields in Cyclr Console.

Method categories

See available methods

Pagination and rate limits

Pagination

Method-specific behavior should be confirmed before implementation.

Rate limits

Refer to the vendor API documentation for current limits.

IMPLEMENTATION

Authentication at a glance

Authentication requirements and any available connection options are shown when installing this connector in Cyclr Console.

Authentication method
See Connector in Console
Credential required

Review the connector installation fields in Cyclr Console.