GEgetpliant
Statements

List of Statements

Changed on

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.

get/statements

Request

Query parameters

organizationIdstring uuid required

The ID of the organization to get the statements for.

cardAccountIdstring uuid

The ID of the card account to get the statements for. Statements keep the card account id they were generated for. If a card account was superseded, filtering by the superseded id returns the statements of the periods before the switch and filtering by its successor (supersededBy) returns the ones after. Query both ids to get a complete list across the switch.

isClosedboolean

Filter by already closed statements?

fromDatestring date-time nullable
Example:2021-01-30T08:30:00Z

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

toDatestring date-time nullable
Example:2021-01-30T08:30:00Z

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

byDateField'startDate' | 'endDate' | 'updatedAt' | 'createdAt' nullable

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

limitinteger

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

pageinteger

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'organizationId' | 'createdAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.

Changes

  • a4fbf7d068b4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status