Reporting
List all settlement reports
List all available settlement reports under the platform. Filtered results can be retrieved with extra parameters in the query.
Query Parameters
category
stringOptionalFilter settlement reports by category.
ending_before
stringOptionalA cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo, your subsequent call can include ending_before=foo_ZXhhbXBsZQo in order to fetch the previous page of the list.
from_date
stringOptionalFilter settlement reports from this date.
limit
integerOptionalA limit on the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
stringOptionalA cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
statement_subject_id
stringOptionalFilter settlement reports by statement subject ID.
to_date
stringOptionalFilter settlement reports to this date.
type
arrayOptionalFilter settlement reports by type.