Actions13
Income → Get Many
AI-generatedSummary
Retrieve multiple income records with optional filtering, sorting, and pagination by specifying the username and various filter criteria.
Inputs
- Username (required) — Username to scope the income records (required).
- Filters — Optional filters including view type, user IDs, date ranges, status, income type, customer ID, revenue unit ID, salesperson, amounts, due dates, update timestamps, sorting column and order, pagination page number, and limit on results.
- Response Selector — Choose which part of the response to return: full response or just the array of incomes.
Output shape
a list of income records or a full response object depending on the response selector
Returns multiple income records matching the criteria. The 'incomes' array is returned by default; selecting full response returns the entire API response object. Pagination is controlled via 'page' and 'limit' filters. Throws an error if the API response code is not 1.