Productive icon

Productive

Interact with the Productive API

Actions508

Payments → Get payments

AI-generated

Summary

Retrieve payment records from Productive with optional filtering, sorting, and pagination controls.

Inputs

  • Return All — Boolean flag to specify whether to return all payment records or limit the number of results.
  • Limit — Maximum number of payment records to return when not returning all.
  • Page Number — Page number to retrieve when limiting results.
  • Page Size — Number of payment records per page, between 1 and 200.
  • Filter Query String — Literal filter query string that overrides individual filters and must follow Productive API syntax.
  • Filters — One or more filters to apply on payment fields (ignored if Filter Query String is provided). Fields include Amount, Budget ID, Company ID, External ID, Invoice ID, Number, Paid After/Before/On, Project ID, Subsidiary ID, Written Off On. Each filter consists of a field, an operation (e.g., Equals, Contains, Greater Than), and a value.
  • Sort By — Field to sort the returned payments by (e.g., Amount, Date, Invoice number, Paid On).
  • Sort Order — Sort direction: ascending or descending.

Output shape

An array of payment records represented as JSON objects.

If 'Return All' is false, pagination with 'Page Number' and 'Page Size' controls which subset of results are returned. Providing a 'Filter Query String' disables individual filter inputs. Errors for individual items appear as JSON objects with an 'error' message if 'Continue On Fail' is enabled.

Discussion