Payment Plan

Manage VARIO Cloud payment plans for open items: modify terms, convert invoices to payment plans, recalculate plans, and start payment plan runs.

Offene Posten - Zahlungspläne

put

Ändert einen Zahlungsplan

Path parameters

openItemIdinteger · int64Required

Body

paymentPlanTypestring · enumOptional

Zahlungsplantyp

Possible values:

dueDateCalculationstringOptional

Fälligkeitsregel

clearDueDateCalculationbooleanOptional

Fälligkeitsregel löschen

amountnumberOptional

Betrag

clearAmountbooleanOptional

Betrag löschen

startDatestring · dateOptional

Startdatum

clearStartDatebooleanOptional

Startdatum löschen

endDatestring · dateOptional

Enddatum

clearEndDatebooleanOptional

Enddatum löschen

descriptionstringOptional

Beschreibung

activebooleanOptional

Aktiv

dueDatestring · dateOptional

Fälligkeitsdatum

clearDueDatebooleanOptional

Fälligkeitsdatum löschen

Responses

200

OK

*/*

Zahlungsplan

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

paymentPlanTypestring · enumOptional

Zahlungsplantyp

Possible values:

dueDateCalculationstringOptional

Fälligkeitsregel

amountnumberOptional

Betrag

startDatestring · dateOptional

Startdatum

endDatestring · dateOptional

Enddatum

descriptionstringOptional

Beschreibung

activebooleanOptional

Aktiv

dueDatestring · dateOptional

Fälligkeitsdatum

currencyCodestringOptional

Währung des Zahlungsplans (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des Zahlungsplans (ISO-A3)

baseAmountnumberOptional

Betrag in Basiswährung

put/erp/finance/openitems/paymentplan/{openItemId}/change_paymentplan

PUT /erp/finance/openitems/paymentplan/{openItemId}/change_paymentplan HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "paymentPlanType": "RULE",
  "dueDateCalculation": "text",
  "clearDueDateCalculation": true,
  "amount": 1,
  "clearAmount": true,
  "startDate": "2026-01-01",
  "clearStartDate": true,
  "endDate": "2026-01-01",
  "clearEndDate": true,
  "description": "text",
  "active": true,
  "dueDate": "2026-01-01",
  "clearDueDate": true,
  "manualRuleEntries": []
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "paymentPlanType": "RULE",
  "dueDateCalculation": "text",
  "amount": 1,
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "description": "text",
  "active": true,
  "dueDate": "2026-01-01",
  "manualRuleEntries": [],
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseAmount": 1
}

post

Wandelt einen Rechnungs-OP in einen Zahlungsplan um

Path parameters

openItemIdinteger · int64Required

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/paymentplan/{openItemId}/transform_to_paymentplan

POST /erp/finance/openitems/paymentplan/{openItemId}/transform_to_paymentplan HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

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

post

Triggert die Berechnung eines Zahlungsplans

Path parameters

openItemIdinteger · int64Required

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/paymentplan/{openItemId}/evaluate_paymentplan

POST /erp/finance/openitems/paymentplan/{openItemId}/evaluate_paymentplan HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

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

post

Erstellt einen Zahlungsplanlauf

Body

dueDatestring · dateRequired

Fälligkeit der nächsten Buchung

accountIdsinteger · int64[]Optional

Einschränkung auf spezielle Adressen?

startDatestring · dateOptional

Starttag des Zahlungsplanes - bis

endDatestring · dateOptional

Endtag des Zahlungsplanes - bis

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/paymentplan/start_paymentplan_run

POST /erp/finance/openitems/paymentplan/start_paymentplan_run HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "dueDate": "2026-01-01",
  "accountIds": [
    1
  ],
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
}

200

OK

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