About the Xero category

[anon99371720]

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation:

Connector package documentation

Table of Contents

1. Setting up HTTP Client Xero
    1.1 Steps
2. Subscribing to entities from Xero
    2.1 Steps
    2.2 General concept
3. Publishing entity to Xero
    3.1 Steps
    3.2 General concept

1. Setting up HTTP Client Xero

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
2. Select Xero HTTP Client as PlatForm and click the next step.
3. Fill in the Base URI with https://api.xero.com/api.xro/2.0.
4. Fill in the Authorize URI with https://login.xero.com/identity/connect/authorize.
5. Fill in the Token URI with https://identity.xero.com/connect/token
6. Create your custom application (For more information, see Xero App Launcher.
7. Fill in the Client ID and Client Secret generated by your custom application.
8. Fill in the Tenant ID (For more information, see Xero Tenants.
9. Fill in the scopes (For more information, see Xero Scopes.
10. You can optionally enable the logging of requests to get the authentication log.
11. Click the “Grant access to Xero” button to get the key.
12. Click the next step, fill in the name of the HTTP Client and finally you can save the HTTP Client to use

2. Subscribing to Entities from Xero

2.1 Steps

1. Go to Connections → Incoming → create a new incoming configuration and select “Xero Accounting Subscriber (v2.0)” as the subscriber.
2. Select the entity you want to subscribe to from Xero.
3. Add any request parameters needed to subscribe to the entity.
4. Select the Xero HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from Xero.
6. You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow Xero documentation on building this connector, so you can easily use the connector based on Xero API Reference.

Entity

The entity you want to subscribe to Xero. Please refer to the entities from the Xero API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Xero API Reference.

Please look at the example below on how to fill the path field when subscribing to the Accounts entity.

Based on the documentation, we can query a single account by setting the “AccountID” inside the path key in the Request Parameters.

Alumio will then make a request to Xero with the URL /Accounts/{AccountID}

HTTP Client

The HTTP Client configuration you will use to access Xero.

3. Publishing Entity to Xero

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration and select “Xero Accounting Publisher (v2.0)” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the Xero entity you want the data to be published.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support the HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to Xero.

Entity

We support publishing to most Xero endpoints.
Please refer to Xero API Reference page.

For example, we want to add a new Account. Please select “Put” as the Method.

Based on the documentation, it requires a payload for example:

Alumio will send an API request to Xero with the URL /Accounts
The response example:

HTTP Client

The HTTP Client configuration you will use to access Xero.