MYOB icon

MYOB

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

Actions12

Overview

This node interacts with the MYOB Business API specifically for managing Customer data. The Customer - List operation retrieves a list of customers from the MYOB system. It supports filtering results using OData filter expressions and can automatically paginate through all available pages to fetch the complete customer list.

Common scenarios where this node is beneficial include:

  • Synchronizing customer data from MYOB into other systems or databases.
  • Generating reports or analytics based on customer records.
  • Automating workflows that require up-to-date customer information.

For example, you might use this node to fetch all active customers (IsActive eq true) and then send marketing emails or update CRM records accordingly.

Properties

Name Meaning
Limit Maximum number of customer records to return. Default is 100.
Filter Optional OData filter expression to narrow down the customers returned. Example: IsActive eq true.
Fetch All Pages Boolean flag. When enabled, the node will automatically fetch all pages of results, ignoring the Limit parameter. Useful for retrieving the entire customer dataset without manual pagination.

Output

The output JSON contains the following structure:

  • Items: An array of customer objects retrieved from MYOB. Each object represents a customer record with fields as provided by the MYOB API.
  • Count: Total number of customer records available (according to MYOB).
  • PaginationInfo: Metadata about the pagination process including:
    • Whether all pages were fetched.
    • Pagination method used (manual in this case).
    • Total pages expected and actual pages retrieved.
    • Items per page and total items retrieved.
    • Debug info such as missing items count and retrieval success rate.

If "Fetch All Pages" is disabled, only the first page of results limited by the "Limit" property is returned.

No binary data output is produced by this operation.

Dependencies

  • Requires an authenticated connection to the MYOB Business API via OAuth2 credentials.
  • Needs the company file GUID from the MYOB credentials to construct API requests.
  • Uses the internal helper function to make HTTP requests to MYOB endpoints.

Troubleshooting

  • Empty or invalid response: If the API returns no data or an unexpected format, ensure the MYOB credentials are valid and the company file GUID is correct.
  • Filter syntax errors: Invalid OData filter expressions may cause API errors. Verify the filter string syntax matches OData standards.
  • Pagination issues: When fetching all pages, network interruptions or API limits could cause incomplete data retrieval. Check logs for partial results and retry if necessary.
  • Permission errors: Ensure the API key has sufficient permissions to read customer data.
  • Limit ignored when fetching all pages: This is expected behavior; disable "Fetch All Pages" if you want to limit results strictly.

Links and References

Discussion