Skip to main content
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,
      "express": true,
      "currency": "EUR",
      "creditor": {
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "debitor": {
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "analysis": {
        "analysisRules": {
          "type": "AMOUNT_DEVIATION",
          "severity": "NORMAL",
          "markedOk": true,
          "markedOkReason": "<string>",
          "markedOkDate": "2023-11-07T05:31:56Z",
          "value": "<string>",
          "markedOkUser": {
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true,
            "organization": {
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "country": "<string>",
              "vatNumber": "<string>",
              "featureFlags": [
                {
                  "featureName": "<string>",
                  "isEnabled": true,
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "baseCurrency": "EUR",
              "paymentRunBatchBooking": true,
              "paymentRunVerificationOfPayee": true,
              "customExportFormats": [
                "custom_experta"
              ],
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "customRules": {
          "name": "<string>",
          "description": "<string>",
          "rule": "<string>",
          "twoFactorCheck": true,
          "accountCheck": true,
          "deleted": true,
          "active": true,
          "organization": {
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "country": "<string>",
            "vatNumber": "<string>",
            "featureFlags": [
              {
                "featureName": "<string>",
                "isEnabled": true,
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "baseCurrency": "EUR",
            "paymentRunBatchBooking": true,
            "paymentRunVerificationOfPayee": true,
            "customExportFormats": [
              "custom_experta"
            ],
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "archived": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "archivedByUser": {
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "country": "<string>",
          "vatNumber": "<string>",
          "featureFlags": [
            {
              "featureName": "<string>",
              "isEnabled": true,
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "baseCurrency": "EUR",
          "paymentRunBatchBooking": true,
          "paymentRunVerificationOfPayee": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "paymentRun": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "createdById": "<string>",
        "createdByName": "<string>",
        "organizationId": "<string>",
        "sumAmount": 123,
        "sumAmountWithSkonto": 123,
        "sumBookedAmount": 123,
        "transactionCount": 123,
        "batchBooking": true
      },
      "counterparty": {
        "email": "<string>",
        "name": "<string>",
        "markedTrusted": true,
        "markedTrustedDate": "2023-11-07T05:31:56Z",
        "markedTrustedUser": {
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "country": "<string>",
            "vatNumber": "<string>",
            "featureFlags": [
              {
                "featureName": "<string>",
                "isEnabled": true,
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "baseCurrency": "EUR",
            "paymentRunBatchBooking": true,
            "paymentRunVerificationOfPayee": true,
            "customExportFormats": [
              "custom_experta"
            ],
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "description": "<string>",
        "vat": "<string>",
        "accountsPayableNumber": "22 0391919",
        "street": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "paymentTermsDays": 123,
        "skontoPercentage": 123,
        "skontoDays": 123,
        "organization": {
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "country": "<string>",
          "vatNumber": "<string>",
          "featureFlags": [
            {
              "featureName": "<string>",
              "isEnabled": true,
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "baseCurrency": "EUR",
          "paymentRunBatchBooking": true,
          "paymentRunVerificationOfPayee": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "bankAccount": {
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "bankAccountVerification": {
          "bankAccount": {
            "name": "<string>",
            "iban": "<string>",
            "bic": "<string>",
            "countryCode": "<string>",
            "address": "<string>",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "paymentProvider": "<string>",
          "status": "VALID",
          "initializedAt": "2023-11-07T05:31:56Z",
          "mailTrackings": {
            "version": 123,
            "type": "ONBOARDING",
            "status": "ACCEPTED",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "fullName": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "transactions": [
          "<string>"
        ],
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "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<date-time>

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

​
paymentRunIds
string

Filter transactions by payment run ids (comma separated array).

​
counterpartyIds
string

Filter transactions by their counterparty 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
​
data
object[]
required

Paginated items.

​
meta
object
required

Additional information about the page.