List of Statements

get

https://partner-api.getpliant.com/api/statements

Returns a list of metadata for every statement for the given organization. A statement groups all booked transactions and all other relevant payments on a monthly basis, unrelated to the payment frequency of the organization. Payments are part of a statement if the actualPaymentDate falls between the statementPeriodStart and statementPeriodEnd. Transactions are part of a statement if the bookingDate falls between the statementPeriodStart and statementPeriodEnd. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results. If you are looking for details about the payments according to the payment frequency of the organization, use the payments endpoints.

Query Params

organizationId

uuid

required

The ID of the organization to get the statements for.

cardAccountId

uuid

The ID of the card account to get the statements for.

isClosed

boolean

Filter by already closed statements?

fromDate

date-time | null

The date from which to return statements, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDate

date-time | null

The date until which to return statements, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField

string | null

enum

Defaults to createdAt

Desired date field to be filtered by if fromDate or toDate present.

Allowed:

limit

integer

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

page

integer

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy

string

enum

The field to sort by.

Allowed:

sortDirection

string

enum

The direction to sort by.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.