v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

bank-payments

Get bank payments

Get all bank payments for the company that were created by the integration. Scope: bank-payments:read-limited

get/companies/{companyId}/bank-payments

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

Field	Type
amount	number
status	string
paymentDate	date-time
createdDateTime	date-time

Response

Bank payments found

totalItemsinteger

totalPagesinteger

currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "835ba700-b306-4bd9-8447-59207b6b0002",
      "status": "readyToSign",
      "createdDateTime": "2023-10-01T08:15:00Z",
      "amount": 1000,
      "paymentDate": "2023-10-01",
      "ownNote": "Payment for invoice #12345",
      "recipientRef": {
        "kind": "transfer",
        "recipientName": "Property Management Co",
        "recipientReference": "RENT-2025-08",
        "clearingNumber": "8000",
        "accountNumber": "1234567890"
      }
    }
  ]
}