fyo icon

fyo

Interact with fyo API

Actions11

Grains → Get Withholdings

AI-generated

Summary

Retrieve grain withholdings by searching through date range, receipt number, or payment slip number.

Inputs

  • Search By - searchTypeRetenciones (required) — Choose the method to search withholdings: byDates, byReceiptNumber, or byPaymentSlip.
  • Date From - fechaDesdeRet (required) — Start date of the search range when searching by date range (maximum 1 month span). Required if searching byDates.
  • Date To - fechaHastaRet — End date of the search range when searching by date range (optional, must not exceed 1 month from start).
  • Receipt Number - numeroComprobanteRet (required) — The receipt number used to search when searching byReceiptNumber.
  • Payment Slip Number - numeroMinutaPago (required) — The payment slip number used to search when searching byPaymentSlip.

Output shape

a list of grain withholding records each returned as separate output items

Returns an array of withholding data records from the Fyo API in response to the search parameters. The response data is extracted from the API's wrapped response object or array, so multiple withholdings can be retrieved in one execution.

Examples

Example 1: Search withholdings by date range

Set 'Search By' to 'Date Range', specify 'Date From' (required) and optionally 'Date To' within a 1 month maximum range.

Example 2: Search withholdings by receipt number

Set 'Search By' to 'Receipt Number', provide the exact receipt number (required).

Example 3: Search withholdings by payment slip number

Set 'Search By' to 'Payment Slip Number', provide the exact payment slip number (required).

Links

Discussion