Bank Payment Run

Manage bank payment runs in VARIO Cloud, including creation, processing, cancellation, retrieval, open items, execution dates, and bank accounts.

Zahlungsvorschlag

post

Erzeugt einen Zahlungsvorschlag-Job aus konkreten OP-IDs und/oder einer CUnit-Selektion

Body

Request zur Erstellung eines BankPaymentRun aus konkreten OP-IDs und/oder einer CUnit-Selektion

runTypestring · enumOptional

Art des Zahlungslaufs: Lastschrift (Debitoren) oder Überweisung (Kreditoren)

Possible values:

openItemIdsToProcessinteger · int64[]Optional

Konkrete IDs der OffenenPosten, die in den Run aufgenommen werden sollen

openItemIdsToIgnoreinteger · int64[]Optional

IDs der OffenenPosten, die ausgeschlossen werden sollen (greift sowohl auf direkte IDs als auch auf Selektions-Treffer)

paymentTemplateIdinteger · int64Optional

Zahlungsvorlage

executionDateTimestring · date-timeOptional

Manuell gesetzter Ausführungs-Zeitpunkt

bankAccountIdinteger · int64Required

ID des Bankkontos, dem der Vorschlag zugeordnet wird

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/payment_runs

POST /erp/bank/payment_runs HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "runType": "DIRECT_DEBIT",
  "openItemIdsToProcess": [
    1
  ],
  "openItemIdsToIgnore": [
    1
  ],
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "variables": {
    "variableSubstitutions": []
  },
  "paymentTemplateId": 1,
  "executionDateTime": "2026-01-01T00:00:00.000Z",
  "bankAccountId": 1
}

200

OK

{
  "context": "text",
  "messageValue": "text"
}

post

Verarbeitet den Zahlungsvorschlag — schaltet alle nicht-ERRONEOUS Sammler für den Versand frei

Path parameters

runIdinteger · int64Required

Responses

200

OK

*/*

openItemCountinteger · int32Optional

Anzahl der Offenen Posten

totalAmountnumberOptional

Gesamtbetrag der Offenen Posten

post/erp/bank/payment_runs/{runId}/process

POST /erp/bank/payment_runs/{runId}/process HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "openItemCount": 1,
  "totalAmount": 1,
  "responseDetails": []
}

post

Storniert den Zahlungsvorschlag

Path parameters

runIdinteger · int64Required

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/payment_runs/{runId}/dissolve

POST /erp/bank/payment_runs/{runId}/dissolve HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringOptional

Beschreibung des Vorschlags

numberstringOptional

Vorschlags-Nummer

manualExecutionDateTimestring · date-timeOptional

Manuell gesetzter Ausführungs-Zeitpunkt

processedbooleanRead-onlyOptional

Wurde dieser Vorschlag verarbeitet

canceledbooleanRead-onlyOptional

Wurde dieser Vorschlag storniert

processedAtstring · date-timeRead-onlyOptional

Verbuchungsdatum

404

Resource with given ID was not found

*/*

get/erp/bank/payment_runs/{id}

GET /erp/bank/payment_runs/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "number": "text",
  "manualExecutionDateTime": "2026-01-01T00:00:00.000Z",
  "processed": true,
  "canceled": true,
  "processedAt": "2026-01-01T00:00:00.000Z",
  "bankAccount": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}