---
title: "GET /paymentRun"
method: GET
path: "/paymentRun"
tags: ["paymentRun"]
---

# GET /paymentRun

`GET /paymentRun`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/paymentRun`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/paymentRun/get.ts> (a function with typed inputs; its response is checked against the schema)

query paymentRun

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

paymentRun response

- object
  - `result` PaymentRun[]
    - `id` string
    - `version` string
    - `createdDate` integer
    - `lastModifiedDate` integer
    - `paymentRunDate` integer
    - `paymentRunItems` PaymentRunItem[]
      - `id` string
      - `version` string
      - `amountDiscount` string, number
      - `amountPayment` string, number
      - `bankAccountId` string
      - `bankTransactionId` string
      - `cleared` boolean
      - `conversionRate` string, number
      - `conversionRateDate` integer
      - `createdDate` integer
      - `lastModifiedDate` integer
      - `partyBankAccountId` string
      - `paymentRunId` string
      - `paymentRunPaymentType` 'NONE' | 'ONLINE' | 'SEPA' | 'SWIFT'
      - `purchaseOpenItemId` string
      - `purpose` string
      - `recordCurrency` Currency
        - `id` string
        - `version` string
        - `createdDate` integer
        - `currencySymbol` string
        - `lastModifiedDate` integer
        - `name` string, required
    - `paymentRunNumber` string
    - `runByUserId` string
    - `totalAmount` string, number

## Other responses

- `default`: error response

## Changes

- **2022-12-03** `cc274ef79dfd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/paymentRun/get.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)