Reporting

List all settlement reports

List all available settlement reports under the platform. Filtered results can be retrieved with extra parameters in the query.

get/reporting

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/reporting
  • Auth: HTTP basic

Query parameters

categorystring

Filter settlement reports by category.

ending_beforestring

A 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_datestring

Filter settlement reports from this date.

limitinteger

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

starting_afterstring

A 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_idstring

Filter settlement reports by statement subject ID.

to_datestring

Filter settlement reports to this date.

typestring[]

Filter settlement reports by type.

Response

Successful response

has_moreboolean required

Whether there are more reports available

Changes

No recorded changes to this operation across all 1 revision of this API.