Skip to main content
POST
/
v1
/
transaction
Create transaction
curl --request POST \
  --url http://localhost:3001/v1/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "remittanceInformation": "<string>",
  "skontoAmount": 123,
  "skontoDate": "2023-11-07T05:31:56Z",
  "archived": true,
  "express": true,
  "currency": "EUR",
  "endToEndId": "<string>",
  "requestedExecutionDate": "2023-11-07T05:31:56Z"
}
'
{
  "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,
  "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": {
      "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,
          "invoiceExportIncludeForeignCurrencies": true,
          "allowDirectInvoiceApproval": true,
          "allowDirectPaymentRunApproval": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "autoPopulateCustomerEmailFromMetadata": true,
          "autoPopulateSupplierEmailFromMetadata": true,
          "excludedEmailDomains": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "inCaseOfLawCustomerId": "<string>",
          "cardCommonBookingTargetName": "<string>",
          "cardCommonBookingTargetAccountsPayableNumber": "<string>",
          "cardFxDifferenceLedgerAccount": "<string>"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "featureFlags": []
      },
      "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,
      "invoiceExportIncludeForeignCurrencies": true,
      "allowDirectInvoiceApproval": true,
      "allowDirectPaymentRunApproval": true,
      "customExportFormats": [
        "custom_experta"
      ],
      "autoPopulateCustomerEmailFromMetadata": true,
      "autoPopulateSupplierEmailFromMetadata": true,
      "excludedEmailDomains": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "inCaseOfLawCustomerId": "<string>",
      "cardCommonBookingTargetName": "<string>",
      "cardCommonBookingTargetAccountsPayableNumber": "<string>",
      "cardFxDifferenceLedgerAccount": "<string>"
    },
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "featureFlags": []
  },
  "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>",
    "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,
      "invoiceExportIncludeForeignCurrencies": true,
      "allowDirectInvoiceApproval": true,
      "allowDirectPaymentRunApproval": true,
      "customExportFormats": [
        "custom_experta"
      ],
      "autoPopulateCustomerEmailFromMetadata": true,
      "autoPopulateSupplierEmailFromMetadata": true,
      "excludedEmailDomains": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "inCaseOfLawCustomerId": "<string>",
      "cardCommonBookingTargetName": "<string>",
      "cardCommonBookingTargetAccountsPayableNumber": "<string>",
      "cardFxDifferenceLedgerAccount": "<string>"
    },
    "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"
    },
    "transactions": "<unknown>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "apBalance": {
      "openInvoiceAmount": 123,
      "approvedOpenCreditNoteAmount": 123,
      "manualCreditAmount": 123,
      "totalAvailableCredit": 123,
      "netPayableAmount": 123,
      "remainingCreditBalance": 123,
      "scheduledBankTransferAmount": 123,
      "remainingToScheduleAmount": 123,
      "unapprovedCreditNoteAmount": 123,
      "appliedInvoiceCreditAmount": 123,
      "balancesByCurrency": [
        {
          "approvedOpenCreditNoteAmount": 123,
          "manualCreditAmount": 123,
          "totalAvailableCredit": 123,
          "appliedInvoiceCreditAmount": 123,
          "remainingCreditBalance": 123
        }
      ]
    }
  },
  "invoice": {
    "id": "<string>",
    "invoiceNumber": "<string>",
    "status": "<string>",
    "totalAmount": 123,
    "dueDate": "2023-11-07T05:31:56Z",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "currency": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
number
required

The amount of the transaction.

​
remittanceInformation
string

The remittance information of the transaction.

​
skontoAmount
number

The amount of the skonto.

​
skontoDate
string<date-time>

The date of the skonto.

​
archived
boolean

Whether the transaction is archived.

​
express
boolean

Whether the transaction is an instant/express payment.

​
currency
enum<string>
default:EUR

The currency of the transaction.

Available options:
EUR,
USD,
GBP,
JPY,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
SEK,
KRW,
SGD,
NOK,
MXN,
INR,
BRL,
RUB,
ZAR,
TRY,
AED,
THB,
DKK,
HUF,
PLN,
TWD,
SAR,
MYR,
IDR
​
endToEndId
string

End to end Id of the transaction. Created from uuid if not found on upload / creation.

​
requestedExecutionDate
string<date-time>

The requested execution date of the transaction.

​
creditor
object

The creditor of the transaction.

​
debitor
object

The debitor of the transaction.

Response

201 - application/json

Successfully created transaction

​
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.

​
express
boolean

Determines if the transaction should be processed as an instant or urgent payment.

​
currency
enum<string>

The currency of the transaction.

Available options:
EUR,
USD,
GBP,
JPY,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
SEK,
KRW,
SGD,
NOK,
MXN,
INR,
BRL,
RUB,
ZAR,
TRY,
AED,
THB,
DKK,
HUF,
PLN,
TWD,
SAR,
MYR,
IDR
​
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

​
counterparty
object

The counterparty of the transaction.

​
invoice
object

The invoice associated with the transaction.