Knowledge Base

 
 

Version 7, 2019

×
Menu

Xero Limitations


There are several limitations placed on the transfer of data from Bp Allied into Xero due to the Xero API. This section discusses the implication of these limitations as well as the differences between the way Bp Allied and Xero handle various situations. 
 
On this page:

Append Client ID to Contact Name

Appending the Client ID to the client name when entering it into the Contact Name field in Xero was done because duplicate contact names are not permitted within Xero. This is the most reliable way of making a Contact Name unique. This needs to be done at the outset otherwise clients could potentially end up with duplicate records in Xero if Client ID was added to Contact Name at a later time.
 
Implication of this change
The default Xero invoice templates use the Contact Name field to address the invoice. Having an the Client ID appended to the client name if sending an invoice directly from Xero may not be suitable. To mitigate this we have done the following:
 
Tip: Archiving a Client (Contact) in Xero is still considered a valid Contact for the Xero API and the Client name will not be able to be exported into Xero.
 

Unique Item Codes

Due to the API requiring that the Item Code field be unique, we require a unique number to be added into the Account Item Code field, as discussed above. However, this is not helpful when viewing items in the Xero interface, hence the Item Code and Description are concatenated and displayed in Item Name.
 

Prepend Client ID to Invoice and Payment Numbers

Xero requires that the Invoice and Payment Numbers are unique. There are two situations in BpAllied that may cause this to not be the case. These are:
 
Due to these possibilities (and potential implications if this is not done at the outset of an export and changed partway through), the Client ID will be prepended to both the Invoice and Payment number from the beginning. The numbers may look similar to those below when they are exported to Xero.
 
Invoice Number:
 
Payment Number:
 

Overpayments

Bp Allied allows for a payment to be allocated to multiple invoices. This is very useful in the situation where a third party has paid a lump sum payment that relates to a number of invoices. This cannot be done with a standard Xero payment. To be able to carry out this within Xero, an overpayment has to be created. Because the allocation of a payment to an invoice in Xero occurs after the payment has been transferred, and any payments in BpAllied could be related to multiple invoices, all payments need to be transferred to Xero as overpayments.
 
What happens when an over payment goes into Xero
When an overpayment is allocated to an invoice the amount allocated is not displayed in the Sales > Invoices > Paid dashboard, however the overpayment is allocated against the invoice when it is viewed within the invoice.
 

Refunds

The refund method such as Cash or Eftpos can not be transferred through to Xero. It is unable to be recorded in Xero at all.
 

API Calls

Xero limit the number of API calls to your Xero database to 5000 per day with a maximum of 1 call per second. This is the number of times Bp Allied can contact the Xero database to transfer information into it. It sounds like a lot, but depending on the size of your practice it can impact on how regularly you send data to Xero.
 
For example: Small Practice
3 practitioners who see an average of 30 clients a week each.
They have a database of 1000 clients and 15 different products and services.
Update Xero on a monthly basis
 
The initial data transfer will use the following number of API calls:
 
# items
# API calls
Client transfer
1000
20
Items
15
1
Invoices x 4½ weeks
400
8
Payments x 4½ weeks
400
8
Allocations
400
400
Total
 
437
 
For example: Medium Practice
10 practitioners who see an average of 30 clients a week each.
They have a database of 2500 clients and 40 different products and services.
Update Xero on a monthly basis
 
The initial data transfer will use the following number of API calls:
 
# items
# API calls
Client transfer
2500
50
Items
40
1
Invoices x 4½ weeks
1350
27
Payments x 4½ weeks
1350
27
Allocations
1350
1350
Total
 
1453
 

Tracking categories

Xero allows a maximum of two tracking categoies. The Bp Allied Xero export requires one tracking category so that the Practitioner information can be transferred with the Invoice. If the following message is received, then one of the used tracking categories will need to be deleted for the export to be used.
 
Xero also limits the number of options under a category to 100, therefore practices with more than 100 practitioners will not be able to use the Xero export.