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 . |
With Xero modules in Boost.space Integrator, you can watch, create, update, retrieve, 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.
To use the Xero modules, you must have a Xero account. If you do not have an account, you can create one at xero.com/signup/.
Refer to the Xero API documentation for the list of available endpoints.
To establish the connection:
-
Log in to your Boost.space Integrator account, add a Xero module to your scenario, and click Create a connection.
Note: If you add a module with an
instant
tag, click Create a webhook, then Create a connection. -
Optional: In the Connection name field, enter a name for the connection.
-
Optional: Click Show advanced settings and choose the Scopes for the connection. Each module’s scopes can be found in the Build Xero Scenarios section below listed as Required Permissions. For more information regarding scopes, refer to the Xero API documentation.
-
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more Xero modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
Note | |
---|---|
If you receive an error regarding permissions when creating the connection, you must manually add Scopes for the module. Refer to the Build Xero Scenarios section below for each module’s required permissions. If you add a new Xero module to a scenario and use an existing connection, you may be prompted to update the connection permissions. Click Continue > Allow access to extend the permissions. |
Note | |
---|---|
Starting September 1, 2024, Xero is enforcing volume threshold limits to all GET endpoints/modules. All organizations using the Search Contacts, Search Invoices, Search Manual Journals, and Search Payments modules with high volumes of data may notice slower performance, or the scenarios may stop working entirely. For detailed information on each endpoint, please review the Xero developer documentation on efficient data retrieval for large organizations. |
After connecting the app, you can perform the following:
Events
-
Watch Events
Required Permissions: offline_access, accounting.settings
Note: This module uses webhooks to trigger a scenario when an event occurs instantly. The webhook is attached automatically and requires no additional set up.
Invoices
-
Watch Invoices
Required Permissions: accounting.transactions, accounting.settings
-
Create an Invoice
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Update an Invoice
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Get a Sales Invoice PDF
Required Permissions: accounting.transactions, accounting.settings
-
Get an Invoice
Required Permissions: accounting.transactions, accounting.settings
-
Get an Invoice URL
Required Permissions: accounting.transactions, accounting.settings
-
Search for Invoices
Required Permissions: accounting.transactions, accounting.settings
-
Send an Invoice via Email
Required Permissions: accounting.transactions, accounting.settings
-
Download an Invoice
Required Permissions: accounting.transactions, accounting.settings
Bank Transactions
-
Watch Bank Transactions
Required Permissions: accounting.transactions, accounting.settings
-
Create a Bank Transaction
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Get a Bank Transaction
Required Permissions: accounting.transactions, accounting.settings
Bank Transfers
-
Watch Bank Transfers
Required Permissions: accounting.transactions, accounting.settings
-
Create a Bank Transfer
Required Permissions: accounting.transactions, accounting.settings
Contacts
-
Watch Contacts
Required Permissions: accounting.contacts, accounting.settings
-
Create a Contact
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Update a Contact
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Get a Contact
Required Permissions: accounting.contacts, accounting.settings
-
Search for Contacts
Required Permissions: accounting.contacts, accounting.settings
-
Archive a Contact
Required Permissions: accounting.contacts, accounting.settings
Credit Notes
-
Watch Credit Notes
Required Permissions: accounting.transactions, accounting.settings
-
Create a Credit Note
Required Permissions: accounting.transactions, accounting.settings
-
Get a Credit Note
Required Permissions: accounting.transactions, accounting.settings
Manual Journals
-
Watch Manual Journals
Required Permissions: accounting.transactions
-
Create a Manual Journal
Required Permissions: accounting.transactions, accounting.settings
-
Get a Manual Journal
Required Permissions: accounting.transactions, accounting.settings
-
Search for Manual Journals
Required Permissions: accounting.transactions, accounting.settings
Quotes
-
Watch Quotes
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Create a Quote
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
Items
-
Watch Items
Required Permissions: accounting.settings
-
Create an Item
Required Permissions: accounting.settings
-
Update an Item
Required Permissions: accounting.settings
-
Get an Item
Required Permissions: accounting.settings
-
Search for Items
Required Permissions: accounting.settings
Payments
-
Watch Payments
Required Permissions: accounting.transactions, accounting.settings
-
Create a Batch Payment
Required Permissions: accounting.transactions, accounting.settings
-
Create a Payment
Required Permissions: accounting.transactions, accounting.settings
-
Get a Payment
Required Permissions: accounting.transactions, accounting.settings
-
Search Payments
Required Permissions: accounting.transactions, accounting.settings
Purchase Orders
-
Watch Purchase Orders
Required Permissions: accounting.transactions, accounting.settings
-
Create a Purchase Order
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Update a Purchase Order
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Get a Purchase Order
Required Permissions: accounting.transactions, accounting.settings
-
Delete a Purchase Order
Contact Groups
-
Create a Contact Group
Required Permissions: accounting.contacts, accounting.settings
-
Add a Contact to a Contact Group
Required Permissions: accounting.contacts, accounting.settings
-
Get a Contact Group
Required Permissions: accounting.contacts, accounting.settings
-
Search for Contact Groups
Required Permissions: accounting.settings, accounting.contacts
-
Delete a Contact Group
Required Permissions: accounting.contacts, accounting.settings
-
Remove a Contact from a Contact Group
Required Permissions: accounting.contacts, accounting.settings
Employees
-
Watch Employee Leaves
Required Permissions: payroll.employees.read, payroll.settings.read
-
Create an Employee
Required Permissions: accounting.settings
-
Update an Employee
Required Permissions: accounting.settings
Reports
-
Get a Bank Summary
Required Permissions: accounting.reports.read, accounting.settings
-
Get a Bank Statements Report
Required Permissions: accounting.reports.read, accounting.settings
Accounts
-
Create an Account
Required Permissions: accounting.settings
Note: Creating credit card or Paypall accounts is not currently supported by the Xero API. For more information, refer to the Xero API documentation.
-
Update an Account
Required Permissions: accounting.settings
Note: Updating accounts with type
bank
is not currently supported by the Xero API. For more information, refer to the Xero API documentation. -
Get an Account
Required Permissions: accounting.settings
-
Search for Accounts
Required Permissions: accounting.settings
Tax Rates
-
Search for Tax Rates
Required Permissions: accounting.settings
History of Changes
-
Create a History Note
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
-
Get History of Changes
Required Permissions: accounting.transactions, accounting.contacts, accounting.settings
Attachments
-
List Attachments
Required Permissions: accounting.attachments, accounting.settings, accounting.settings.read
-
Download an Attachment
Required Permissions: accounting.attachments
Files
-
Create a Folder
Required Permissions: files, files.read
-
Upload a File (Files API)
Required Permissions: accounting.attachments, accounting.settings
-
Update a Folder
Required Permissions: files, files.read
-
Update a File
Required Permissions: files, files.read
-
Get a Folder
Required Permissions: files.read
-
Get a File
Required Permissions: files, files.read
-
List Folders
Required Permissions: files.read
-
List Files
Required Permissions: files, files.read
-
Delete a Folder
Required Permissions: files, files.read
-
Delete a File
Required Permissions: files, files.read
-
Upload a File
Required Permissions: accounting.attachments, accounting.settings
Asset Types
-
Create an Asset Type
Required Permissions: assets
-
Update an Asset Type
Required Permissions: assets, assets.read
-
Get an Asset Type
Required Permissions: assets.read
-
Search Assets
Required Permissions: assets.read
Assets
-
Create an Asset
Required Permissions: assets, assets.read
-
Updated an Asset
Required Permissions: assets, assets.read
-
Get an Asset
Required Permissions: assets.read
-
Search Assets
Required Permissions: assets.read
Timesheets
-
Create a Timesheet
Required Permissions: payroll.timesheets
-
Get a Timesheet
Required Permissions: payroll.timesheets.read
-
Search Timesheets
Required Permissions: payroll.timesheets.read
-
Delete a Timesheet
Required Permissions: payroll.timesheets
Tracking Categories
-
Create a Tracking Category
Required Permissions: payroll.settings
-
Update a Tracking Category
Required Permissions: payroll.settings
-
Get a Tracking Category
Required Permissions: payroll.settings.read
-
Search Tracking Categories
Required Permissions: payroll.settings.read
-
Delete a Tracking Category
Required Permissions: payroll.settings.read
Tenants
-
List Tenants
Settings
-
Get a Setting Object
Required Permissions: assets.read
Other
-
Make an API Call