Skip to main content
GET
/
v1
/
transaction
/
{id}
Get transaction
curl --request GET \
  --url http://localhost:3001/v1/transaction/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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>",
          "country": "<string>",
          "vatNumber": "<string>",
          "featureFlags": [
            {
              "id": "<any>",
              "createdAt": "<any>",
              "updatedAt": "<any>",
              "featureName": "<any>",
              "isEnabled": "<any>"
            }
          ]
        }
      }
    },
    "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,
      "organization": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "featureName": "<any>",
            "isEnabled": "<any>"
          }
        ]
      }
    }
  },
  "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>",
      "country": "<string>",
      "vatNumber": "<string>",
      "featureFlags": [
        {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "featureName": "<any>",
          "isEnabled": "<any>"
        }
      ]
    }
  },
  "paymentRun": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdById": "<string>",
    "createdByName": "<string>",
    "organizationId": "<string>",
    "sumAmount": 123,
    "sumAmountWithSkonto": 123,
    "sumBookedAmount": 123,
    "transactionCount": 123
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Transaction ID

Response

200 - application/json
id
string

The unique identifier of the entity.

createdAt
string<date-time>

The date and time the entity was created.

updatedAt
string<date-time>

The date and time the entity was last updated.

amount
number

The amount of the transaction.

remittanceInformation
string

The remittance information of the transaction.

requestedExecutionDate
string<date-time>

The requested execution date of the transaction.

skontoAmount
number

The amount of the skonto.

skontoDate
string<date-time>

The date of the skonto.

ignoreSkontoDeadline
boolean

Determines if the skonto deadline should be ignored.

creditor
object

The creditor of the transaction.

debitor
object

The debitor of the transaction.

analysis
object

The analysis of the transaction.

archived
boolean

Determines if the transaction has been archived.

archivedDate
string<date-time>

The date and time the transaction was archived.

archivedByUser
object

The user that archived the transaction.

paymentRun
object

The payment run the transaction is assigned to