# List payments

Retrieves a paginated list of payments for the specified company and optional filters.

Endpoint: GET /payments
Security: BearerAuth

## Query parameters:

  - `companyId` (string, required)
    The company identifier used to scope the query.

  - `locationId` (string)
    The location identifier used to scope the query. Shows data for all locations in the company if no locationId is provided.

  - `paymentDateStart` (string)
    Start of the payment creation date range.   Accepts ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ) or date-only (YYYY-MM-DD).

  - `paymentDateEnd` (string)
    End of the payment creation date range.   Accepts ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ) or date-only (YYYY-MM-DD).

  - `updatedDateStart` (string)
    Start of the payment last updated date range.   Accepts ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ) or date-only (YYYY-MM-DD).

  - `updatedDateEnd` (string)
    End of the payment last updated date range.   Accepts ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ) or date-only (YYYY-MM-DD).

  - `sort` (string)
    The field used to sort the results. Currently supports createdDate.
    Enum: "createdDate"

  - `sortDirection` (string)
    Defines the sort order of results.  
 • ASC — Ascending order (default).  
 • DESC — Descending order.
    Enum: "ASC", "DESC"

  - `size` (integer)
    Number of records to return per page.   Maximum value: 100. If a higher value is provided, the API defaults to 100.

  - `page` (integer)
    The page number for paginated results.

## Response 200 fields (application/json):

  - `content` (array)

  - `content.paymentId` (string)

  - `content.locationId` (string)

  - `content.companyId` (string)

  - `content.roNumber` (string)

  - `content.paymentDate` (string)

  - `content.totalPaymentAmount` (number)

  - `content.totalRefundedAmount` (number)

  - `content.netPaidAmount` (number)

  - `content.paymentType` (string)

  - `content.paymentMethod` (string)

  - `content.lastUpdatedAt` (string)

  - `content.paymentHistory` (array)

  - `content.paymentHistory.action` (string)

  - `content.paymentHistory.amount` (number)

  - `content.refunds` (array)

  - `content.refunds.refundDate` (string)

  - `content.refunds.createBy` (string)

  - `content.refunds.createAt` (string)

  - `content.refunds.updatedAt` (string)

  - `pageable` (object)

  - `pageable.sort` (object)

  - `pageable.sort.unsorted` (boolean)

  - `pageable.sort.sorted` (boolean)

  - `pageable.sort.empty` (boolean)

  - `pageable.offset` (integer)

  - `pageable.pageSize` (integer)

  - `pageable.pageNumber` (integer)

  - `pageable.paged` (boolean)

  - `pageable.unpaged` (boolean)

  - `totalPages` (integer)

  - `totalElements` (integer)

  - `last` (boolean)

  - `size` (integer)

  - `number` (integer)

  - `first` (boolean)

  - `numberOfElements` (integer)