This is a staging build of the docs. Do not share the link externally.
Skip to main content

MYOB troubleshooting and integration reference

Frequently asked questions, things to know, and troubleshooting guidance for our MYOB integration

Data type behavior

Direct incomes

Direct incomes are mapped from Receive money transactions in MYOB.

When pulling Direct incomes from MYOB, the sourceModifiedDate field is not available.

Additionally, trackingCategoryRefs is not available in data pulled from MYOB Essentials.

Codat's data model does not support negative unit amounts in line items of Direct incomes. If negative line amounts are pulled from MYOB, the lineItems.unitAmount is recorded as positive and the quantity is set to -1.

Direct costs

Direct costs are mapped from Spend money transactions in MYOB.

When pulling Direct costs from MYOB, the sourceModifiedDate field is not available.

Additionally, trackingCategoryRefs is not available in data pulled from MYOB Essentials.

Codat's data model does not support negative unit amounts in line items of Direct costs. If negative line amounts are pulled from MYOB, the lineItems.unitAmount is recorded as positive and the quantity is set to -1.

Invoices

Codat does not currently support updating item based invoices.

Integration behavior

Synchronous integration

Our MYOB integration is a synchronous integration. However, for simplicity and consistency with the rest of Codat's integrations, you should treat it as asynchronous. Learn more about what that means when creating, updating or deleting data.

Multiple currencies

MYOB Essentials does not support multiple currencies and records all transactions in local currency (AUD or NZD).

MYOB AccountRight supports multiple currencies, but still operates with base currency of AUD or NZD.

Issue date timestamps

MYOB does not supply time information when the issueDate field is pulled by Codat. As such, the date field value is always yyyy-mm-ddT00:00:00.

Performance

MYOB recommend that company files in their system are kept below 2GB. If a company has a large amount of data, some timeouts will be expected when consuming their service. If Codat encounters a timeout error when fetching data from MYOB, we will retry the operation a number of times. This may lead to some datasets taking longer than expected to complete or fetch errors.

To learn more, see the 504 Gateway Time out errors article in MYOB's support knowledge base.

FAQs

Where must company data be stored?

It must be stored online. Whilst MYOB AccountRight Live gives the option to store a company data file locally, this will make it inaccessible for Codat's integration.

See MYOB's How to put your company online for how companies can easily move their company file to the cloud if it is currently stored on their local machine.

How do I check whether company data is stored online?

When a company data file is correctly stored online (to enable linking with the Codat integration), the file should be visible when selecting 'Online' from the 'Open' menu within MYOB AccountRight.

Does the integration support multiple company data files for the same linked connection?

The integration does not currently support this. This will be implemented in the future.

How do I create a customer or a supplier without an address?

You may want to create or update a contact (a customer or a supplier) in MYOB without adding an address for them. Because a contact is expected to be either a billing or a shipping contact, you can alter the body of your request to add or change a contact without an address as follows:

{ 
"id": "customerId",
"customerName": "customerName",
"contactName": "contactName", /// must match contacts.name
"emailAddress": "contact@contactEmail.com", /// must match contacts.email
"phone": "", /// must match contacts.phone "addresses": [],
"contacts": [
{
"name": "contactName", /// this should match the contactName
"email": "contact@contactEmail.com", /// this should match the emailAddress
"phone": [], /// must match phone
"address": {
"type" : "Billing" /// this needs to be included as Billing
}
}
],
"taxNumber": "taxNumber",
"status": "Active",
"modifiedDate": "2021-04-16T10:13:55.665Z",
"sourceModifiedDate": "2021-04-16T10:13:55.665Z"
}

Was this page useful?
❤️
👍
🤔
👎
😭