| Active |
|---|
| This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions below. |
The Xero modules allow you to watch, create, update, list, and/or delete accounts, bank transfers, bank transactions, change history, contacts, contact groups, credit notes, employees, files, invoices, items, journal manuals, notes, payments, purchase orders, and tax rates in your Xero account.
Prerequisites
-
A Xero account
In order to use Xero with Boost.space Integrator, it is necessary to have a Xero account. If you do not have one, you can create a Xero account at https://www.xero.com/signup/.
![[Caution]](https://docs.boost.space/wp-content/uploads/2022/11/caution.png) |
Caution |
|---|---|
|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
1. Go to Boost.space Integrator and open the Xero module’s Create a connection dialog.
2. In the Connection name field, enter a name for the connection.
3. In the Company name field, enter the company name if you have more than one company.
4. Click Continue.
5. Confirm the dialogue box by clicking the Allow Access button.
4. Confirm the dialogue box by clicking the Connect button.
The connection has been established.
Triggers when an invoice is added or updated.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Searches for an invoice.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Select the option to search the invoices:
|
|
|
The maximum number of invoices Boost.space Integrator should return during one scenario execution cycle. |
Returns information about an invoice with a given ID.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Invoice ID whose details you want to retrieve. |
Creates a new invoice.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Select the type of invoice you want to create:
|
|
|
Enter or Search the Contact ID to whom you want to attach the invoice. |
|
|
Add the line items:
Enter the details of the item.
Enter the number of items.
Enter the number of items.
Select the item.
Select the category to which the item belongs.
Select the tax code applicable for the item:
Enter the amount of tax for the item.
Enter the item amount after the discount.
Enter the discount rate of the item.
Enter the discount amount for the item.
Add the tracking name of the item. |
|
|
Enter the date the invoice is issued. |
|
|
Enter the date the invoice is due. |
|
|
Enter the amount excluding taxes. |
|
|
Enter the invoice number. |
|
|
Enter the reference number. This is applicable only for sale invoices. |
|
|
Select the branding theme for the invoice. |
|
|
Enter the URL to the source document of the invoice. |
|
|
Select the currency code applicable to the invoice. |
|
|
Enter the currency conversion rate. |
|
|
Select the status of the invoice:
|
|
|
Select the Yes if the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved. |
|
|
Enter the date when the payment for the invoice is expected. This is available only on sales invoices. |
|
|
Enter the date when the payment for the invoice is planned. This is available only on bills. |
Updates an invoice by ID.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Invoice ID you want to update. |
|
|
Select the type of invoice you want to create:
|
|
|
Enter or Search the Contact ID to whom you want to attach the invoice. |
|
|
Add the line items:
Enter the details of the item.
Enter the number of items.
Enter the number of items.
Select the item.
Select the category to which the item belongs.
Select the tax code applicable for the item:
Enter the amount of tax for the item.
Enter the item amount after the discount.
Enter the discount rate of the item.
Enter the discount amount for the item.
Add the tracking name of the item. |
|
|
Enter the date the invoice is issued. |
|
|
Enter the date the invoice is due. |
|
|
Enter the amount excluding taxes. |
|
|
Enter the invoice number. |
|
|
Enter the reference number. This is applicable only for sale invoices. |
|
|
Select the branding theme for the invoice. |
|
|
Enter the URL to the source document of the invoice. |
|
|
Select the currency code applicable to the invoice. |
|
|
Enter the currency conversion rate. |
|
|
Select the status of the invoice:
|
|
|
Select Yesif you want to send this invoice to a contact:
|
|
|
Enter the date when the payment for the invoice is expected. This is available only on sales invoices. |
|
|
Enter the date when the payment for the invoice is planned. This is available only on bills. |
Retrieves a Xero online invoice URL.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Invoice ID whose URL you want to retrieve. |
The email will be sent to the primary email address of the contact on the invoice. The invoice must be of Type ACCREC and a valid Status for sending (SUBMITTED, AUTHORISED, or PAID).
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Invoice ID whose details you want to send via email. |
Triggers when bank transactions are added or updated.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Returns information about a transaction with a specified ID.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Bank Transaction ID whose details you want to retrieve. |
Creates a new bank transaction.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Select the type of bank transaction you want to create:
|
|
|
Enter the Contact ID who is performing the bank transaction. |
|
|
Add the line items:
Enter the details of the item.
Enter the number of items.
Enter the number of items.
Select the item.
Select the category to which the item belongs.
Select the tax code applicable for the item:
Enter the amount of tax for the item.
Enter the item amount after the discount.
Enter the discount rate of the item.
Enter the discount amount for the item.
Add the tracking name of the item. |
|
|
Select the bank account whose transaction you are performing. |
|
Is Reconciled |
Select if this transaction is reconciled. |
|
|
Enter the date of the transaction. |
|
|
Enter the transaction reference number. |
|
|
Select the currency code in which you are performing the transaction. |
|
|
Enter the applicable currency conversion rate. |
|
|
Enter the URL to the source document. |
|
|
Select the line amount type:
|
Triggers when a new bank transfer is created.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Transfers a specified amount from one account to another.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Select the bank account from which you want to transfer. |
|
|
Select the bank account to which you want to transfer. |
|
|
Enter the amount you want to transfer. |
|
|
Enter the date of the transfer. |
Triggers when a contact is created or updated.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Searches for a contact by name or email.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Select the option to search the contacts:
|
|
|
The maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Retrieves contact information by ID.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the contact ID whose details you want to retrieve. |
Creates a new contact.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Enter the name of the contact you want to create. |
|
|
Enter the phone number of the contact. |
|
|
Enter the account number of the contact. |
|
|
Enter the first name. |
|
|
Enter the last name. |
|
|
Enter the email address of the contact. |
|
|
Enter the Skype ID of the contact. |
|
|
Add the contact persons:
Enter the first name of the contact person.
Enter the last name of the contact person.
Enter the email address of the contact person.
Select Yes if you want to include the contact person in your emails:
|
|
|
Enter the bank account details of the contact. |
|
|
Enter the tax number. |
|
|
Select the accounts receivable tax type for the contact:
|
|
|
Select the accounts payable tax type for the contact:
|
|
|
Add the address of the contact:
Select the type of address:
Enter the street address.
Enter the street address.
Enter the street address.
Enter the street address.
Enter the city name.
Enter the area name.
Enter the postal code of the area.
Enter the country name.
Enter the name to whom you are addressing. |
|
|
Add the phone numbers of the contact:
Select the type of phone number.
Enter the phone number.
Enter the area code.
Enter the country code. |
|
|
Select the applicable currency for the contact. |
|
|
Enter the Xero Network Key to store the contact. |
|
|
Select the sales category of the contact. |
|
|
Select the purchasing category of the contact. |
|
|
Select the payment terms applicable for the contact:
|
Updates a contact by ID.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact ID you want to update. |
|
|
Enter the name of the contact. |
|
|
Enter the phone number of the contact. |
|
|
Enter the account number of the contact. |
|
|
Enter the first name of the contact. |
|
|
Enter the last name of the contact. |
|
|
Enter the email address of the contact. |
|
|
Enter the Skype ID of the contact. |
|
|
Add the contact persons:
Enter the first name of the contact person.
Enter the last name of the contact person.
Enter the email address of the contact person.
Select Yes if you want to include the contact person in your emails:
|
|
|
Enter the bank account details of the contact. |
|
|
Enter the tax number of the contact. |
|
|
Select the accounts receivable tax type for the contact:
|
|
|
Select the accounts payable tax type for the contact:
|
|
|
Add the address of the contact:
Select the type of address:
Enter the street address.
Enter the street address.
Enter the street address.
Enter the street address.
Enter the city name.
Enter the area name.
Enter the postal code of the area.
Enter the country name.
Enter the name to whom you are addressing. |
|
|
Add the phone numbers of the contact:
Select the type of phone number.
Enter the phone number.
Enter the area code
Enter the country code. |
|
|
Select the applicable currency for the contact. |
|
|
Enter the Xero Network Key to store the contact. |
|
|
Select the sales category of the contact. |
|
|
Select the purchasing category of the contact. |
|
|
Select the payment terms applicable for the contact:
|
Archive a contact with a given ID.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact ID you want to archive. |
Triggers when a credit note is added or updated.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Returns information about a credit note with a specified ID.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Credit Note ID whose details you want to retrieve. |
Creates a new credit note.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Select the type of credit note you are creating:
|
|
|
Enter the Contact ID whose credit notes you are creating. |
|
|
Add the line items:
Enter the details of the item.
Enter the number of items.
Enter the number of items.
Select the item.
Select the category to which the item belongs.
Select the tax code applicable for the item:
Enter the amount of tax for the item.
Enter the item amount after the discount.
Enter the discount rate of the item.
Enter the discount amount for the item.
Add the tracking name of the item. |
|
|
Select the status of the credit note:
|
|
|
Select the line amount type of the credit note:
|
|
|
Enter the date when the credit note is issued. |
|
|
Enter the currency conversion rate. |
|
|
Select the currency code applicable for the credit note. |
|
|
Enter the credit note number. |
|
|
Enter the reference number of the credit note. |
|
|
Select the branding theme for the credit note. |
Triggers when a manual journal is created or updated.
Required Permissions: accounting.transactions
|
|
|
|
|
Enter the location where you want to watch the invoices. For example, |
Searches for a manual journal.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Select the option to search the manual journals:
|
|
|
The maximum number of manual journals Boost.space Integrator should return during one scenario execution cycle. |
Returns information about a manual journal.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Manual Journal ID whose details you want to retrieve. |
Creates a manual journal.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the description of the journal. |
|
|
Add the journal lines:
Enter the amount after the discount.
Select the category applicable to the journal.
Enter the details of the journal.
Select the tax type for the journal:
Add the tracking name for the journal. |
|
|
Enter the journal posting date. |
|
|
Select the line amount type:
|
|
|
Select the status of the journal:
|
|
|
Enter the URL link of the source document. |
|
|
Select Yesif you want to show the journal based on cash basis report:
|
Creates a new item.
Required Permissions: accounting.settings
|
|
|
|
|
Enter the item code. |
|
|
Enter the account for which you are creating the item. |
|
|
Enter the name of the item. |
|
|
Select if the item is available for sales transactions. |
|
|
Select if the item is available for purchase transactions. |
|
|
Enter sales details of the item. |
|
|
Enter the purchase details of the item. |
|
|
Enter the single unit purchasing price of the item. By default, the price rounded off for two decimals. |
|
|
Select the goods sold account. |
|
|
Select the applicable tax for the item. |
|
|
Enter the sale unit price of the item. |
|
|
Select the account category of the item. |
|
|
Select the applicable tax for the item. |
Updates an item by ID.
Required Permissions: accounting.settings accounting.settings
|
|
|
|
|
Enter the Item ID you want to update. |
|
|
Enter the item code. |
|
|
Enter the account for which you are creating the item. |
|
|
Enter the name of the item. |
|
|
Select if the item is available for sales transactions. |
|
|
Select if the item is available for purchase transactions. |
|
|
Enter sales details of the item. |
|
|
Enter the purchase details of the item. |
|
|
Enter the single unit purchasing price of the item. By default, the price is rounded off to two decimals. |
|
|
Select the goods sold account. |
|
|
Select the applicable tax for the item. |
|
|
Enter the sale unit price of the item. |
|
|
Select the account category of the item. |
|
|
Select the applicable tax for the item. |
Searches for an item by item ID or item code.
Required Permissions: accounting.settings
|
|
|
|
|
Enter the Item ID whose details you want to retrieve. |
Triggers when a payment is created or updated.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the payments. For example, |
Retrieves information about a payment with a specified ID.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Payment ID whose details you want to retrieve. |
Creates a new purchase order.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Select the option for which you want to create the payment:
|
|
|
Select the account to be used for payment. |
|
|
Enter the payment amount. |
|
|
Enter the date when the payment is being made. |
|
|
Enter the details of the payment. |
|
|
Select Yes if the payment is reconciled:
|
Triggers when an order is added or updated.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the location where you want to watch the purchase orders. For example, |
Returns information about a purchase order with a specified ID.
Required Permissions: accounting.transactions, accounting.settings
|
|
|
|
|
Enter the Purchase Order ID whose details you want to retrieve. |
Creates a new purchase order.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact ID whose purchase order you are creating. |
|
|
Add the line items:
Enter the details of the item.
Enter the number of items.
Enter the number of items.
Select the item.
Select the category to which the item belongs to.
Select the tax code applicable for the item:
Enter the amount of tax for the item.
Enter the item amount after the discount.
Enter the discount rate of the item.
Enter the discount amount for the item.
Add the tracking name of the item. |
|
|
Enter the purchase order issuing date. |
|
|
Enter the goods delivering date. |
|
|
Select the line amount type:
|
|
|
Enter the purchasing order number. |
|
|
Enter the additional reference number. |
|
|
Select the branding theme for the purchasing order. |
|
|
Select the currency code applicable for the purchasing order. |
|
|
Select the status of the purchase order:
|
|
|
Select Yes if you send the purchase order to a contact:
|
|
|
Enter the address where the goods should be delivered. |
|
|
Enter the person to whom you are delivering the goods. |
|
|
Enter the phone number. |
|
|
Enter the delivery instructions, if any. |
|
|
Enter the date when the goods are expected to arrive at the address. |
Returns information about a contact group.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact Group ID whose details you want to retrieve. |
Creates a contact group.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact Group ID you want to create. |
Deletes all contacts from a contact group.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Enter the Contact Group ID you want to delete. |
Adds a contact to a specified contact group.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Select the contact group to which you want to add a contact. |
|
|
Enter the Contact ID to add to the contact group. |
Removes a contact from a contact group.
Required Permissions: accounting.contacts, accounting.settings
|
|
|
|
|
Select the contact group to which you want to remove a contact. |
|
|
Enter the Contact ID that you want to remove from the contact group. |
Creates a new employee.
Required Permissions: accounting.settings
|
|
|
|
|
Enter the first name of the employee. |
|
|
Enter the last name of the employee. |
|
|
Enter any external link available about the employee. For example, a link to the employee record. |
Updates an employee by ID.
Required Permissions: accounting.settings
|
|
|
|
|
Enter the Employee ID whose details you want to update. |
|
|
Enter the first name of the employee. |
|
|
Enter the last name of the employee. |
|
|
Enter any external link available about the employee. For example, a link to the employee record. |
Returns the balance and cash movements for each bank account.
Required Permissions: accounting.reports.read, accounting.settings
|
|
|
|
|
Enter the start date from which you want to get the bank summary. |
|
|
Enter the last date until which you want to get the bank summary. |
Returns bank statements for a selected bank account.
Required Permissions: accounting.reports.read, accounting.settings
|
|
|
|
|
Select the bank account whose statement summary report you want to retrieve. |
|
|
Enter the start date from which you want to get the bank statement. |
|
|
Enter the last date from which you want to get the bank statement. |
Finds an account by ID, name, or code.
Required Permissions: accounting.settings
|
|
|
|
|
Select the option to search the tax rates:
|
|
|
The maximum number of accounts Boost.space Integrator should return during one scenario execution cycle. |
Returns information about an account with a specified ID.
Required Permissions: accounting.settings
|
|
|
|
|
Enter the Account ID whose details you want to retrieve. |
Uploads a file to a selected object.
Required Permissions: accounting.attachments, accounting.settings
|
|
|
|
|
Select the option to send the file:
|
|
|
Enter the Invoice ID to which you want to send file. |
|
|
Enter the Credit Note ID to which you want to send the file. |
|
|
Enter the Bank Transaction ID to which you want to send the file. |
|
|
Enter the Bank Transfer ID to which you want to send the file. |
|
|
Enter the Contact ID to which you want to send the file. |
|
|
Enter the Manual Journal ID to which you want to send the file. |
|
|
Enter the Purchase Order ID to which you want to send the file. |
|
|
Enter the file name you are uploading. For example, sample.txt. |
|
|
Enter the path of the file to upload. |
Finds a tax rate by name.
Required Permissions: accounting.settings
|
|
|
|
|
Select the option to search the tax rates:
|
|
|
The maximum number of tax rates Boost.space Integrator should return during one scenario execution cycle. |
Retrieves the changes made to a given object.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Select the object whose change history you want to retrieve:
|
|
|
Enter the Object ID whose change history you want to retrieve. |
Adds a note to a record.
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
|
|
|
|
|
Select the object whose note you want to create:
|
|
|
Enter the Object ID. |
|
|
Enter the note text. |
Performs an arbitrary authorized API call.
|
|
|
|
|
Select the organization for which you are making the API call. |
|
|
Select the endpoint URL to connect to your Xero account. |
|
|
Enter a path relative to For the list of available endpoints, refer to the Xero API Documentation. |
|
|
Select the HTTP method you want to use:
|
|
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
|
Enter the request query string. |
|
|
Enter the body content for your API call. |
Following API call returns all invoices:
Matches of the search can be found in the module’s Output under Bundle > Body > Invoices.
In our example, 1 invoice was returned:
Adding Scopes
If you would like to be able to get access to certain documents such as the balance sheet you will need to add the necessary scopes listed here Xero scopes.
To be able to do so you will need to create a new connection and tick on the Show advanced settings:
1. In the Scope section, click the Add item button.
2. Add the scopes that you require to work with.
3. Click the Continue button to connect to your Xero account.
Do you need help with something specific regarding Xero?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch