Open Item

Manage VARIO Cloud open items via API, including due dates, payment terms, discounts, dunning, tags, balances, workflows, and transaction clearing.

the Finance OpenItem API

put

Ändert Stammdaten am Offenen Posten wie Mahnsperre

Path parameters

openItemIdinteger · int64Required

openItem Identifier

Body

manualPaymentDueDatestring · dateOptional

manuelles vorrangiges Fälligkeitsdatum

dunningBlockbooleanOptional

Mahnsperre

inReviewbooleanOptional

In Klärung setzen

purposestringOptional

Verwendungszweck

valueDatestring · dateOptional

Valutadatum

clearValueDatebooleanOptional

Valutadatum löschen

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

externalNumberstringOptional

Externe OP-Nummer

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte. Bei Änderung auf eine Wert ungleich USER_DEFINED werden die Werte wieder neu geladen.

Possible values:

paymentDays1integer · int32Optional

Fälligkeit in Tagen (Skonto 1), setzt den Ursprung der Skontowerte auf USER_DEFINED

paymentDiscount1numberOptional

Skonto 1 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED

paymentDays2integer · int32Optional

Fälligkeit in Tagen (Skonto 2), setzt den Ursprung der Skontowerte auf USER_DEFINED

paymentDiscount2numberOptional

Skonto 2 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (Ersatz für die Kontenermittlung ohne Beleg)

Possible values:

taxStatestring · enumOptional

Steuerstatus (Ersatz für die Kontenermittlung ohne Beleg)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3)

performanceDatestring · dateOptional

Leistungsdatum (Ersatz für die Kontenermittlung ohne Beleg)

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

put/erp/finance/openitems/{openItemId}/change

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

{
  "manualPaymentDueDate": "2026-01-01",
  "dunningBlock": true,
  "inReview": true,
  "basisPaymentTermRef": {
    "id": "text"
  },
  "paymentMethodRef": {
    "id": "text"
  },
  "paymentTemplateRef": {
    "id": "text"
  },
  "purpose": "text",
  "valueDate": "2026-01-01",
  "clearValueDate": true,
  "comment": "text",
  "paymentBlock": true,
  "externalNumber": "text",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text"
  },
  "performanceDate": "2026-01-01"
}

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",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "depositInvoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-01-01",
  "depositPayed": false,
  "balancedDate": "2026-01-01",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-01-01",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-01-01",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-01-01",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-01-01",
  "valueDate": "2026-01-01",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [],
  "paymentPlan": {
    "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
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "bookingAccountType": "CUSTOMER",
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "performanceDate": "2026-01-01",
  "balanced": true
}

Update Tags

put

Path parameters

openItemIdinteger · int64Required

Bodyinteger · int64[]

integer · int64[]Optional

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

put/erp/finance/openitems/additional-functions/{openItemId}/UpdateTags

PUT /erp/finance/openitems/additional-functions/{openItemId}/UpdateTags HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

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",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "depositInvoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-01-01",
  "depositPayed": false,
  "balancedDate": "2026-01-01",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-01-01",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-01-01",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-01-01",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-01-01",
  "valueDate": "2026-01-01",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [],
  "paymentPlan": {
    "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
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "bookingAccountType": "CUSTOMER",
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "performanceDate": "2026-01-01",
  "balanced": true
}

get

Path parameters

accountIdinteger · int64Required

account identifier

Responses

200

OK

*/*

objectOptional

get/erp/finance/openitems/account/{accountId}/print

GET /erp/finance/openitems/account/{accountId}/print HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{}

put

Path parameters

accountIdinteger · int64Required

account identifier

Body

exportFormatstring · enumOptional

output-format für mail/file-export

Possible values:

exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

OutputReportGroup Identifier (optional), sonst Default-Group des Moduls

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Default: false

Responses

200

OK

objectOptional

put/erp/finance/openitems/account/{accountId}/print

PUT /erp/finance/openitems/account/{accountId}/print HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "exportFormat": "PDF",
  "exportFilename": "text",
  "mailRecipients": [],
  "outputType": "text",
  "groupIdentifier": "text",
  "published": false
}

200

OK

{}

post

Gibt den Skontobetrag und die Gültigkeit des Skonto für ein angegebenes Datum zurück

Path parameters

openItemidinteger · int64Required

discountDatestring · dateRequired

Responses

200

OK

*/*

discountDatestring · dateOptional

Skontodatum

discountAmountnumberOptional

Skontobetrag

isApplicablebooleanOptional

Skonto ist anwandbar

post/erp/finance/openitems/{openItemid}/calculate_discount/{discountDate}

POST /erp/finance/openitems/{openItemid}/calculate_discount/{discountDate} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "discountDate": "2026-01-01",
  "discountAmount": 1,
  "isApplicable": true
}

post

weist eine Transaction einem anderen OP zu

Path parameters

openItemIdinteger · int64Required

openItemRecordIdinteger · int64Required

Body

targetOpenItemIdinteger · int64Optional

neuer OP dem die Transaction zugewiesen werden soll

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

post/erp/finance/openitems/{openItemId}/{openItemRecordId}/reassignTransaction

POST /erp/finance/openitems/{openItemId}/{openItemRecordId}/reassignTransaction HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "targetOpenItemId": 1
}

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",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "depositInvoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-01-01",
  "depositPayed": false,
  "balancedDate": "2026-01-01",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-01-01",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-01-01",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-01-01",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-01-01",
  "valueDate": "2026-01-01",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [],
  "paymentPlan": {
    "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
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "bookingAccountType": "CUSTOMER",
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "performanceDate": "2026-01-01",
  "balanced": true
}

post

Sperrt einen OP zur Bearbeitung

Path parameters

openItemIdinteger · int64Required

Responses

200

OK

*/*

keystring · min: 1Required

tokeninteger · int64Required

userIdinteger · int64Optional

lockedBySystembooleanOptional

validUntilstring · date-timeOptional

idstringRead-onlyOptional

Unique identifier of the Object

Example: 1

post/erp/finance/openitems/{openItemId}/startUpdate

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

200

OK

{
  "key": "text",
  "token": 1,
  "userId": 1,
  "lockedBySystem": true,
  "validUntil": "2026-01-01T00:00:00.000Z",
  "id": "1"
}

post

Gibt einen OP wieder frei

Path parameters

openItemIdinteger · int64Required

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/{openItemId}/cancelUpdate

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

200

OK

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

post

storniert eine Zahlung oder eine Verrechnung

Path parameters

idinteger · int64Required

recordIdinteger · int64Required

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/{id}/revert/{recordId}

POST /erp/finance/openitems/{id}/revert/{recordId} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

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

get

Gibt das Saldo nach Verrechnung zurück

Path parameters

firstOpenItemIdinteger · int64Required

secondOpenItemIdinteger · int64Required

Responses

200

OK

*/*

qualifierstring · enumOptional

Forderung oder Verbindlichkeit

Possible values:

amountnumberOptional

saldo

get/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}

GET /erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "qualifier": "PAYABLE",
  "amount": 1
}

post

Verrechnet zwei OPs

Path parameters

firstOpenItemIdinteger · int64Required

secondOpenItemIdinteger · int64Required

Responses

200

OK

*/*

firstOpenItemIdinteger · int64Optional

ID des ersten OPs

secondOpenItemIdinteger · int64Optional

ID des zweiten OPs

clearedAmountnumberOptional

Verrechneter Betrag

post/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}

POST /erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "firstOpenItemId": 1,
  "secondOpenItemId": 1,
  "clearedAmount": 1
}

post

Path parameters

openItemIDinteger · int64Required

Body

grantDeliveryApprovalbooleanOptional

Lieferfreigabe erteilen

newBalancenumberOptional

neuer Saldo

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

post/erp/finance/openitems/recalculate/{openItemID}

POST /erp/finance/openitems/recalculate/{openItemID} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "grantDeliveryApproval": true,
  "newBalance": 1
}

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",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "depositInvoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-01-01",
  "depositPayed": false,
  "balancedDate": "2026-01-01",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-01-01",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-01-01",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-01-01",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-01-01",
  "valueDate": "2026-01-01",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [],
  "paymentPlan": {
    "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
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "bookingAccountType": "CUSTOMER",
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "performanceDate": "2026-01-01",
  "balanced": true
}

post

Creates an open item from a bank transaction

Body

transactionIdinteger · int64Optional

ID of the bank transaction

accountIdinteger · int64Optional

ID of the account the new open item is assigned to

paymentMethodIdinteger · int64Optional

ID of the payment method to set on the open item

bookingAccountTypestring · enumRequired

Booking account type: CUSTOMER (debtor) or SUPPLIER (creditor)

Possible values:

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/finance/openitems/create_op_from_transaction

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

{
  "transactionId": 1,
  "accountId": 1,
  "paymentMethodId": 1,
  "bookingAccountType": "CUSTOMER"
}

200

OK

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

get

Vorschau: verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) ohne zu buchen und meldet zurück, was verrechnet würde

Path parameters

accountIdinteger · int64Required

account identifier

Responses

200

OK

*/*

previewbooleanOptional

true = nur Vorschau (es wurde nicht gebucht), false = tatsächlich verrechnet

Default: false

totalOffsetAmountnumberOptional

Gesamtsumme der verrechneten Beträge

get/erp/finance/openitems/account/{accountId}/offset_credit_notes

GET /erp/finance/openitems/account/{accountId}/offset_credit_notes HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "preview": false,
  "totalOffsetAmount": 1,
  "lines": []
}

post

Verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) und meldet zurück, was verrechnet wurde

Path parameters

accountIdinteger · int64Required

account identifier

Responses

200

OK

*/*

previewbooleanOptional

true = nur Vorschau (es wurde nicht gebucht), false = tatsächlich verrechnet

Default: false

totalOffsetAmountnumberOptional

Gesamtsumme der verrechneten Beträge

post/erp/finance/openitems/account/{accountId}/offset_credit_notes

POST /erp/finance/openitems/account/{accountId}/offset_credit_notes HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "preview": false,
  "totalOffsetAmount": 1,
  "lines": []
}

Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

string · enumOptional

Status einer Workflow-Instanz

Possible values:

404

Es existiert noch keine Workflow-Instanz

*/*

get/erp/finance/openitems/{refId}/workflow-state

GET /erp/finance/openitems/{refId}/workflow-state HTTP/1.1
Host: api.example.com
Accept: */*

CREATED

Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

Adhoc Preset

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT

Default: QUERYPossible values:

templateIdstring · min: 1Required

template dem dieser filter zugeordnet worden ist.

templateGroupKeystring · min: 1Required

templateGroupKey dem dieser filter zugeordnet worden ist.

labelstring · min: 1Required

label für diesen filter

queryStatementstringOptional

bei mode == STATEMENT, das vql-query

forWorkflowbooleanRequired

für Workflows vorgesehen

Default: false

outputReportGroupIdentifierstringOptional

Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird

get/erp/finance/openitems/{refId}/workflow-instances-preset

GET /erp/finance/openitems/{refId}/workflow-instances-preset HTTP/1.1
Host: api.example.com
Accept: */*

200

Workflow-Instanz gefunden

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "QUERY",
  "templateId": "text",
  "templateGroupKey": "text",
  "label": "text",
  "uiPayload": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "missingNode": true,
    "nodeType": "ARRAY",
    "valueNode": true,
    "container": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "string": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "number": true,
    "embeddedValue": true
  },
  "variables": [],
  "queryStatement": "text",
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "results": [],
  "sortAndOrders": [],
  "pageable": {
    "limit": 1
  },
  "option": {
    "distinctResult": true
  },
  "transformations": [],
  "arithmeticQueryTerms": [],
  "definition": [
    {
      "_type": "text",
      "definition": "[Circular Reference]",
      "value": "[Circular Reference]"
    }
  ],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  },
  "forWorkflow": false,
  "outputReportGroupIdentifier": "text",
  "userOptions": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "pinned": false
  }
}

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

statestring · enumOptional

Status einer Workflow-Instanz

Possible values:

404

Es existiert noch keine Workflow-Instanz

*/*

get/erp/finance/openitems/{refId}/latest-workflow-instance

GET /erp/finance/openitems/{refId}/latest-workflow-instance 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",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [],
  "logEntries": []
}

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

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

404

Resource with given ID was not found

*/*

get/erp/finance/openitems/{id}

GET /erp/finance/openitems/{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",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "depositInvoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-01-01",
  "depositPayed": false,
  "balancedDate": "2026-01-01",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-01-01",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-01-01",
  "paymentDiscountOrigin": "FROM_PAYMENT_TERM",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-01-01",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-01-01",
  "valueDate": "2026-01-01",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [],
  "paymentPlan": {
    "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
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "bookingAccountType": "CUSTOMER",
  "taxPerformanceLocation": "DOMESTIC",
  "taxState": "TAX_FREE",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "taxRateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "performanceDate": "2026-01-01",
  "balanced": true
}

get

select the OpenItems with different parameter

Query parameters

idinteger · int64Optional

balancedbooleanOptional

documentIdinteger · int64Optional

accountIdinteger · int64Optional

documentQualifierstring · enumOptionalPossible values:

bookingRecordIdinteger · int64Optional

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false

balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:

balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:

qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:

fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:

refundTypestring · enumOptional

how should a refund be done?

Possible values:

dunningBlockbooleanOptional

Mahnsperre

Default: false

paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:

dunningStatestring · enumOptional

Der Mahnzustand

Possible values:

dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false

valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false

canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false

currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false

bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:

taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional

get/erp/finance/openitems/selector

GET /erp/finance/openitems/selector HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

[]