Productive icon

Productive

Interact with the Productive API

Actions508

Automatic Invoicing Rules → Get automatic invoicing rules

AI-generated

Summary

Retrieve automatic invoicing rules from Productive, supporting optional pagination, sorting, and filtering to limit and order the results.

Inputs

  • Return All — Boolean to return all automatic invoicing rules or limit the results.
  • Limit — Maximum number of results to return if 'Return All' is false.
  • Page Number — Page number to retrieve when not returning all results (default is 1).
  • Page Size — Number of results per page when not returning all results (default 30, max 200).
  • Filter Query String — Literal filter query string to override default filters. If provided, other filters are ignored.
  • Filters — One or more field filters (Budget ID, Creator ID, ID) with operations like equals, contains, greater than, etc., applied if no filter query string is provided.
  • Sort By — Field to sort results by (Created At, ID, or None).
  • Sort Order — Sort order, ascending or descending.

Output shape

a list of automatic invoicing rule items matching the specified filters and sorted according to inputs

Supports pagination when 'Return All' is false. Filters are mutually exclusive with filter query string. Returns an error envelope if execution fails, unless 'Continue on Fail' is enabled.

Examples

Example 1: Retrieve up to 50 automatic invoicing rules sorted by creation date ascending

Return All: false, Limit: 50, Sort By: Created At, Sort Order: asc

Example 2: Retrieve all automatic invoicing rules with ID containing 'abc'

Return All: true, Filters: ID contains 'abc'

Example 3: Retrieve page 2 of automatic invoicing rules with page size 30, filtered by Budget ID equals '123'

Return All: false, Page Number: 2, Page Size: 30, Filters: Budget ID equals 123

Discussion