|
|
| (66 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| − | == Xero Integration == | + | =This Content Has Moved House= |
| | | | |
| − | Emersion is committed to integration to the Xero Billing Platform found at www.xero.com.
| + | This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base. |
| | | | |
| − | Emersion supports:
| + | We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home. |
| − | * invoices being pushed out
| |
| − | * receive payments processed in Xero
| |
| − | * processing credit notes inbound
| |
| | | | |
| − | This basic flow describes the integration further.
| + | [https://resources.emersion.com/display/EKB/Xero Take me to the new articles] |
| | | | |
| − | * A new invoice is generated in Emersion under an account active for Xero. This requires the customer account to be present in both Xero and Emersion. A one to one relationship with one company in Xero and one in Emersion must exist.
| + | [[file:new_home_sm.jpg|900px]] |
| − | * This invoice is then created via the integration in Xero.
| |
| − | * The new invoice in Xero is generated with no cardlines and just a description to hold it in place, it is generated in '''Draft''' status.
| |
| − | * The invoice receives cardlines and charges as usual.
| |
| − | * Once the invoice in Emersion is marked as '''Approved''', all pending cardlines will be sent to the appropriate Xero invoice as line items, and marked as '''Approved''' in Xero.
| |
| − | ** If there are any payments allocated against the invoice in Emersion, they will be transferred to the invoice in Xero.
| |
| − | | |
| − | === Integration Supported ===
| |
| − | | |
| − | * A new invoice is generated in Emersion under an account active for Xero.
| |
| − | * This invoice is then created via the integration in Xero.
| |
| − | * The new invoice in Xero is generated with no cardlines and just a description to hold it in place, it is generated in '''Draft''' status.
| |
| − | * The invoice receives cardlines and charges as usual.
| |
| − | * Once the invoice in Emersion is marked as '''Approved''', all pending cardlines will be sent to the appropriate Xero invoice as line items, and marked as '''Approved''' in Xero.
| |
| − | ** If there are any payments allocated against the invoice in Emersion, they will be transferred to the invoice in Xero.
| |
| − | | |
| − | As any payments after this fact are allocated against the invoice in Emersion, so too will they be transferred to Xero for the same value against the invoice.
| |
| − | | |
| − | If:
| |
| − | * any payments are made in Xero against the invoice; AND
| |
| − | * these payments don’t exist in Emersion; AND
| |
| − | * the payment is against an invoice that we know about in Emersion
| |
| − | then Emersion's system will pull the details into Xero and assign a payment against the invoice in Emersion.
| |
| − | | |
| − | These features and functionality assumes the following:
| |
| − | | |
| − | # Each Emersion Service Provider Account to have a one to one relationship with one company in Xero. This is done via the Private API in Xero.
| |
| − | # Emersion knows of ONE bank account that payments go to when sent to Xero.
| |
| − | | |
| − | === Assumptions ===
| |
| − | | |
| − | Emersion knows of ONE bank account that payments, when sent to Xero, go into. The Emersion API is not going to be designed to handle payment submission to a choice of bank accounts or more than one account in Xero marked as ‘receive payment allowed’.
| |
| − | | |
| − | Emersion will only pull over payments to Emersion from Xero in the API, under the following rules:
| |
| − | The payment does not exist in Emersion already.
| |
| − | The invoice that the payment is done against in Xero exists in the Emersion system.
| |
| − | Any overpayments (that in Xero, generate an unrelated new invoice and a credit) will not be pulled over as we have no knowledge of the invoice that is generated by an overpayment (Split payment) in Xero.
| |
| − | | |
| − | == Configuration of Xero and Emersion ==
| |
| − | | |
| − | This requires subscription to the Xero Integration. Please contact [mailto:sales@emersion.com.au sales@emersion.com.au] for a quote for this feature.
| |
| − |
| |
| − | You must:
| |
| − | | |
| − | * You must be a Xero customer using Emersion for billing.
| |
| − | * Obtain a OAuth Consumer Key and Consumer Secret and provide this to Emersion
| |
| − | * Obtain a Private Key and a Public Key and provide this to Emersion
| |
| − | * Know which bank account to point payments at. Emersion needs the account ID from Xero.
| |
| − | | |
| − | Please submit this infomration with your signed Work Order to [mailto:workorder@emersion.com.au workorder@emersion.com.au], or alternatively, update the Work Order ticket with this information. Once Emersion has enabled and configured the feature, you will have Xero and Emersion integrated.
| |
| − | | |
| − | | |
| − | === Accounts Synchronisation ===
| |
| − | | |
| − | Accounts in Emersion (customers) need to know who they are going to be matched up with in Xero.
| |
| − | | |
| − | At this point in time, the '''Export Reference''' field of an account needs to match EXACTLY what the Account Contact Name is in Xero. The screenshot here shows how this works at a really basic level.
| |
| − | | |
| − | | |
| − | | |
| − | Only accounts that have a valid Contact Name in the '''Export Reference''' field in Emersion will be able to interface with the relevant contact in Xero, otherwise the communication will fail.
| |
This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home.
