GET
/
v1
/
transaction
Get transactions
curl --request GET \
  --url http://localhost:3001/v1/transaction \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "amount": 123,
      "remittanceInformation": "<string>",
      "requestedExecutionDate": "2023-11-07T05:31:56Z",
      "skontoAmount": 123,
      "skontoDate": "2023-11-07T05:31:56Z",
      "ignoreSkontoDeadline": true,
      "creditor": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "debitor": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "analysis": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "analysisRules": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "type": "AMOUNT_DEVIATION",
          "severity": "NORMAL",
          "markedOk": true,
          "markedOkReason": "<string>",
          "markedOkDate": "2023-11-07T05:31:56Z",
          "value": "<string>",
          "markedOkUser": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true,
            "organization": {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "featureFlags": [
                {
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "featureName": "<string>",
                  "isEnabled": true
                }
              ]
            }
          }
        },
        "customRules": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "description": "<string>",
          "rule": "<string>",
          "twoFactorCheck": true,
          "accountCheck": true,
          "deleted": true,
          "active": true,
          "executiveVerifier": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true,
            "organization": {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "featureFlags": [
                {
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "featureName": "<string>",
                  "isEnabled": true
                }
              ]
            }
          },
          "organization": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "featureFlags": [
              {
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "featureName": "<string>",
                "isEnabled": true
              }
            ]
          }
        }
      },
      "executiveVerification": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "verifiers": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "user": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true,
            "organization": {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "featureFlags": [
                {
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "featureName": "<string>",
                  "isEnabled": true
                }
              ]
            }
          },
          "choice": "PENDING"
        },
        "initiator": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "featureFlags": [
              {
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "featureName": "<string>",
                "isEnabled": true
              }
            ]
          }
        },
        "neededVerifiersAmount": 123,
        "allVerifiersNeeded": true,
        "status": "PENDING"
      },
      "archived": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "archivedByUser": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "featureFlags": [
            {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "featureName": "<string>",
              "isEnabled": true
            }
          ]
        }
      },
      "paymentRun": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "createdById": "<string>",
        "createdByName": "<string>",
        "organizationId": "<string>",
        "sumAmount": 123,
        "sumAmountWithSkonto": 123,
        "sumBookedAmount": 123,
        "transactionCount": 123
      }
    }
  ],
  "meta": {
    "page": 123,
    "take": 123,
    "itemCount": 123,
    "pageCount": 123,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
searchTerm
string

The search term to look for in the transaction list.

​
status
string

Filter transactions by status (comma separated array).

​
analysisStatus
string

Filter transactions by analysis status (comma separated array).

​
requestedExecutionDate
string

Filter transactions by due date / requested execution date.

​
filterPaymentRun
boolean

Set to true if payment run filter should be activated

​
paymentRunId
string

Filter transactions by payment run id. - If null all transactions without payment run will be returned

​
recipientIds
string

Filter transactions by their recipient ids.

​
orderField
string

Specify the field you want to order by.

​
orderDir
string

Choose between ascending and descending order.

​
order
enum<string>
default:ASC

Choose between ascending and descending order.

Available options:
ASC,
DESC
​
page
number
default:1

Specify the number of the page you want to retrieve.

Required range: x >= 1
​
take
number
default:10

Specify the number of items you want to retrieve per page.

Required range: 1 <= x <= 100

Response

200 - application/json

The response is of type object.