Actions12
- Sales Order Actions
- Customer Actions
- Item Actions
- Invoice Actions
Overview
This node integrates with the MYOB Business API to perform advanced searches on Sales Orders. It allows users to search sales orders using various filters such as customer name, purchase order number, date range, status, comment content, or a custom OData filter expression. This functionality is useful for businesses that need to quickly locate specific sales orders based on detailed criteria, enabling efficient order management and reporting.
Practical examples:
- Find all sales orders placed by a particular customer (e.g., "John Smith").
- Retrieve sales orders within a specific date range for monthly sales analysis.
- Search for orders with a certain status like "Open" or "Closed".
- Locate orders containing specific comments such as "urgent".
- Use a custom OData filter to find orders exceeding a certain total amount and with a particular status.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of records to return (default: 100) |
| Search Filter | Type of search to perform. Options: - By Customer Name (partial match) - By Purchase Order Number (exact match) - By Date Range - By Status - By Comment (partial match) - Custom Filter (OData expression) |
| Customer Name | Customer name to search for (partial match). Required if Search Filter is "By Customer Name" |
| Purchase Order Number | Purchase order number to search for (exact match). Required if Search Filter is "By Purchase Order Number" |
| Start Date | Start date for date range search. Required if Search Filter is "By Date Range" |
| End Date | End date for date range search. Required if Search Filter is "By Date Range" |
| Order Status | Status of the sales orders to search for. Options: Open, Converting, BackOrder, Closed. Required if Search Filter is "By Status" |
| Comment Text | Text to search for in order comments (partial match). Required if Search Filter is "By Comment" |
| Custom Filter Expression | Custom OData filter expression. Required if Search Filter is "Custom Filter" |
Output
The output JSON contains the following fields:
searchType: The type of search performed (e.g., "customer", "purchaseOrder", "dateRange", etc.).filter: The OData filter string used in the query.totalResults: Number of sales orders returned by the search.items: Array of sales order objects matching the search criteria.fullResponse: The complete raw response from the MYOB API including metadata.
Each item in items represents a sales order with its details as provided by the MYOB API.
Dependencies
- Requires an API key credential for authenticating with the MYOB Business API.
- Needs configuration of the company file GUID associated with the MYOB account.
- Uses the MYOB REST API endpoint
https://api.myob.com/accountright/{companyFileGuid}. - Relies on the bundled transport module for making HTTP requests to MYOB.
Troubleshooting
- No input data received: Ensure that the node receives input data; otherwise, it will throw an error.
- Unsupported search filter: If an invalid search filter option is selected, the node throws an error indicating unsupported filter.
- Empty required parameters: Parameters like Purchase Order Number, Customer Name, dates, or custom filter expressions must not be empty when required.
- API response issues: If the MYOB API returns invalid or empty responses, the node reports this in the output message.
- Authentication errors: Verify that the API key credential is correctly configured and has access to the specified company file.
- Rate limits or network errors: These may cause request failures; check network connectivity and MYOB API usage limits.