fmAccounting Link (MYOB Essentials Edition) Frequently Asked Questions

What versions of FileMaker Pro/Pro Advanced does fmAccounting Link (MYOB Essentials Edition) require?

fmAccounting Link (MYOB Essentials Edition) currently works with FileMaker Pro/Pro Advanced v12, v13, v14, v15, v16 and v17. We continue to develop fmAccounting Link (MYOB Essentials Edition) and will ensure it works with future releases of FileMaker Pro.

Does fmAccounting Link (MYOB Essentials Edition) use ODBC or export/import of .txt files?

No. fmAccounting Link (MYOB Essentials Edition) makes HTTPS requests to the MYOB Essentials API to create/update records in your selected MYOB Essentials Business file. If successful the MYOB records are created/updated immediately without having to export and import .txt files or use ODBC.

Do I have to be logged in to MYOB Essentials to use the API?

No – all requests to upload/download data function regardless of whether you are currently logged in to MYOB Essentials.

What’s the best way to integrate this into my existing FileMaker solution?

How you go about integrating the functionality from the fmAccounting Link (MYOB Essentials Edition)  file is entirely up to you – as the file is completely unlocked you get to go behind the scenes to learn how to handle the authentication, uploading, downloading etc and then recreate that in your existing FileMaker solution. Based on feedback from customers all around the world there have been three main ways they have approached the integration:

Linking – this involves using the fmAccounting Link file as a ‘interface’ or front-end file to your existing FileMaker file. This is a relatively quick way to get up and running – you relink the table occurrences to reference the matching tables in your existing FileMaker file and then update the layouts and add any new fields (such as the ‘MYOB ID’ fields and the POST data calculation fields). You also need to update any field references in scripts and create any new value lists.

Use the fmAccounting Link file as a Controller File – this involves pushing data to the fmAccounting Link file from your existing FileMaker file and use that to handle the uploading/downloading of data with MYOB Essentials. This is also a relatively quick way to get up and running – you simply write scripts in your FileMaker solution to push Contacts, Invoices etc across from your file to the fmAccounting Link file and use that to handle all the uploading of FileMaker data to MYOB Essentials. To prevent duplicate Contacts from being created you would create a ‘MYOB Contact ID’ field to store the MYOB Contact ID value, otherwise everything else happens in the fmAccounting Link file. You could then do an upload once a day of all Invoices generated that day etc.

Embedding – this is the most complex and time consuming type of integration as it involves recreating the required functionality from the fmAccounting Link file in your existing FileMaker solution. Our integration guide covers the high level steps that you need to take and the order in which to complete them. Most of the code can be copied and pasted, however you will need to manually create some relationships, table occurrences and valuelists. You can typically be up and running with authentication and uploading a Contact/Invoice in around 4 – 8 hours depending on the complexity of your existing FileMaker solution.

If you do decide to use the fmAccounting Link file you will have to create and manage any required FileMaker Accounts and Privilege Sets.

We are already using MYOB Essentials and have existing Contacts, Invoices etc. Is there a way to prevent duplicate Contacts from being created? 

Yes – the MYOB Essentials API exposes the MYOB Contact ID field which is their unique identifier for a Contact record. We store this in a field in the fmAccounting Link file in the Contacts table (same for Invoices, Payments etc – they all have their own unique MYOB ID). You can use the fmAccounting Link file to download all existing Contacts from MYOB Essentials to get access to the MYOB Contact ID values and then create a field in your FileMaker solution to store this, then populate this from the fmAccounting Link file via a relationship based on Company Name etc.

Once this is populated any future uploads to MYOB Essentials will not create a duplicate Contact in MYOB Essentials but use this for uploading to an existing MYOB Essentials Contact.

Are partial updates supported?

No – the Essentials API does not support PATCH which means you cannot do a partial update of a record. This means that whenever you are updating an existing MYOB record (e.g. Contact or Invoice) you must pass the full details with each request. If you don’t pass back all the details the API assumes you are wanting to delete those values.

Can I use fmAccounting Link (MYOB Essentials Edition) with FileMaker Server scripts/Perform Script on Server?

The MYOB Essentials API uses OAuth 2.0 to ensure that access to business data is handled securely. The authentication process requires you to login to the my.MYOB website to verify your credentials – this is not possible via a server side script as it requires user interaction to enter the my.MYOB login details. You will NOT be able to use FileMaker Server scheduled scripts or Perform Script on Server unfortunately.

Is FileMaker Pro Advanced required?

FileMaker Pro Advanced is only required to copy/paste the Custom Functions that fmAccounting Link (MYOB Essentials Edition) uses when you are integrating this into your own FileMaker solution files. Otherwise you can use both FileMaker Pro and Pro Advanced when using the fmAccounting Link (MYOB Essentials Edition) functionality.

Does fmAccounting Link (MYOB Essentials Edition) work on Mac OS X?

Yes.

Does fmAccounting Link (MYOB Essentials Edition) use a plug-in?

Yes – Filemaker Pro currently does not have the required functions to integrate with the MYOB Essentials API, so a FileMaker plug-in is required.

Is there any documentation to help us integrate fmAccounting Link (MYOB Essentials Edition) into our own FileMaker solution?

Yes – we have a dedicated Integration page. We also plan to add some additional videos to illustrate particular aspects of the integration.

Can I upload an Invoice and create a new Contact at the same time?

The MYOB Essentials API does not currently support creating an Invoice and a Contact with a single API call. You will need to upload the Contact first and then upload the Invoice.

Can I upload a Payment with an Invoice to mark the Invoice as Paid?

The MYOB Essentials API does not currently support creating a Paid Invoice with a single API call. You will need to upload the Invoice and the Payment separately.

Can I upload a Payment with an Invoice to mark the Invoice as Paid?

The MYOB Essentials API does not currently support creating a Paid Invoice with a single API call. You will need to upload the Invoice and the Payment separately.

Is there a list of changes in each version of fmAccounting Link (MYOB Essentials Edition)?

Yes – to see what’s new with each update check out the fmAccounting Link (MYOB Essentials Edition)  version history log

If you have any questions about fmAccounting Link (MYOB Essentials Edition) please contact us and we’ll get back to shortly.