MYOBInstall

Overview

This node integrates with the MYOB Business API to manage Sales Orders. Specifically, the "Get" operation for the "Sales Order" resource retrieves detailed information about a sales order using its unique identifier (UID). This is useful in scenarios where you need to fetch existing sales order data from MYOB for processing, reporting, or synchronization with other systems.

Practical examples include:

• Retrieving a sales order's details to verify order status or contents before shipping.
• Fetching sales order data to update an external CRM or ERP system.
• Using the sales order information as part of an automated workflow that triggers further actions based on order attributes.

Properties

Output

The output JSON contains the full sales order object as returned by the MYOB API endpoint /Sale/Order/Item/{salesOrderUid}. This includes all details of the sales order such as customer info, line items, shipping address, comments, tax information, and status.

The structure corresponds directly to the MYOB sales order schema, typically including fields like:

• UID: Unique ID of the sales order.
• Customer: Customer details associated with the order.
• Lines: Array of line items in the order.
• ShipToAddress: Shipping address details.
• Comment, JournalMemo: Additional notes.
• Date, Status, and other metadata.

No binary data is output by this operation.

Dependencies

• Requires an API key credential for authenticating with the MYOB Business API.
• The node uses the company file GUID from the credentials to construct API requests.
• Network access to the MYOB API endpoint (https://api.myob.com/accountright/) is necessary.

Troubleshooting

• Error: "No input data received"
  Occurs if the node is executed without any input items. Ensure that the node receives input data or is triggered properly.

• Error: "The unique ID of the sales order to retrieve" missing or empty
  The Sales Order UID property is mandatory. Make sure it is provided and correctly formatted.

• API errors or empty responses
  If the MYOB API returns invalid or empty data, check that the UID exists and that the API credentials have sufficient permissions.

• Network or authentication failures
  Verify that the API key credential is valid and that the MYOB service is reachable.

Links and References

• MYOB AccountRight API Documentation
• MYOB Sales Order API Reference