App Integrations
App Integrations allow you to integrate your Billingbooth account with another third-party application.
Features of integrating an app
| App | Features |
|---|---|
| Xero | Enables you to automatically push customers and invoices created in Billingbooth directly to your Xero account. |
Adding Xero integration
The first thing you will need to do, is link your Xero account to Billingbooth.
To do this, click on the Settings menu item in the left-hand main navigation and click the App Integrations link under the General menu heading.
This will take you to the App Integrations listings screen, showing you all the apps the currently selected organisation (see top-right to select a different organisation if needed) is integrated with.
Click the Add App Integration button at the top-right of the screen to proceed.
Step 1 - Choose an integration
On this screen, used the App field to select the app you wish to integrate with. For the purposes of this tutorial, select Xero.
Step 2 - Connect to Xero
On this screen, click the Finalise button to be taken to the Xero site where you will then need to login to authorise Billingbooth to access your account for the purposes of integration.
If successful, you'll see a success message appear allowing you to either go back to the App Integrations listing screen or edit the Xero integration you've just connected.
Editing the Xero Integration
General
The Edit Integration screen allows you to configure your integration to your needs. In this case it covers your Xero integration.
| Field | Description |
|---|---|
| Description | Friendly descriptor for the integration, useful if you have multiple integrations of the same app. |
| Custom reference | Adds a custom reference to all invoices pushed to Xero. |
| Upload PDF | If an invoice gets exporteed to Xero, the accompanying binary PDF generated by Billingbooth will also get added as an attachment. |
| Upload attachments | If an invoice with usage statements gets exporteed to Xero, the accompanying binary usage statement generated by Billingbooth will also get added as an attachment. |
| Mode | If you wish the integration to push customer and/or invoice creations automatically when they're created, select Automatic. You can adjust each behaviour with the options below. If you wish to manually choose when to perform this action, select Manual. |
| Push invoices (if Mode is set to Automatic) | If this option is checked, invoices will be pushed to Xero automatically when generated. |
| Push customers (if Mode is set to Automatic) | If this option is checked, customers will be pushed to Xero automatically when added to the account. |
| Approved invoice status | If ticked, invoices will automatically be pushed as approved, otherwise they will be pushed to Xero as a draft which will need further approval within Xero. |
| Customer name uses reference | Customer names use the format Name (Reference) when being created in Xero. |
| Populate account number | Populates the Xero contact account number with customer reference, if available. |
| CLI in line items | If line item charge has an associated CLI and the line item charge has Display CLI in invoices enabled, include the CLI in the Xero line item description. |
| Invoice branding | Allows for custom invoice branding to be applied to invoices pushed to Xero. The branding name must match the branding template name found in Xero. |
TIP
It is also possible to customise invoice branding on a per-customer basis by using metadata keys. Simply head over to a customer's metadata page in the portal and an entry with the key xero_branding and a value that matches the specific branding template name in Xero.
This will override the default branding set in the integration settings.
Activity Log
To access an activity log of all events relating to app integrations you have set up on Billingbooth One, you can click the Activity Log menu item from the sub-navigation at the top of the App Integrations screen.
Types of activity
| Type | Colour | Description |
|---|---|---|
| Information | Black | A general information log, most commonly an invoice being created etc.. |
| Warning | Yellow | A warning log is something to be aware of, as it may have affected invoice generation. |
| Error | Red | An error log denotes something that has gone wrong, often outside Billingbooth One. An error will usually require action to be taken. |