iCountInstall

Summary

Search for documents matching specified criteria.

Inputs

• returnAll — Indicates whether to return all results.
• max_results — Maximum number of results to return (0-1000) if returnAll is false.
• detail_level — Level of detail for the returned information.
• filters — Collection of filters such as Client ID, Document Type, Date Range, etc.

Output shape

a list of documents that match the search criteria

If returnAll is set to true, all matching documents are returned; otherwise, the number returned is limited by max_results. The size of the result can be controlled with pagination parameters such as offset.

Examples

Example 1: Retrieve a list of all invoice documents issued after a specific date.

Set returnAll to true, filters for doctype to 'invoice', and filters for start_date to the desired date.

Example 2: Fetch a limited number of open receipts for a specific client.

Set returnAll to false, max_results to the desired number, and filters for doctype to 'receipt' and filters for status to '0' (open).