MYOB icon

MYOB

Interact with MYOB Business API - Sales Orders, Customers, Items, Invoices, and more
Join our community

Actions12

Overview

This node integrates with the MYOB Business API to manage Sales Orders. Specifically, the "List" operation under the "Sales Order" resource retrieves a list of sales orders from MYOB, optionally filtered by an OData filter expression and limited in number.

Common scenarios for this node include:

  • Retrieving recent or specific sales orders for reporting or synchronization.
  • Filtering sales orders based on criteria such as active status or date ranges.
  • Integrating MYOB sales order data into other workflows or systems.

For example, you could use this node to fetch the latest 50 active sales orders to update your CRM or generate custom sales reports.

Properties

Name Meaning
Limit Maximum number of sales order records to return. Default is 100.
Filter Optional OData filter expression to narrow down the list of sales orders. Example: IsActive eq true

Output

The output is a JSON object containing the response from the MYOB API for sales orders. It typically includes:

  • Items: An array of sales order objects matching the query.
  • Count: The total number of sales orders returned.
  • Other metadata fields as provided by the MYOB API.

Each sales order object contains detailed information about the order, such as customer details, line items, dates, status, and purchase order numbers.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the MYOB Business API (OAuth2).
  • Needs the company file GUID configured via credentials to target the correct MYOB company file.
  • Uses the MYOB REST API endpoints under https://api.myob.com/accountright/{companyFileGuid}.

Troubleshooting

  • Empty Input Data: The node throws an error if no input data is received.
  • Invalid Filter Expression: If the OData filter syntax is incorrect, the MYOB API may return errors or empty results.
  • API Authentication Errors: Ensure the OAuth2 API key credential is valid and has access to the specified company file.
  • Limit Parameter Issues: Setting an excessively high limit might cause performance issues or API throttling.
  • Network or API Errors: Network connectivity problems or MYOB API downtime can cause request failures.

To resolve common errors:

  • Verify the API credentials and company file GUID.
  • Check the correctness of the OData filter string.
  • Use reasonable limits to avoid timeouts.
  • Enable "Continue On Fail" in n8n to handle partial failures gracefully.

Links and References

Discussion