fyo icon

fyo

Interact with fyo API

Actions11

Grains → Get Unloads

AI-generated

Summary

Retrieve grain unloads filtered by either a date range or a specific CTG number in the fyo system.

Inputs

  • Search By (required) — Choose search method: 'Date Range' to specify a start (required) and optional end date within one month, or 'CTG Number' to specify a single CTG number.
  • Date From (required) — Start date for the unloads search range when using 'Date Range' search. Must not exceed one month before 'Date To' if specified.
  • Date To — Optional end date for the unloads search range when using 'Date Range' search. Must be within one month of 'Date From'.
  • CTG Number (required) — The specific CTG number to filter unloads when using 'CTG Number' search.

Output shape

a list of grain unload records matching the search criteria

Returns an array of unload data objects. If no unloads match, returns an empty array. Validation ensures date inputs are correct and the date range does not exceed one month.

Examples

Example 1: Get grain unloads for a specified date range

Set 'Search By' to 'Date Range', provide 'Date From' and optionally 'Date To' within a one-month range.

Example 2: Get grain unloads by CTG number

Set 'Search By' to 'CTG Number' and provide the CTG number to query unloads.

Links

Discussion