Actions20
Customer → Get Open Docs
AI-generatedSummary
Retrieve a list of open documents for a customer based on optional filters.
Inputs
- client_id — A specific client identifier; if empty, retrieves documents for all clients.
- options — Additional options for filtering the documents. Options include document type, whether to get items in each document, customer email, and customer name.
- doctype — Filter by document type (e.g., Invoice Receipt, Tax Invoice, Receipt, Refund, Deal).
- get_items — Include items from each document when set to true.
- email — Filter results by customer email.
- client_name — Filter results by customer name.
Output shape
A list of open documents associated with the specified customer or all customers if no client ID is provided.
Returned items may include details based on optional filters applied, such as document type and whether to include items.
Examples
Example 1: Retrieve all open documents for a specific client.
Set 'Client ID' with a specific identifier and leave other options empty.
Example 2: Retrieve all open invoices for all clients without items.
Leave 'Client ID' empty and select 'Document Type' as 'Tax Invoice', ensure 'Get Items' is set to false.
Example 3: Get open documents filtering by customer email.
Set 'Client Email' to filter by a specific customer's email.