USER MANUAL Setting Up Fooman Connect: Xero

Transcription

1 USER MANUAL Setting Up Fooman Connect: Xero This user manual will take you through the set up process for Fooman Connect: Xero. The set up video provides screencasts and takes you through a simplified version of this guide. Before You Start Install Extension Refer to The Ultimate Guide to Installing Magento Extensions and follow the installation steps (The Ultimate Guide is included in your purchase confirmation , and also downloadable from the Fooman website). Page 1

2 Step 1 Create Private/Public Key Pair Creating a private/public key pair secures the connection between your Magento store and Xero account, via Fooman Connect: Xero, with a SSL certificate. The SSL certificate is valid for 10 years, after which you will be prompted to create a new certificate. If preferred, you can choose to use your own SSL certificate rather than following this step. Instructions 1. Log into your Magento backend and go to Fooman Connect > Xero Orders 2. Click the link that appears at the top of the page to create a Private Key. Ignore the warning message that reads Connection to Xero is not yet set up please go to System > Configuration > Fooman Connect. This will be set up later in this process. 3. Click the new link to download the Public Key and save it on your computer. Page 2

3 Step 2 Add Application in Xero Instructions 1. Go to api.xero.com and login using your standard Xero login details 2. Go to My Applications and choose to add a new application 3. Choose a "private" application 4. Choose an application name of your choice 5. Select which Xero store you want to link 6. Upload your previously created public key file as the X509 certificate 7. Click Save 8. When the confirmation page loads, you will be presented with a set of Oauth Credentials which will be used to configure access for your Magento store in the next step. Further Guidance If you require further guidance on this step, refer to the instructions Xero has prepared on applications: Note that Xero has recently introduced a limit of 2 private applications for each Xero account. Page 3

4 Step 3 Configure Magento Instructions 1. Log into your Magento store backend and go to System > Configuration > Fooman Connect 2. Set up the following fields: Serial Number Paste your Fooman Connect serial number found in the order pdf attached to your original order confirmation Enabled Select Yes to enable Fooman Connect. Consumer Key/Consumer Secret Copy and paste the Xero Oauth Consumer Key and Consumer Secret from step 2 into the corresponding fields. Private Key This will be automatically populated from step 1. If you chose to use your own SSL certificate, paste the private key name here. Password of Private Key Leave this field empty if you followed the directions in step 1. If you chose to use your own SSL certificate, paste the password of the private key here. 3. Click Save Config. Page 4

5 4. Magento will now connect to Xero to retrieve your organisation's information like account codes and tax rates 5. Once your organisation's information has been retrieved from Xero, configure the following fields with and click save configuration. Don't configure the automatic export or any additional fields not shown below yet this will be done in step 6. Sales Account Select the Xero account where you want to record sales. This setting applies on a per store level, and can be manually overridden on an individual product level by doing the following: Go to Catalog > Manage Products Click into the product that you wish to individually configure a different Xero Sales Account for In the newly added field Xero Sales Account Code, select the Xero account where you want to record sales for this item Repeat for every product you wish to manually override Page 5

6 Shipping Account Select the Xero account where you want to record shipping. Refund Account Select the Xero account where you want to record refunds. Discount Account Select the Xero account where you want to record discounts. Surcharge Amount This setting only has effect if you are also using the Fooman Surcharge extension. Select the Xero account where you want to record surcharges. Default Tax Rate for None Taxed Items Select the tax rate to use when the item has no other tax rule applied and the tax amount is zero. Shipping Tax Choose your shipping tax rate. Surcharge Tax This setting only has effect if you are also using the Fooman Surcharge extension. Choose your surcharge tax rate. Tracking (Optional) Use this setting if you already use tracking categories in Xero and want to track your online sales channel. Choose a tracking option to record online transactions exported to Xero. 6. Click Save Config. Page 6

7 Step 4 Map Tax Rates Mapping tax rates allows Magento to remember the correct tax rate in Xero when exporting transactions. Instructions 1. Go to Sales > Tax > Manage Tax Zones & Rates 2. Go into each individual Tax Rate and under Xero Rate choose the appropriate Xero tax rate from the dropdown menu under Fooman Connect. Even if the correct tax rate is already shown, you still need to click Save for this to take effect. It is important to map tax rates with the same effective tax rate ie. A tax Xero rate of 15% should be matched to a Magento tax rate of 15%. Choose a tax rate on income unless you have a specific reason otherwise. 3. Repeat this for every tax rate in your store. Page 7

8 Step 5 Confirm Set Up via Manual Export To confirm that transactions are being exported to Xero according to your intended settings set up in step 4, we strongly recommend manually exporting a handful of representative orders and/or credit memos from Magento to Xero before setting up the automatic export process. Instructions 1. Go to the Fooman Connect > Xero - Orders tab (or to the Fooman Connect > Xero - Credit Memos tab if you also chose to manually export credit notes) 2. Tick any checkboxes next to all orders/credit memos that you want to manually export, and click Export Selected on the Action dropdown menu. If you want to export all orders/credit memos, click on Process All Unexported Orders / Process All Unexported Credit Memos. 3. Click Submit Manual exports are processed straight away without delay, however keep in mind that attempting to process large volumes at once may cause time out errors. We recommend processing one page of orders/credit memos at a time to avoid any issues. An error message when exporting indicates an issue during setup. If this occurs, click into the individual order to see a more detailed error message, then provide these details to Fooman Support. Page 8

9 4. Go to the Xero website and review the exported orders/credit memos under Draft Invoices. All orders/credit memos appear as individual line items with the product name. The tax rate and account codes are also automatically filled in for you. All that's left for you to do is approve and reconcile the invoice/credit memo. Customer Records During the export process, invoices/credit memos will be matched to existing customer records, and customer records will be automatically created for new customers with their address, phone number and address. Item Details (Version 1.4+) During the export process, the Xero field Items will be automatically populated with the Magento sku. This allows you to run reports in Xero on sales by item. You can view the overall item categories in Xero go to Settings > General Settings > Inventory Items. Xero allows a maximum of 30 characters in the Item field. If the Magento sku is longer that 30 characters, when exported to Xero it will be added to the invoice/credit memo description, but will not appear in the Item field. 5. Check that everything has been exported as expected, according to the settings chosen in step 4. If you need to update any settings, do this now and then repeat step 5. Page 9

10 Other Uses For the Manual Export Function The manual export function can also be used in other circumstances: To manually export orders/credit memos from before the automatic export process was activated. Follow the directions given in steps 1-3 above. (It is also possible to use the Start Date for Orders/Credit Memos feature in step 6, which will achieve the same purpose). To manually exclude orders/credit memos from the automatic export process. Tick any checkboxes next to all orders/credit memos that you want to manually exclude, click Never Export Selected on the Action dropdown menu, then Submit. Page 10

11 Step 6 Set Up Automatic Exports Configure Fooman Connect to automatically send your new Magento order data to Xero every five minutes. Xero's API limit is 60 requests per minute. For more information about this, visit If you receive an error message because the Xero API limit has been exceeded, Fooman Connect: Xero will automatically try to export the failed transactions again. If this issue persists for longer than 24 hours (ie. a 'catch up' did not occur where the failed transactions were successfully exported in less busy periods), please get in touch with Fooman Support to work out what options may be available. Instructions 1. Go to System > Configuration > Fooman Connect 2. Configure the following settings and click Save Configuration. Enable Automatic Exports Select Yes to enable Fooman Connect: Xero. It is important to verify that a Magento cronjob was correctly configured during the initial set up of your Magento store, as this is essential to the automatic export function of Fooman Connect. If in doubt, please check with your web host or system administrator to confirm this. More information about cronjobs can be found here. Even though the automatic export is scheduled to be run every 5 minutes, it cannot run faster than the system cron job. Page 11

12 Export Orders with Status Choose which order status/statuses will trigger export to Xero. The first time a new order reaches this status, it will be exported to Xero. Multiple statuses can be selected, as each order will only be exported once. Choose the status/statuses that best match the workflow of your payment methods and corresponds to money hitting your Xero accounts for example, 'pending' for credit card payments, 'complete' for bank transfers, and so forth. Credit memos are automatically exported when created. As well as triggering the automatic export, note that you can only manually export transactions with these statuses. Export Orders with Zero Amounts When set to Yes, zero amount orders (free downloads/products) will also be exported to Xero. Use Xero Numbers When set to Yes, orders/credit memos exported to Xero will use the Xero assigned number rather than the Magento assigned number. After an order/credit memo has been exported to Xero, the Xero assigned number will also be saved back to your Magento store and will override the original assigned Magento number. We recommend using this feature only if you are required for any reason to use the same numbering sequence as Xero for your Magento store. The limitation of this setting is that the order confirmation sent to customers will contain the originally assigned Magento order/credit memo number, rather than the new Xero number. The original Magento number will still be shown as a reference number in Xero, but will no longer be searchable in your Magento store. Page 12

13 Enter your chosen prefix to differentiate credit memo numbers from order numbers. While these numbers are the same in Magento, Xero requires these numbers to be unique. Transfer Currency Choose to export orders/credit memos in store base currency or order currency. Show Xero Payments on Order View Page When set to Yes, a new box called Fooman Connect will be created in each individual order view page in Magento with: 1. If the order/credit memo has been exported to Xero 2. If and on which date payment has been received (ie. whether the payment has been reconciled in Xero) Xero Version Select the Xero version you are using from the drop down list. Enable Logging When set to Yes, and when Magento logging (configure in System > Configuration > Developer > Log Settings) is enabled, log messages will be written to /var/log/xero.log Enable Reset When set to Yes, an extra button will be created on the Fooman Connect: Xero pages allowing you to reset the export status and link to the invoice/credit memo in Xero (for example, after finishing test exports to a Xero demo company). Start Date for Orders/Credit Memos (Optional) If you wish to backdate automatic exporting of orders/credit memos, enter a date in this field. Dates should be entered in UTC (GMT) format. Enter the same date in both the Order and Credit Memo fields. If no date is entered, automatic exporting will commence from the time of the process being set up and will not be backdated. Credit Note Prefix Page 13

14 Potential Tax Calculation Issues and Recommended Settings Magento and Xero calculate tax amounts in different ways. In certain circumstances, this can cause Xero to reject exported transactions which don't comply with its own tax calculations. The best way to minimise this is to set up Magento and Xero to calculate tax amounts in the most similar way possible. We recommend using the following Magento tax settings under System > Configuration > Tax > Calculation Settings, as these settings most closely match Xero's own tax settings: Tax Calculation Based On: Select Row Total Catalog Prices: Select Excluding Tax Shipping Prices: Select Excluding Tax Apply Customer Tax: Select After Discount Apply Discount On Prices: Select Excluding Tax Please check with your accountant to confirm that these settings meet your business requirements. Even using the settings above, it can still occur that Magento and Xero tax amounts do not match exactly. Fooman Connect: Xero provides a workaround by rounding the Magento tax amount in Xero to match the amount Xero expects to receive. Any adjustments that need to be made will appear in Xero's rounding account. On version 1.4+ of Fooman Connect: Xero, we have implemented a feature to reject any transaction where the rounding difference required would be more than 2% of the invoice value to guard against rounding amounts that are too large. If you encounter this issue, please contact Fooman Support. Page 14