Document
Manage ERP documents, including creation, updates, state transitions, line items, validation, printing, locking, picking, shipments, and workflows.
the Document API
Body
transitionIdstringRequired
transition id
targetTypeIdinteger · int64Optional
Ggf. die ID der Ziel-Belegart
Responses
200
OK
*/*
post/erp/documents
POST /erp/documents HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 2222
{
"transitionId": "text",
"targetTypeId": 1,
"parameters": [],
"document": {
"accountId": "text",
"salesChannelId": "text",
"externalId": "text",
"externalNumber": "text",
"billingType": "GROSS",
"calculationMode": "HORIZONTAL",
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"supplierAccountId": 1,
"lines": [],
"targetDocumentType": {
"version": "text",
"info": {},
"id": "text",
"labels": [],
"category": "CUSTOMER_OFFER",
"showForManualDocumentCreation": true,
"defaultTypeOfCategory": false,
"active": true,
"shelfDocumentTypeRef": {
"id": "text"
},
"sequencerConfiguration": {
"version": "text",
"info": {},
"id": "text",
"configurationDetail": {
"type": "NON_POOLED_SEQUENCES",
"assignmentMode": "MANUAL",
"length": 1,
"padChar": "text",
"expression": "text",
"postExpression": "text",
"initialValue": 1,
"numberUnique": true
},
"alternativeConfiguration": {
"id": "text"
},
"active": true
},
"requiresBusinessRelationship": true,
"publishingPolicy": "AUTOMATIC",
"sortOrder": 1
},
"incomingGoodsPickTrolleyId": 1,
"incomingGoodsStorageBinId": 1,
"priceModifiers": [],
"posRegisterId": 1,
"cashDrawerId": 1,
"depositPaymentAmount": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posRegisterRef": {
"id": "text"
},
"cashDrawerRef": {
"id": "text"
},
"cashJournalRef": {
"id": "text"
},
"fiscalizationBackendRef": {
"id": "text"
},
"tssSignature": {},
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"posPayments": [],
"texts": [],
"custom": {
"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
},
"einvoice": true
}
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Body
Responses
200
OK
*/*
put/erp/documents
PUT /erp/documents HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 6813
{
"document": {
"version": "text",
"info": {},
"id": "text",
"number": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"accountId": "text",
"billingAccountRef": {
"id": "text"
},
"salesChannelRef": {
"id": "text"
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"billingType": "GROSS",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text"
},
"paymentTermRef": {
"id": "text",
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text"
},
"depositPaymentAmount": 1,
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text"
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"priceModifiers": [],
"defaultAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"billingAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"deliveryAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text"
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text"
},
"defaultStorageRef": {
"id": "text"
},
"locationRef": {
"id": "text"
},
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posRegisterRef": {
"id": "text"
},
"cashDrawerRef": {
"id": "text"
},
"cashJournalRef": {
"id": "text"
},
"fiscalizationBackendRef": {
"id": "text"
},
"tssSignature": {},
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text"
},
"workbenchStorageRef": {
"id": "text"
},
"workbenchStorageBinRef": {
"id": "text"
},
"qualityAssuranceStorageRef": {
"id": "text"
},
"qualityAssuranceStorageBinRef": {
"id": "text"
},
"defectiveStorageRef": {
"id": "text"
},
"defectiveStorageBinRef": {
"id": "text"
},
"targetStorageRef": {
"id": "text"
},
"targetStorageBinRef": {
"id": "text"
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"additionalInfo": {
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false
},
"parameters": []
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
idinteger · int64Required
document identifier
Query parameters
languageCodestringRequired
Responses
200
OK
*/*
idstringRequired
das gleiche wie transition id für das UI
transitionIdstringRequired
transition id
transitionLabelstringRead-onlyOptional
label of this transition
stateDefinitionstringRead-onlyOptional
state definition of the target state
typeCategorystring · enumRead-onlyOptionalPossible values:
Dokumenttypen
typeIdstringRead-onlyOptional
document-type-id des ziels
typeKeystringRead-onlyOptional
document-type-key des ziels
typeLabelstringRead-onlyOptional
type-label
isDefaultTypeForCategorybooleanRead-onlyOptional
document-type ist Default für die Kategorie
targetStatestringRead-onlyOptional
Der Ziel-Status der Transition
sortOrderinteger · int32Read-onlyOptional
Sortier-Reihenfolge
get/erp/documents/{id}/states
GET /erp/documents/{id}/states?languageCode=text HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
document identifier
Body
transitionIdstringRequired
transition id
Responses
200
OK
*/*
put/erp/documents/{id}/states
PUT /erp/documents/{id}/states HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 2205
{
"transitionId": "text",
"parameters": [],
"document": {
"accountId": "text",
"salesChannelId": "text",
"externalId": "text",
"externalNumber": "text",
"billingType": "GROSS",
"calculationMode": "HORIZONTAL",
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"supplierAccountId": 1,
"lines": [],
"targetDocumentType": {
"version": "text",
"info": {},
"id": "text",
"labels": [],
"category": "CUSTOMER_OFFER",
"showForManualDocumentCreation": true,
"defaultTypeOfCategory": false,
"active": true,
"shelfDocumentTypeRef": {
"id": "text"
},
"sequencerConfiguration": {
"version": "text",
"info": {},
"id": "text",
"configurationDetail": {
"type": "NON_POOLED_SEQUENCES",
"assignmentMode": "MANUAL",
"length": 1,
"padChar": "text",
"expression": "text",
"postExpression": "text",
"initialValue": 1,
"numberUnique": true
},
"alternativeConfiguration": {
"id": "text"
},
"active": true
},
"requiresBusinessRelationship": true,
"publishingPolicy": "AUTOMATIC",
"sortOrder": 1
},
"incomingGoodsPickTrolleyId": 1,
"incomingGoodsStorageBinId": 1,
"priceModifiers": [],
"posRegisterId": 1,
"cashDrawerId": 1,
"depositPaymentAmount": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posRegisterRef": {
"id": "text"
},
"cashDrawerRef": {
"id": "text"
},
"cashJournalRef": {
"id": "text"
},
"fiscalizationBackendRef": {
"id": "text"
},
"tssSignature": {},
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"posPayments": [],
"texts": [],
"custom": {
"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
},
"einvoice": true
}
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}put
Path parameters
idinteger · int64Required
ID des Belegs
protocolIdinteger · int64Required
ID des Eintrags im Belegprotokoll
Body
Request zur Anlage eines manuellen Eintrags ins Belegprotokoll
customMessagestring · min: 1Required
Text für das Belegprotokoll
Responses
200
OK
*/*
Belegprotokoll
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentTypeIdinteger · int64Read-onlyOptional
Typ des Dokuments zu diesem Protokolleintrag
documentNumberstringRead-onlyOptional
Nummer des Dokuments zu diesem Protokolleintrag
typestring · enumRequiredPossible values:
Eintragsarten im DocumentProtocol
customMessagestringOptional
Text dieses Protokolleintrags
userNamestringRead-onlyOptional
Benutzer von dem der Eintrag angelegt wurde
timestampstring · date-timeOptional
Zeitstempel dieses Protokolleintrags
put/erp/documents/{id}/protocol/{protocolId}
PUT /erp/documents/{id}/protocol/{protocolId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"customMessage": "text"
}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",
"documentTypeId": 1,
"documentTypeLabels": [],
"documentNumber": "text",
"type": "MANUAL",
"customMessage": "text",
"localizeableMessage": {
"messageCode": "text",
"messageParameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"formattedMessage": "text"
},
"userName": "text",
"timestamp": "2026-01-01T00:00:00.000Z"
}get
Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
objectOptional
get/erp/documents/{id}/print
GET /erp/documents/{id}/print HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{}put
Path parameters
idinteger · int64Required
document identifier
Body
exportFormatstring · enumOptionalPossible values:
output-format für mail/file-export
exportFilenamestringOptional
filename (ohne extension) bei einem file-export
outputTypestringOptional
outputType
groupIdentifierstringOptional
OutputReportGroup Identifier (optional), sonst Default-Group des Moduls
publishedbooleanOptionalDefault:
sollen nur bereits veröffentlichte Dokumente beachtet werden?
falseResponses
200
successful operation
objectOptional
405
printing not allowed for the current document state
put/erp/documents/{id}/print
PUT /erp/documents/{id}/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
}{}Path parameters
idinteger · int64Required
ID der gesperrten Resource
lockTokeninteger · int64Required
Token der zu verlängernden Sperre
Query parameters
leasePeriodinteger · int64Required
Optionale Lease-Dauer in Sekunden
Responses
200
OK
*/*
keystring · min: 1Required
tokeninteger · int64Required
userIdinteger · int64Optional
lockedBySystembooleanOptional
validUntilstring · date-timeOptional
idstringRead-onlyOptionalExample:
Unique identifier of the Object
1put/erp/documents/{id}/leasable-lock/{lockToken}
PUT /erp/documents/{id}/leasable-lock/{lockToken}?leasePeriod=1 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"
}Path parameters
idinteger · int64Required
ID der gesperrten Resource
lockTokeninteger · int64Required
Token der freizugebenden Sperre
Responses
200
OK
No content
delete/erp/documents/{id}/leasable-lock/{lockToken}
DELETE /erp/documents/{id}/leasable-lock/{lockToken} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
No content
Path parameters
documentIdinteger · int64Required
parcelIdinteger · int64Required
Body
Pakete zu Belegen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Optional
Position des Pakets
weightnumberOptional
Gewicht des Pakets
lengthnumberOptional
Länge
widthnumberOptional
Breite
heightnumberOptional
Höhe
trackingNumberstringRead-onlyOptional
Trackingnummer
Responses
200
OK
*/*
Pakete zu Belegen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Optional
Position des Pakets
weightnumberOptional
Gewicht des Pakets
lengthnumberOptional
Länge
widthnumberOptional
Breite
heightnumberOptional
Höhe
trackingNumberstringRead-onlyOptional
Trackingnummer
put/erp/documents/{documentId}/parcel/{parcelId}
PUT /erp/documents/{documentId}/parcel/{parcelId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 347
{
"version": "text",
"info": {},
"id": "text",
"documentRef": {
"id": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text"
},
"position": 1,
"weight": 1,
"weightUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"length": 1,
"width": 1,
"height": 1,
"sizeUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"lines": []
}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",
"documentRef": {
"id": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text"
},
"position": 1,
"weight": 1,
"weightUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"length": 1,
"width": 1,
"height": 1,
"sizeUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"trackingNumber": "text",
"lines": []
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Body
Responses
200
OK
*/*
put/erp/documents/document/{documentId}/line/{lineId}
PUT /erp/documents/document/{documentId}/line/{lineId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 5466
{
"documentLine": {
"version": "text",
"info": {},
"id": "text",
"articleId": "text",
"lineType": "ARTICLE_LINE",
"productType": "WITH_STOCK",
"number": "text",
"name": "text",
"description": "text",
"unitType": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"price": 1,
"priceUnit": 1,
"priceSelectionCriteria": {
"qualifier": "SALES",
"articleIds": [
1
],
"selectOnlyDefaultPrice": false,
"accountIds": [
1
],
"productGroupId": 1,
"priceGroupId": 1,
"date": "2026-01-01",
"quantity": 1,
"noteSpecialOfferPrice": true
},
"quantity": 1,
"taxSchemaRef": {
"id": "text"
},
"taxes": [],
"priceModifiers": [],
"texts": [],
"shippingCostDetail": {
"manualCosts": false,
"freeShipping": false,
"purchasePrice": 1
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"country": {
"id": 1,
"isoAlpha2": "text",
"isoAlpha3": "text"
},
"countryRegion": {
"id": "text"
},
"customsTariffNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryText": "text",
"packageOptions": "text",
"externalReferenceVds": "text",
"netWeight": 1,
"totalNetWeight": 1,
"netWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"grossWeight": 1,
"totalGrossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"capacity": 1,
"capacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"baseCapacity": 1,
"baseCapacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"sourceLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"baseLineId": 1,
"mainArticleLineRef": {
"id": "text"
},
"settledOpenItemRef": {
"id": "text"
},
"settledOpenItemBalance": 1,
"settledOpenItemPaymentDueDate": "2026-01-01",
"settledOpenItemDiscountAmount": 1,
"settledOpenItemComment": "text",
"customerOrderLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"supplierOrderLineIds": [
1
],
"storage": {
"id": "text"
},
"components": [],
"fabricationComponents": [],
"bookings": [],
"commissions": [],
"previousDecisions": {
"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
},
"calculationData": "text",
"revenueCalculation": {},
"commissionOrigin": "NOT_COMMISSIONABLE",
"cashDiscountable": true,
"discountable": true,
"commissionable": false,
"warrantyInMonths": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posLineType": "CASH_PAYMENT",
"depositExpenseTypeId": 1,
"paymentMethodId": 1,
"externalPaymentId": "text",
"externalPaymentStatus": "PENDING",
"externalPaymentErrorMessage": "text",
"paymentOperation": "PAYMENT",
"cancelledExternalPaymentId": "text"
},
"fabricationDetail": {
"version": "text",
"info": {},
"id": "text",
"serialNumbers": [],
"quantityCommitted": 1,
"quantityInQA": 1,
"quantityDefective": 1,
"quantityFinished": 1,
"custom": {
"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
}
},
"returnDetail": {
"version": "text",
"info": {},
"id": "text",
"returnCategory": "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER",
"goodsExchangeArticleRef": {
"id": "text"
},
"waitForReturnBeforeExchange": true,
"repairRequested": true,
"warrantyExchange": true,
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"replacementDeliveryTermRef": {
"id": "text"
},
"replacementDeliveryMethodRef": {
"id": "text"
},
"returnCauseRef": {
"id": "text"
},
"customerShareOnSurcharge": 1,
"customerShareOnReduction": 1
},
"financeBooking": {
"version": "text",
"info": {},
"id": "text",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
},
"custom": {
"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
},
"performanceDate": "2026-01-01",
"basePrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalLinePrice": 1,
"baseSalesValueNet": 1,
"progressInvoice": false,
"dropShippingPolicy": "ANY",
"unitGrossVolumeInCubicMeters": 1,
"convertedIntoBundleArticleRef": {
"id": "text"
},
"insertTerm": "MANUAL",
"hasAccessories": false,
"recalcLinePriceViaComponents": false,
"doPrintLabel": false,
"storageInfo": "text"
},
"additionalParameters": []
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
200
OK
*/*
delete/erp/documents/document/{documentId}/line/{lineId}
DELETE /erp/documents/document/{documentId}/line/{lineId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Body
Responses
200
OK
*/*
patch/erp/documents/document/{documentId}/line/{lineId}
PATCH /erp/documents/document/{documentId}/line/{lineId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 5448
{
"line": {
"version": "text",
"info": {},
"id": "text",
"articleId": "text",
"lineType": "ARTICLE_LINE",
"productType": "WITH_STOCK",
"number": "text",
"name": "text",
"description": "text",
"unitType": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"price": 1,
"priceUnit": 1,
"priceSelectionCriteria": {
"qualifier": "SALES",
"articleIds": [
1
],
"selectOnlyDefaultPrice": false,
"accountIds": [
1
],
"productGroupId": 1,
"priceGroupId": 1,
"date": "2026-01-01",
"quantity": 1,
"noteSpecialOfferPrice": true
},
"quantity": 1,
"taxSchemaRef": {
"id": "text"
},
"taxes": [],
"priceModifiers": [],
"texts": [],
"shippingCostDetail": {
"manualCosts": false,
"freeShipping": false,
"purchasePrice": 1
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"country": {
"id": 1,
"isoAlpha2": "text",
"isoAlpha3": "text"
},
"countryRegion": {
"id": "text"
},
"customsTariffNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryText": "text",
"packageOptions": "text",
"externalReferenceVds": "text",
"netWeight": 1,
"totalNetWeight": 1,
"netWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"grossWeight": 1,
"totalGrossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"capacity": 1,
"capacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"baseCapacity": 1,
"baseCapacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"sourceLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"baseLineId": 1,
"mainArticleLineRef": {
"id": "text"
},
"settledOpenItemRef": {
"id": "text"
},
"settledOpenItemBalance": 1,
"settledOpenItemPaymentDueDate": "2026-01-01",
"settledOpenItemDiscountAmount": 1,
"settledOpenItemComment": "text",
"customerOrderLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"supplierOrderLineIds": [
1
],
"storage": {
"id": "text"
},
"components": [],
"fabricationComponents": [],
"bookings": [],
"commissions": [],
"previousDecisions": {
"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
},
"calculationData": "text",
"revenueCalculation": {},
"commissionOrigin": "NOT_COMMISSIONABLE",
"cashDiscountable": true,
"discountable": true,
"commissionable": false,
"warrantyInMonths": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posLineType": "CASH_PAYMENT",
"depositExpenseTypeId": 1,
"paymentMethodId": 1,
"externalPaymentId": "text",
"externalPaymentStatus": "PENDING",
"externalPaymentErrorMessage": "text",
"paymentOperation": "PAYMENT",
"cancelledExternalPaymentId": "text"
},
"fabricationDetail": {
"version": "text",
"info": {},
"id": "text",
"serialNumbers": [],
"quantityCommitted": 1,
"quantityInQA": 1,
"quantityDefective": 1,
"quantityFinished": 1,
"custom": {
"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
}
},
"returnDetail": {
"version": "text",
"info": {},
"id": "text",
"returnCategory": "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER",
"goodsExchangeArticleRef": {
"id": "text"
},
"waitForReturnBeforeExchange": true,
"repairRequested": true,
"warrantyExchange": true,
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"replacementDeliveryTermRef": {
"id": "text"
},
"replacementDeliveryMethodRef": {
"id": "text"
},
"returnCauseRef": {
"id": "text"
},
"customerShareOnSurcharge": 1,
"customerShareOnReduction": 1
},
"financeBooking": {
"version": "text",
"info": {},
"id": "text",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
},
"custom": {
"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
},
"performanceDate": "2026-01-01",
"basePrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalLinePrice": 1,
"baseSalesValueNet": 1,
"progressInvoice": false,
"dropShippingPolicy": "ANY",
"unitGrossVolumeInCubicMeters": 1,
"convertedIntoBundleArticleRef": {
"id": "text"
},
"insertTerm": "MANUAL",
"hasAccessories": false,
"recalcLinePriceViaComponents": false,
"doPrintLabel": false,
"storageInfo": "text"
},
"parameters": []
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
positioninteger · int32Required
Responses
200
OK
*/*
put/erp/documents/document/{documentId}/line/{lineId}/move/{position}
PUT /erp/documents/document/{documentId}/line/{lineId}/move/{position} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
200
OK
*/*
FiBu-Buchung
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentLineIdinteger · int64Optional
Id der Dokumentzeile
ledgerNumberstringOptional
FiBu-Kontonummer
transactionKeystringOptional
Buchungsschlüssel
costCenter1stringOptional
Kostenstelle
commentstringOptional
Kommentar
descriptionstringOptional
Buchungstext
get/erp/documents/document/{documentId}/line/{lineId}/financebooking
GET /erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: api.example.com
Accept: */*
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",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Body
FiBu-Buchung
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentLineIdinteger · int64Optional
Id der Dokumentzeile
ledgerNumberstringOptional
FiBu-Kontonummer
transactionKeystringOptional
Buchungsschlüssel
costCenter1stringOptional
Kostenstelle
commentstringOptional
Kommentar
descriptionstringOptional
Buchungstext
Responses
200
OK
*/*
FiBu-Buchung
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentLineIdinteger · int64Optional
Id der Dokumentzeile
ledgerNumberstringOptional
FiBu-Kontonummer
transactionKeystringOptional
Buchungsschlüssel
costCenter1stringOptional
Kostenstelle
commentstringOptional
Kommentar
descriptionstringOptional
Buchungstext
put/erp/documents/document/{documentId}/line/{lineId}/financebooking
PUT /erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 164
{
"version": "text",
"info": {},
"id": "text",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
}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",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
}Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
200
OK
No content
delete/erp/documents/document/{documentId}/line/{lineId}/financebooking
DELETE /erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
No content
Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
taxIdentificationNumberstring · max: 255Optional
Geprüfte Ust-ID
validitystring · enumOptionalPossible values:
Gültigkeit einer Ust-ID
validatedCompanyNamestringOptional
Geprüfter Firmenname
companyNameValidationResultstring · enumOptionalPossible values:
Ergebnis der Detail-Prüfung einer Ust-ID
validatedCitystringOptional
Geprüfter Ort
cityValidationResultstring · enumOptionalPossible values:
Ergebnis der Detail-Prüfung einer Ust-ID
validatedPostalCodestringOptional
Geprüfte PLZ
postalCodeValidationResultstring · enumOptionalPossible values:
Ergebnis der Detail-Prüfung einer Ust-ID
validatedStreetstringOptional
Geprüfte Straße
streetValidationResultstring · enumOptionalPossible values:
Ergebnis der Detail-Prüfung einer Ust-ID
usedApistring · enumOptionalPossible values:
USt-ID Prüfverfahren
apiResultCodestringOptional
Ergebnis-Code der Prüfung
apiResultMessagestringOptional
Ergebnis-Meldung der Prüfung (falls vorhanden
post/erp/documents/{id}/verifyTaxId
POST /erp/documents/{id}/verifyTaxId HTTP/1.1
Host: api.example.com
Accept: */*
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",
"accountAddressRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentAddressRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"taxIdentificationNumber": "text",
"validity": "NOT_YET_VALIDATED",
"validatedCompanyName": "text",
"companyNameValidationResult": "VALID",
"validatedCity": "text",
"cityValidationResult": "VALID",
"validatedPostalCode": "text",
"postalCodeValidationResult": "VALID",
"validatedStreet": "text",
"streetValidationResult": "VALID",
"usedApi": "NONE",
"apiResultCode": "text",
"apiResultMessage": "text"
}Path parameters
idinteger · int64Required
document identifier
Query parameters
languageCodestringRequired
Responses
200
OK
*/*
idstringRequired
das gleiche wie transition id für das UI
transitionIdstringRequired
transition id
transitionLabelstringRead-onlyOptional
label of this transition
stateDefinitionstringRead-onlyOptional
state definition of the target state
typeCategorystring · enumRead-onlyOptionalPossible values:
Dokumenttypen
typeIdstringRead-onlyOptional
document-type-id des ziels
typeKeystringRead-onlyOptional
document-type-key des ziels
typeLabelstringRead-onlyOptional
type-label
isDefaultTypeForCategorybooleanRead-onlyOptional
document-type ist Default für die Kategorie
targetStatestringRead-onlyOptional
Der Ziel-Status der Transition
sortOrderinteger · int32Read-onlyOptional
Sortier-Reihenfolge
get/erp/documents/{id}/types
GET /erp/documents/{id}/types?languageCode=text HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
the document identifier used as spec for the new document
Body
transitionIdstringRequired
transition id
targetTypeIdinteger · int64Optional
Ggf. die ID der Ziel-Belegart
Responses
200
OK
*/*
post/erp/documents/{id}/types
POST /erp/documents/{id}/types HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 2222
{
"transitionId": "text",
"targetTypeId": 1,
"parameters": [],
"document": {
"accountId": "text",
"salesChannelId": "text",
"externalId": "text",
"externalNumber": "text",
"billingType": "GROSS",
"calculationMode": "HORIZONTAL",
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"supplierAccountId": 1,
"lines": [],
"targetDocumentType": {
"version": "text",
"info": {},
"id": "text",
"labels": [],
"category": "CUSTOMER_OFFER",
"showForManualDocumentCreation": true,
"defaultTypeOfCategory": false,
"active": true,
"shelfDocumentTypeRef": {
"id": "text"
},
"sequencerConfiguration": {
"version": "text",
"info": {},
"id": "text",
"configurationDetail": {
"type": "NON_POOLED_SEQUENCES",
"assignmentMode": "MANUAL",
"length": 1,
"padChar": "text",
"expression": "text",
"postExpression": "text",
"initialValue": 1,
"numberUnique": true
},
"alternativeConfiguration": {
"id": "text"
},
"active": true
},
"requiresBusinessRelationship": true,
"publishingPolicy": "AUTOMATIC",
"sortOrder": 1
},
"incomingGoodsPickTrolleyId": 1,
"incomingGoodsStorageBinId": 1,
"priceModifiers": [],
"posRegisterId": 1,
"cashDrawerId": 1,
"depositPaymentAmount": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posRegisterRef": {
"id": "text"
},
"cashDrawerRef": {
"id": "text"
},
"cashJournalRef": {
"id": "text"
},
"fiscalizationBackendRef": {
"id": "text"
},
"tssSignature": {},
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"posPayments": [],
"texts": [],
"custom": {
"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
},
"einvoice": true
}
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
shipmentIdinteger · int64Optional
description/delivery Text of this order (internal vds description)
post/erp/documents/{id}/shipment
POST /erp/documents/{id}/shipment HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"shipmentId": 1
}Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
Belegprotokoll
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentTypeIdinteger · int64Read-onlyOptional
Typ des Dokuments zu diesem Protokolleintrag
documentNumberstringRead-onlyOptional
Nummer des Dokuments zu diesem Protokolleintrag
typestring · enumRequiredPossible values:
Eintragsarten im DocumentProtocol
customMessagestringOptional
Text dieses Protokolleintrags
userNamestringRead-onlyOptional
Benutzer von dem der Eintrag angelegt wurde
timestampstring · date-timeOptional
Zeitstempel dieses Protokolleintrags
get/erp/documents/{id}/protocol
GET /erp/documents/{id}/protocol HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]post
Path parameters
idinteger · int64Required
ID des Belegs
Body
Request zur Anlage eines manuellen Eintrags ins Belegprotokoll
customMessagestring · min: 1Required
Text für das Belegprotokoll
Responses
200
OK
*/*
Belegprotokoll
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
documentTypeIdinteger · int64Read-onlyOptional
Typ des Dokuments zu diesem Protokolleintrag
documentNumberstringRead-onlyOptional
Nummer des Dokuments zu diesem Protokolleintrag
typestring · enumRequiredPossible values:
Eintragsarten im DocumentProtocol
customMessagestringOptional
Text dieses Protokolleintrags
userNamestringRead-onlyOptional
Benutzer von dem der Eintrag angelegt wurde
timestampstring · date-timeOptional
Zeitstempel dieses Protokolleintrags
post/erp/documents/{id}/protocol
POST /erp/documents/{id}/protocol HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"customMessage": "text"
}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",
"documentTypeId": 1,
"documentTypeLabels": [],
"documentNumber": "text",
"type": "MANUAL",
"customMessage": "text",
"localizeableMessage": {
"messageCode": "text",
"messageParameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"formattedMessage": "text"
},
"userName": "text",
"timestamp": "2026-01-01T00:00:00.000Z"
}Path parameters
idinteger · int64Required
ID einer Resource
Responses
200
OK
*/*
keystring · min: 1Required
tokeninteger · int64Required
userIdinteger · int64Optional
lockedBySystembooleanOptional
validUntilstring · date-timeOptional
idstringRead-onlyOptionalExample:
Unique identifier of the Object
1get/erp/documents/{id}/leasable-lock
GET /erp/documents/{id}/leasable-lock 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"
}Path parameters
idinteger · int64Required
ID der zu sperrenden Resource
Query parameters
leasePeriodinteger · int64Optional
Optionale Lease-Dauer in Sekunden
Responses
200
OK
*/*
keystring · min: 1Required
tokeninteger · int64Required
userIdinteger · int64Optional
lockedBySystembooleanOptional
validUntilstring · date-timeOptional
idstringRead-onlyOptionalExample:
Unique identifier of the Object
1post/erp/documents/{id}/leasable-lock
POST /erp/documents/{id}/leasable-lock 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"
}Path parameters
documentIdinteger · int64Required
picklistTemplateIdinteger · int64Required
Responses
200
OK
No content
post/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}
POST /erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
No content
post
Path parameters
documentIdinteger · int64Required
Body
Request zur Eingabeverarbeitung zu Belegen
inputDatastringOptional
Benutzereingabe/Scan
lastProcessedLineIdinteger · int64Optional
Die letzte verarbeitete Position
lastProcessedBookingIdinteger · int64Optional
Die letzte verarbeitete Buchung
inputListstring[]Optional
Liste von Eingaben, die nacheinander ausgeführt werden
Responses
200
OK
*/*
Response zur Eingabeverarbeitung zu Belegen
lastProcessedLineIdinteger · int64Optional
Die letzte verarbeitete Position
lastProcessedBookingIdinteger · int64Optional
Die letzte verarbeitete Buchung
post/erp/documents/{documentId}/process-input
POST /erp/documents/{documentId}/process-input HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"inputData": "text",
"lastProcessedLineId": 1,
"lastProcessedBookingId": 1,
"inputList": [
"text"
]
}200
OK
{
"message": {
"messageCode": "text",
"messageParameters": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"formattedMessage": "text"
},
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"lastProcessedLineId": 1,
"lastProcessedBookingId": 1,
"validationHints": {
"details": []
}
}Path parameters
documentIdinteger · int64Required
Responses
200
OK
*/*
Pakete zu Belegen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Optional
Position des Pakets
weightnumberOptional
Gewicht des Pakets
lengthnumberOptional
Länge
widthnumberOptional
Breite
heightnumberOptional
Höhe
trackingNumberstringRead-onlyOptional
Trackingnummer
get/erp/documents/{documentId}/parcels
GET /erp/documents/{documentId}/parcels HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
documentIdinteger · int64Required
Body
Pakete zu Belegen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Optional
Position des Pakets
weightnumberOptional
Gewicht des Pakets
lengthnumberOptional
Länge
widthnumberOptional
Breite
heightnumberOptional
Höhe
trackingNumberstringRead-onlyOptional
Trackingnummer
Responses
200
OK
*/*
Pakete zu Belegen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Optional
Position des Pakets
weightnumberOptional
Gewicht des Pakets
lengthnumberOptional
Länge
widthnumberOptional
Breite
heightnumberOptional
Höhe
trackingNumberstringRead-onlyOptional
Trackingnummer
post/erp/documents/{documentId}/parcels
POST /erp/documents/{documentId}/parcels HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 347
{
"version": "text",
"info": {},
"id": "text",
"documentRef": {
"id": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text"
},
"position": 1,
"weight": 1,
"weightUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"length": 1,
"width": 1,
"height": 1,
"sizeUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"lines": []
}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",
"documentRef": {
"id": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text"
},
"position": 1,
"weight": 1,
"weightUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"length": 1,
"width": 1,
"height": 1,
"sizeUnitTypeRef": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"trackingNumber": "text",
"lines": []
}Body
Request zur Erstellung des Jobs für Abrechnungen der Verträge
blackListinteger · int64[]Optional
Ignore ID-List
whiteListinteger · int64[]Optional
Use ID-List
documentDatestring · dateOptional
Abweichendes Belegdatum
deliveryDatestring · dateOptional
Abweichendes Lieferdatum
addBillingPeriodbooleanOptionalDefault:
Abrechnungszeitraum hinzufügen?
truenotestringOptional
Notiz
printbooleanOptionalDefault:
Drucken?
falseResponses
200
OK
*/*
contextstringOptional
message context
messageValuestringOptional
message
post/erp/documents/perform-contract-evaluation
POST /erp/documents/perform-contract-evaluation HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"blackList": [
1
],
"whiteList": [
1
],
"variableSubstitutionList": {
"variableSubstitutions": []
},
"queryPredicate": {
"type": "JUNCTION",
"operator": "AND",
"children": [],
"property": "text",
"values": [
"text"
],
"visible": true,
"functions": [
"text"
]
},
"documentDate": "2026-01-01",
"deliveryDate": "2026-01-01",
"addBillingPeriod": true,
"note": "text",
"print": false
}200
OK
{
"context": "text",
"messageValue": "text"
}Path parameters
documentIdinteger · int64Required
Responses
200
OK
*/*
systemErrorstringOptional
shelfDocumentIdinteger · int64Optional
post/erp/documents/document/{documentId}/validate
POST /erp/documents/document/{documentId}/validate HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"xmlDetails": {
"valid": true,
"hasWarnings": true,
"validSchema": true,
"validNamespaces": true,
"validEncoding": true,
"validCodelists": true,
"validFormat": true,
"validVat": true,
"validBusinessRules": true,
"validProfile": [],
"warnings": [
"text"
],
"information": [
"text"
],
"errors": [
"text"
]
},
"pdfDetails": {
"valid": true,
"foundFlavour": "text",
"warnings": [
"text"
],
"information": [
"text"
],
"errors": [
"text"
]
},
"embeddingDetails": {
"validFileEmbedding": true,
"validFilename": true,
"validXMP": true,
"canExtractXML": true,
"versionFromXML": "text",
"documentTypeFromXML": "text",
"guidelineFromXML": "text",
"variantFromXML": "text",
"warnings": [
"text"
],
"information": [
"text"
],
"errors": [
"text"
]
},
"systemError": "text",
"shelfDocumentId": 1
}Path parameters
documentIdinteger · int64Required
Body
incomingGoodsPickTrolleyIdinteger · int64Optional
ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)
incomingGoodsStorageBinIdinteger · int64Optional
ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)
Responses
200
OK
*/*
post/erp/documents/document/{documentId}/multiple_lines
POST /erp/documents/document/{documentId}/multiple_lines HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 107
{
"documentLines": [],
"incomingGoodsPickTrolleyId": 1,
"incomingGoodsStorageBinId": 1,
"additionalParameters": []
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
documentIdinteger · int64Required
Body
Responses
200
OK
*/*
post/erp/documents/document/{documentId}/line
POST /erp/documents/document/{documentId}/line HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 5466
{
"documentLine": {
"version": "text",
"info": {},
"id": "text",
"articleId": "text",
"lineType": "ARTICLE_LINE",
"productType": "WITH_STOCK",
"number": "text",
"name": "text",
"description": "text",
"unitType": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"price": 1,
"priceUnit": 1,
"priceSelectionCriteria": {
"qualifier": "SALES",
"articleIds": [
1
],
"selectOnlyDefaultPrice": false,
"accountIds": [
1
],
"productGroupId": 1,
"priceGroupId": 1,
"date": "2026-01-01",
"quantity": 1,
"noteSpecialOfferPrice": true
},
"quantity": 1,
"taxSchemaRef": {
"id": "text"
},
"taxes": [],
"priceModifiers": [],
"texts": [],
"shippingCostDetail": {
"manualCosts": false,
"freeShipping": false,
"purchasePrice": 1
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"country": {
"id": 1,
"isoAlpha2": "text",
"isoAlpha3": "text"
},
"countryRegion": {
"id": "text"
},
"customsTariffNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryText": "text",
"packageOptions": "text",
"externalReferenceVds": "text",
"netWeight": 1,
"totalNetWeight": 1,
"netWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"grossWeight": 1,
"totalGrossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"capacity": 1,
"capacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"baseCapacity": 1,
"baseCapacityUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"sourceLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"baseLineId": 1,
"mainArticleLineRef": {
"id": "text"
},
"settledOpenItemRef": {
"id": "text"
},
"settledOpenItemBalance": 1,
"settledOpenItemPaymentDueDate": "2026-01-01",
"settledOpenItemDiscountAmount": 1,
"settledOpenItemComment": "text",
"customerOrderLineRef": {
"id": 1,
"documentId": 1,
"category": "CUSTOMER_OFFER",
"documentType": "text",
"documentState": "text",
"number": "text",
"articleNumber": "text",
"position": 1,
"name": "text",
"quantity": 1,
"price": 1,
"displayName": "text"
},
"supplierOrderLineIds": [
1
],
"storage": {
"id": "text"
},
"components": [],
"fabricationComponents": [],
"bookings": [],
"commissions": [],
"previousDecisions": {
"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
},
"calculationData": "text",
"revenueCalculation": {},
"commissionOrigin": "NOT_COMMISSIONABLE",
"cashDiscountable": true,
"discountable": true,
"commissionable": false,
"warrantyInMonths": 1,
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posLineType": "CASH_PAYMENT",
"depositExpenseTypeId": 1,
"paymentMethodId": 1,
"externalPaymentId": "text",
"externalPaymentStatus": "PENDING",
"externalPaymentErrorMessage": "text",
"paymentOperation": "PAYMENT",
"cancelledExternalPaymentId": "text"
},
"fabricationDetail": {
"version": "text",
"info": {},
"id": "text",
"serialNumbers": [],
"quantityCommitted": 1,
"quantityInQA": 1,
"quantityDefective": 1,
"quantityFinished": 1,
"custom": {
"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
}
},
"returnDetail": {
"version": "text",
"info": {},
"id": "text",
"returnCategory": "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER",
"goodsExchangeArticleRef": {
"id": "text"
},
"waitForReturnBeforeExchange": true,
"repairRequested": true,
"warrantyExchange": true,
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"replacementDeliveryTermRef": {
"id": "text"
},
"replacementDeliveryMethodRef": {
"id": "text"
},
"returnCauseRef": {
"id": "text"
},
"customerShareOnSurcharge": 1,
"customerShareOnReduction": 1
},
"financeBooking": {
"version": "text",
"info": {},
"id": "text",
"documentLineId": 1,
"ledgerNumber": "text",
"transactionKey": "text",
"costCenter1": "text",
"comment": "text",
"description": "text"
},
"custom": {
"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
},
"performanceDate": "2026-01-01",
"basePrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalLinePrice": 1,
"baseSalesValueNet": 1,
"progressInvoice": false,
"dropShippingPolicy": "ANY",
"unitGrossVolumeInCubicMeters": 1,
"convertedIntoBundleArticleRef": {
"id": "text"
},
"insertTerm": "MANUAL",
"hasAccessories": false,
"recalcLinePriceViaComponents": false,
"doPrintLabel": false,
"storageInfo": "text"
},
"additionalParameters": []
}200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}post
Path parameters
contractIdinteger · int64Required
ID eines Vertrags
contractLineIdinteger · int64Required
ID einer Vertragsposition
Responses
200
OK
*/*
post/erp/documents/contract/{contractId}/deactivate-line/{contractLineId}
POST /erp/documents/contract/{contractId}/deactivate-line/{contractLineId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}post
Path parameters
contractIdinteger · int64Required
ID eines Vertrags
contractLineIdinteger · int64Required
ID einer Vertragsposition
Responses
200
OK
*/*
post/erp/documents/contract/{contractId}/activate-line/{contractLineId}
POST /erp/documents/contract/{contractId}/activate-line/{contractLineId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
idinteger · int64Required
an identifier
Responses
200
successful operation
*/*
404
Resource with given ID was not found
*/*
get/erp/documents/{id}
GET /erp/documents/{id} HTTP/1.1
Host: api.example.com
Accept: */*
{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}patch
Path parameters
idinteger · int64Required
Body
Responses
200
successful operation
*/*
404
Resource with given ID was not found
*/*
patch/erp/documents/{id}
PATCH /erp/documents/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 6813
{
"document": {
"version": "text",
"info": {},
"id": "text",
"number": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"accountId": "text",
"billingAccountRef": {
"id": "text"
},
"salesChannelRef": {
"id": "text"
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"billingType": "GROSS",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text"
},
"paymentTermRef": {
"id": "text",
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text"
},
"depositPaymentAmount": 1,
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text"
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"priceModifiers": [],
"defaultAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"billingAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"deliveryAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {},
"id": "text",
"accountRef": {
"id": "text"
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text"
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text"
},
"paymentMethodRef": {
"id": "text"
},
"deliveryTermRef": {
"id": "text"
},
"deliveryMethodRef": {
"id": "text"
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text"
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text"
},
"defaultStorageRef": {
"id": "text"
},
"locationRef": {
"id": "text"
},
"contractDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {},
"id": "text",
"posRegisterRef": {
"id": "text"
},
"cashDrawerRef": {
"id": "text"
},
"cashJournalRef": {
"id": "text"
},
"fiscalizationBackendRef": {
"id": "text"
},
"tssSignature": {},
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text"
},
"workbenchStorageRef": {
"id": "text"
},
"workbenchStorageBinRef": {
"id": "text"
},
"qualityAssuranceStorageRef": {
"id": "text"
},
"qualityAssuranceStorageBinRef": {
"id": "text"
},
"defectiveStorageRef": {
"id": "text"
},
"defectiveStorageBinRef": {
"id": "text"
},
"targetStorageRef": {
"id": "text"
},
"targetStorageBinRef": {
"id": "text"
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"additionalInfo": {
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false
},
"parameters": []
}{
"document": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
},
"hints": {
"details": []
},
"viewOptions": {
"revenueCalculation": {
"productPurchasePrice": 1,
"salesValue": 1,
"revenue": 1,
"revenueInPercent": 1
},
"loanValue": {
"accountId": 1,
"maximalLoan": 1,
"currentLoan": 1,
"nonInvoicedDocumentLoan": 1,
"receivableLoan": 1,
"payablesSum": 1,
"currentDocumentLoan": 1,
"remainingLoan": 1,
"exceededLoan": 1,
"unconsideredAmount": 1
},
"considerForCreditLimit": true,
"financeJournalAccountingInformation": {
"accountingStatus": "PROCESSING",
"financeBookingRunRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accountingStatusUpdatedDate": "2026-01-01T00:00:00.000Z",
"runState": "PROCESSING"
},
"possiblePredecessorTypes": [
"text"
],
"sumAmountOfProgressInvoices": 1,
"sumAmountOfDepositInvoices": 1,
"sumAmountOfPartialInvoices": 1,
"sumAmountOfDeliveryInvoices": 1,
"depositInvoiceRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"sumOpenAmountForProgressInvoices": 1,
"totalAmountDependingFromBillingType": 1,
"orderRefs": [],
"picklistRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"autoPrintPaperReceipt": true
}
}Path parameters
refIdinteger · int64Required
Responses
200
Workflow-Instanz gefunden
*/*
string · enumOptionalPossible values:
Status einer Workflow-Instanz
404
Es existiert noch keine Workflow-Instanz
*/*
get/erp/documents/{refId}/workflow-state
GET /erp/documents/{refId}/workflow-state HTTP/1.1
Host: api.example.com
Accept: */*
CREATEDPath 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 · enumRequiredDefault:
Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT
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
forWorkflowbooleanRequiredDefault:
für Workflows vorgesehen
falseoutputReportGroupIdentifierstringOptional
Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird
get/erp/documents/{refId}/workflow-instances-preset
GET /erp/documents/{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
}
}Path parameters
refIdinteger · int64Required
Responses
200
Workflow-Instanz gefunden
*/*
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
statestring · enumOptionalPossible values:
Status einer Workflow-Instanz
404
Es existiert noch keine Workflow-Instanz
*/*
get/erp/documents/{refId}/latest-workflow-instance
GET /erp/documents/{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": []
}Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
documentHintsstring[]Optional
UI-Hints, die sich auf den Dokumenttypen und den Account beziehen
get/erp/documents/{id}/ui-hints
GET /erp/documents/{id}/ui-hints HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"documentHints": [
"text"
],
"positionHints": []
}Path parameters
idinteger · int64Required
document identifier
articleIdinteger · int64Required
article identifier
Responses
200
OK
*/*
string[]Optional
get/erp/documents/{id}/ui-hints/article/{articleId}
GET /erp/documents/{id}/ui-hints/article/{articleId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[
"text"
]Path parameters
idinteger · int64Required
document identifier
accountIdinteger · int64Required
account identifier
Responses
200
OK
*/*
string[]Optional
get/erp/documents/{id}/ui-hints/account/{accountId}
GET /erp/documents/{id}/ui-hints/account/{accountId} HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[
"text"
]Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
documentIdstringOptional
the id of the document
numberstringOptional
the number of the document
documentDatestring · dateOptional
documentDate
totalGrossPricenumberOptional
gross total price (GROSS)
totalNetPricenumberOptional
net total price (NET)
documentTypestringOptional
type of this document
documentTypeIdstringOptional
typeId of this document
documentStatestringOptional
state of this document
documentTypeCategorystringOptional
category of this document
requestedbooleanOptionalDefault:
indicates that this document was requested
falsechainIdentifierstringOptional
Belegketten-Id
get/erp/documents/{id}/types/history
GET /erp/documents/{id}/types/history HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
Query parameters
textPositionstring · enumRequiredPossible values:
Responses
200
OK
*/*
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
labelstringRequired
Bezeichnung des Bausteins
templateTypestring · enumOptionalDefault:
Verwendungszweck des Templates
AUTOMATICPossible values: accountIdinteger · int64Optional
account für den diese Templates gelten
articleIdinteger · int64Optional
article für den diese Templates gelten
transferableIntoSubsequentDocumentsbooleanOptionalDefault:
Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?
nullseparateLinebooleanOptionalDefault:
Wird eine eigene DocumentLine für den Baustein angelegt?
nullpositionstring · enumOptionalPossible values:
Position für den erzeugten DocumentText
activebooleanRead-onlyOptionalDefault:
ist dieser Baustein aktiv?
trueresolveContentInFollowUpDocumentbooleanOptionalDefault:
Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?
falseget/erp/documents/{id}/text-templates
GET /erp/documents/{id}/text-templates?textPosition=HEADER_TEXT HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
ID of successor document
Responses
200
OK
*/*
Belegpositionen für die Vorbelegszuordnung
get/erp/documents/{id}/successor-document-assignable-lines
GET /erp/documents/{id}/successor-document-assignable-lines HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"unassignedLines": [],
"uncompletedLines": [],
"completedLines": []
}Path parameters
idinteger · int64Required
ID of predecessor document
Responses
200
OK
*/*
Liste der Belegpositionen
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
positioninteger · int32Read-onlyOptional
Positions-Nummer
positionOfArticleLineinteger · int32Read-onlyOptional
Positionsnummer über alle Artikelpositionen hinweg
articleIdstringOptional
Artikel
lineTypestring · enumRequiredPossible values:
Positionstyp
productTypestring · enumOptionalPossible values:
Artikelarten
serialTypestring · enumRead-onlyOptionalPossible values:
Serientyp eines Artikels
numberstring · max: 255Optional
Artikelnummer
namestring · max: 255Optional
Name des Artikels
descriptionstring · max: 2147483647Optional
Beschreibung des Artikels
pricenumberOptional
Preis pro Menge [Brutto, Netto]
priceUnitnumberOptional
Preiseinheit
priceOriginstring · enumRead-onlyOptionalPossible values:
Preisherkunft
quantitynumberOptional
Menge
quantityCommittednumberRead-onlyOptional
verarbeitete Menge
pickingQuantitynumberRead-onlyOptional
Menge in Pick-Vorgang
preOrderPickedQuantitynumberRead-onlyOptional
vorgeorderte Menge in Pickvorgang
completebooleanRead-onlyOptionalDefault:
ist diese Position komplett verarbeitet?
falsetotalLinePriceModifiernumberRead-onlyOptional
Summe Positionspreisänderungen [Brutto, Netto]
totalDocumentPriceModifiernumberRead-onlyOptional
Summe Dokumentpreisänderungen [Brutto, Netto]
salesValueNetnumberRead-onlyOptional
Netto-Gesamtpreis (nach Preisänderungen)
vatnumberRead-onlyOptional
Steuerbetrag
totalLinePricenumberRead-onlyOptional
Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte
customsTariffNumberstring · max: 15Optional
Zolltarifnummer
deliveryDatestring · dateOptional
Lieferdatum
deliveryDateEndstring · dateOptional
vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)
confirmedDeliveryDatestring · dateOptional
bestätigtes Lieferdatum
confirmedDeliveryDateEndstring · dateOptional
bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)
shippingDatestring · dateOptional
Versanddatum
deliveryTextstring · max: 255Optional
Liefertext
packageOptionsstringOptional
Versenderspezifische Informationen
externalReferenceVdsstring · max: 255Optional
Externe Referenz zum VDS-Paket
externalArticleNumberstring · max: 255Read-onlyOptional
Externe Artikelnummer
externalArticleNamestring · max: 255Read-onlyOptional
Externer Artikelname
externalArticleDescriptionstring · max: 255Read-onlyOptional
Externe Artikelbeschreibung
netWeightnumberOptional
Nettogewicht
totalNetWeightnumberOptional
Gesamtnettogewicht
grossWeightnumberOptional
Bruttogewicht
totalGrossWeightnumberOptional
Gesamtbruttogewicht
capacitynumberOptional
Inhalt der Maßeinheit
baseCapacitynumberOptional
Inhalt der Grundeinheit
baseLineIdinteger · int64Optional
Referenz zur Basiszeile
settledOpenItemBalancenumberOptional
Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)
settledOpenItemPaymentDueDatestring · dateOptional
Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)
settledOpenItemDiscountAmountnumberOptional
Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)
settledOpenItemCommentstringOptional
Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen
supplierOrderLineIdsinteger · int64[]Optional
Referenz zur Lieferantenbestellungszeile
articleTaxLiabilityReversedbooleanRead-onlyOptionalDefault:
Vorgabe §13b UStG Artikel
falsetaxLiabilityReversedbooleanRead-onlyOptionalDefault:
wird §13b UStG angewendet?
falsepresetPricenumberRead-onlyOptional
Vorgabewert für die Preiskalkulation
calculationDatastringOptional
Kalkulationsstruktur
commissionOriginstring · enumOptionalPossible values:
Provisionsursprung
cashDiscountablebooleanOptionalDefault:
skontierbare Position?
truediscountablebooleanOptionalDefault:
rabattierbare Position?
truecommissionablebooleanOptionalDefault:
provisionierbare Position?
falsewarrantyInMonthsinteger · int32Optional
Garantie in Monaten
performanceDatestring · dateOptional
Leistungsdatum
basePricenumberOptional
Preis pro Einheit in Basiswährung
baseTotalLinePriceModifiernumberOptional
Preisanpassungen - Position Basiswährung
baseTotalDocumentPriceModifiernumberOptional
Preisanpassungen - anteilig durch Beleg Basiswährung
baseTotalLinePricenumberOptional
Gesamtpreis Position in Basiswährung
baseSalesValueNetnumberOptional
Nettoverkaufswert der Position in Basiswährung
progressInvoicebooleanOptionalDefault:
Abschlagsposition?
falsedropShippingPolicystring · enumOptionalPossible values:
Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf
unitGrossVolumeInCubicMetersnumberOptional
unit gross Volume in cubic meters
totalGrossVolumeInCubicMetersnumberRead-onlyOptional
unit gross Volume in cubic meters
insertTermstring · enumOptionalPossible values:
Zubehör Einfügeart
hasAccessoriesbooleanOptionalDefault:
Hat der Artikel Zubehör?
falserecalcLinePriceViaComponentsbooleanOptionalDefault:
Soll die DocumentLine über die Komponenten neu berechnet werden?
falsedoPrintLabelbooleanOptionalDefault:
Soll zu der Position Etiketten gedruckt werden.
falsestorageInfostring · max: 2147483647Optional
picking hint
get/erp/documents/{id}/predecessor-document-assignable-lines
GET /erp/documents/{id}/predecessor-document-assignable-lines HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
document id
lineIdinteger · int64Required
document line id
Responses
200
OK
*/*
storage option for a document-line
reservedQuantitynumberOptional
reserved quantity (from customer-orders)
orderedQuantitynumberOptional
already ordered quantity (from supplier-orders)
stockAmountnumberOptional
the current stock amount
stockAvailablenumberOptional
the current available stock amount
get/erp/documents/{id}/lines/{lineId}/storages
GET /erp/documents/{id}/lines/{lineId}/storages HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]get
Path parameters
idinteger · int64Required
document id
lineIdinteger · int64Required
ID of the document line
Responses
200
OK
*/*
Preisermittlungskriterien
qualifierstring · enumOptionalPossible values:
ein qualifier
articleIdsinteger · int64[]Optional
Liste von Artikel-IDs
selectOnlyDefaultPricebooleanOptionalDefault:
soll nur der Standardpreis selektiert werden?
falseaccountIdsinteger · int64[]Optional
Liste von Account-IDs
productGroupIdinteger · int64Optional
Die Warengruppe
priceGroupIdinteger · int64Optional
Die Preisgruppe
datestring · dateOptional
Ein Datum
quantitynumberOptional
Eine Menge
noteSpecialOfferPricebooleanOptional
Aktionspreis beachten?
get/erp/documents/{id}/lines/{lineId}/show-price-origin
GET /erp/documents/{id}/lines/{lineId}/show-price-origin HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"qualifier": "SALES",
"articleIds": [
1
],
"selectOnlyDefaultPrice": false,
"accountIds": [
1
],
"productGroupId": 1,
"priceGroupId": 1,
"date": "2026-01-01",
"quantity": 1,
"noteSpecialOfferPrice": true
}Path parameters
idinteger · int64Required
document id
lineIdinteger · int64Required
ID of the document line
Responses
200
OK
*/*
Preisstatistiken (DEK und letzter EK)
averagePricenumberRead-onlyOptional
Durchschnitts-Einkaufspreis
averagePriceBookedAtstring · dateRead-onlyOptional
Wertstellungsdatum Durchschnitts-Einkaufspreis
priceUnitAveragePricenumberRead-onlyOptional
Preiseinheit Durchschnitts-Einkaufspreis
lastPricenumberRead-onlyOptional
letzter Einkaufspreis
priceUnitLastPricenumberRead-onlyOptional
Preiseinheit letzter Einkaufspreis
lastPriceUpdatedAtstring · date-timeRead-onlyOptional
Erfassungszeitpunkt letzter Einkaufspreis
lastPriceBookedAtstring · dateRead-onlyOptional
Wertstellungsdatum letzter Einkaufspreis
get/erp/documents/{id}/lines/{lineId}/purchase-price-statistic
GET /erp/documents/{id}/lines/{lineId}/purchase-price-statistic HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"averagePrice": 1,
"averagePriceBookedAt": "2026-01-01",
"priceUnitAveragePrice": 1,
"lastPrice": 1,
"priceUnitLastPrice": 1,
"lastPriceUpdatedAt": "2026-01-01T00:00:00.000Z",
"lastPriceBookedAt": "2026-01-01",
"mainSupplierAccount": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"mainSupplierProductPrice": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"netPrice": 1,
"grossPrice": 1,
"priceBase": "NET_PRICE",
"usedTaxRate": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"typeRef": {
"id": "text",
"label": "text",
"description": "text"
},
"active": true,
"countryCode": "text",
"rate": 19,
"validFrom": "2026-01-01"
},
"qualifier": "SALES",
"purchasePriceSource": "NONE",
"modifierValueType": "PERCENT",
"modifierValue": 1,
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"articleRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"accessoryMainArticleRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"productGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"priceGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"currencyRef": {
"id": 1,
"isoAlpha3": "text",
"label": "text",
"symbol": "text"
},
"fromQuantity": 1,
"validFrom": "2026-01-01",
"validUntil": "2026-01-01",
"specialOfferPrice": false,
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"customerGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"supplierGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"manufacturerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
}
}Path parameters
idinteger · int64Required
document id
Responses
200
OK
*/*
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
labelstringRequired
Bezeichnung des Bausteins
templateTypestring · enumOptionalDefault:
Verwendungszweck des Templates
AUTOMATICPossible values: accountIdinteger · int64Optional
account für den diese Templates gelten
articleIdinteger · int64Optional
article für den diese Templates gelten
transferableIntoSubsequentDocumentsbooleanOptionalDefault:
Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?
nullseparateLinebooleanOptionalDefault:
Wird eine eigene DocumentLine für den Baustein angelegt?
nullpositionstring · enumOptionalPossible values:
Position für den erzeugten DocumentText
activebooleanRead-onlyOptionalDefault:
ist dieser Baustein aktiv?
trueresolveContentInFollowUpDocumentbooleanOptionalDefault:
Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?
falseget/erp/documents/{id}/lines/text-templates
GET /erp/documents/{id}/lines/text-templates HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
document identifier
Responses
200
OK
*/*
Bestellbare Positionen für Übernahme in Bestellung
documentLineIdstringRead-onlyOptional
Id der DocumentLine
positioninteger · int32Read-onlyOptional
Positionsnummer
articleNumberstringRead-onlyOptional
Artikelnummer
articleNamestringRead-onlyOptional
Artikelbezeichnung
articleIdinteger · int64Read-onlyOptional
Artikelnummer
quantitynumberRequired
Menge
orderbooleanRequiredDefault:
Bestellen?
trueavailableQuantitynumberRead-onlyOptional
Verfügbare Menge
orderedQuantitynumberRead-onlyOptional
Bestellte Menge
dropShippingPolicystring · enumRead-onlyOptionalPossible values:
Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf
get/erp/documents/{id}/lines-to-transfer-to-supplier-order
GET /erp/documents/{id}/lines-to-transfer-to-supplier-order HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Path parameters
idinteger · int64Required
ID of supplier order
Responses
200
OK
*/*
In Lieferschein übernehmbare Positionen mit Belegnummern
externalDocumentNumberstringOptional
externe Belegnummer
documentNumberstringOptional
Belegnummer
deliveryDatestring · dateOptional
Wunsch-Lieferdatum
deliveryDateEndstring · dateOptional
Wunsch-Lieferdatum bis
confirmedDeliveryDatestring · dateOptional
Bestätigtes Lieferdatum
confirmedDeliveryDateEndstring · dateOptional
Bestätigtes Lieferdatum bis
get/erp/documents/{id}/lines-to-transfer-to-supplier-delivery
GET /erp/documents/{id}/lines-to-transfer-to-supplier-delivery HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"deliveryTransferableLines": [],
"externalDocumentNumber": "text",
"documentNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01"
}Path parameters
idinteger · int64Required
ID of customer order
Responses
200
OK
*/*
In Lieferschein übernehmbare Positionen mit Belegnummern
externalDocumentNumberstringOptional
externe Belegnummer
documentNumberstringOptional
Belegnummer
deliveryDatestring · dateOptional
Wunsch-Lieferdatum
deliveryDateEndstring · dateOptional
Wunsch-Lieferdatum bis
confirmedDeliveryDatestring · dateOptional
Bestätigtes Lieferdatum
confirmedDeliveryDateEndstring · dateOptional
Bestätigtes Lieferdatum bis
get/erp/documents/{id}/lines-to-transfer-to-picklist
GET /erp/documents/{id}/lines-to-transfer-to-picklist HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"deliveryTransferableLines": [],
"externalDocumentNumber": "text",
"documentNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01"
}Path parameters
idinteger · int64Required
ID of customer order
Responses
200
OK
*/*
In Lieferschein übernehmbare Positionen mit Belegnummern
externalDocumentNumberstringOptional
externe Belegnummer
documentNumberstringOptional
Belegnummer
deliveryDatestring · dateOptional
Wunsch-Lieferdatum
deliveryDateEndstring · dateOptional
Wunsch-Lieferdatum bis
confirmedDeliveryDatestring · dateOptional
Bestätigtes Lieferdatum
confirmedDeliveryDateEndstring · dateOptional
Bestätigtes Lieferdatum bis
get/erp/documents/{id}/lines-to-transfer-to-customer-delivery
GET /erp/documents/{id}/lines-to-transfer-to-customer-delivery HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"deliveryTransferableLines": [],
"externalDocumentNumber": "text",
"documentNumber": "text",
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01"
}Path parameters
idinteger · int64Required
Responses
200
OK
*/*
document to update
versionstringOptional
Version Identifier for this Object (for PUT)
idstringOptional
Unique identifier of the Object
numberstring · max: 255Required
Belegnummer
accountNumberstring · max: 255Read-onlyOptional
Kontonummer der zugehörigen Organisationseinheit
customerNumberstring · max: 255Read-onlyOptional
Kundennummer
ourCustomerNumberstring · max: 255Read-onlyOptional
Kundennummer beim Lieferanten
supplierNumberstring · max: 255Read-onlyOptional
Lieferantennummer
salesAgentNumberstring · max: 255Read-onlyOptional
Vertreternummer
externalIdentifierstring · max: 255Optional
Externe Kennung
externalNumberstring · max: 255Optional
Externe Belegnummer
publishedbooleanRead-onlyOptionalDefault:
Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?
falsefrozenbooleanRead-onlyOptionalDefault:
Ist der Beleg festgeschrieben?
falsequalifierstring · enumRead-onlyOptionalPossible values:
Art des Belegs
accountIdstringRequired
ID der Organisationseinheit
documentDatestring · dateRequired
Belegdatum
performanceDatestring · dateOptional
Leistungsdatum
valueDatestring · dateOptional
Valutadatum
taxablebooleanOptionalDefault:
Steuerpflichtig oder steuerfrei
truetaxIdentificationNumberstring · max: 255Optional
Umsatzsteuer-Identifikationsnummer
taxIdVerificationStatestring · enumRead-onlyOptionalPossible values:
Überprüfungsstatus der Steueridentifikationsnummer
valitoolValidationStatestring · enumRead-onlyOptionalPossible values:
Validierungsstatus bei elektronischen Rechnungen
billingTypestring · enumRequiredPossible values:
Abrechnungstyp
documentTypestringRead-onlyOptional
Belegtyp (intern)
documentTypeIdinteger · int64Read-onlyOptional
ID des Belegtyps
documentTypeCategorystring · enumRead-onlyOptionalPossible values:
Dokumenttypen
currencyCodestringRequired
Währung (ISO-Code, Alpha-3)
exchangeRatenumberOptional
Wechselkurs
exchangeRateOriginstring · enumOptionalDefault:
Ursprung für Währungskursermittlung
AUTOMATICPossible values: totalBeforeModifiernumberRead-onlyOptional
Gesamtpreis vor Rabatt [BRUTTO, NETTO]
totalPriceModifiernumberRead-onlyOptional
Rabatt gesamt [BRUTTO, NETTO]
totalLinePriceModifiernumberRead-onlyOptional
Positionsrabatt gesamt [BRUTTO, NETTO]
totalDocumentPriceModifiernumberRead-onlyOptional
Belegrabatt gesamt [BRUTTO, NETTO]
totalNetPricenumberRead-onlyOptional
Gesamtpreis netto
totalVatnumberRead-onlyOptional
Gesamte Mehrwertsteuer
totalGrossPricenumberRead-onlyOptional
Gesamtpreis brutto
roundingAmountnumberRead-onlyOptional
Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)
depositPaymentAmountnumberOptional
Vereinbarter Anzahlungsbetrag
depositPaymentDatestring · dateRead-onlyOptional
Vereinbartes Anzahlungsdatum
deliveryDatestring · dateOptional
Voraussichtliches Lieferdatum
deliveryDateEndstring · dateOptional
Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)
confirmedDeliveryDatestring · dateOptional
Bestätigtes Lieferdatum
confirmedDeliveryDateEndstring · dateOptional
Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)
shippingDatestring · dateOptional
Versanddatum
deliveryQuantityPackagesinteger · int32Optional
Voraussichtliche Paketanzahl (nur Info)
deliveryTextstring · max: 255Optional
Zusätzlicher Liefertext
deliveryApprovedbooleanRequiredDefault:
Ist der Beleg zur Lieferung freigegeben?
truedropShippingInvoiceApprovedbooleanRead-onlyOptional
Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?
orderedOnstring · dateOptional
Bestelldatum
orderedBystring · max: 255Optional
Name der bestellenden Person
taxLiabilityReversedbooleanOptionalDefault:
Reverse-Charge-Verfahren nach §13b UStG?
falsecollectiveInvoicebooleanOptionalDefault:
Sammelrechnung?
falseshippingCostSumnumberRead-onlyOptional
Summe der Versandkosten (netto/brutto)
stackProcessingTypestring · enumOptionalPossible values:
Stapelverarbeitungsinformationen für Aufträge
stackProcessingPriorityinteger · int32Optional
Priorität in der Stapelverarbeitung
maxDeliveriesinteger · int32Optional
Maximal mögliche Lieferungen
taxPerformanceLocationstring · enumOptionalPossible values:
Ort der steuerlichen Leistungserbringung
performanceCountryCodestringOptional
Länderkennzeichen Leistungsland (ISO Alpha-3)
sourceCountryCodestringOptional
Länderkennzeichen Ursprungsland (ISO Alpha-3)
grossWeightnumberOptional
Gesamtbruttogewicht
userDefinedWeightbooleanOptionalDefault:
Gesamtgewicht wurde manuell gesetzt
falsecashDiscountableTotalGrossPricenumberRead-onlyOptional
Skontofähiger Bruttogesamtbetrag
buyerReferencestring · max: 255Optional
Leitweg-ID
en16931Profilestring · enumOptionalPossible values:
EN16931-Profil für elektronische Rechnungen
importTypestring · enumRead-onlyOptionalPossible values:
Importmodus des Belegs
paymentPlanbooleanOptionalDefault:
Zahlungsplan vorhanden?
falsecalculationModestring · enumRequiredPossible values:
Berechnungsmodus
processedByWorkflowbooleanRead-onlyOptional
Wird vom Workflow verarbeitet?
referencedOrderNumberstringRead-onlyOptional
Bestellnummer aus Vorbeleg
languageCodestringOptional
Sprache
baseCurrencyCodestringOptional
Basiswährung des Belegs
baseTotalNetPricenumberOptional
Gesamtpreis - Netto Basiswährung
baseTotalLinePriceModifiernumberOptional
Preisanpassungen - Belegpositionssumme Basiswährung
baseTotalDocumentPriceModifiernumberOptional
Preisanpassungen - Beleg Basiswährung
baseTotalGrossPricenumberOptional
Gesamtpreis - Brutto Basiswährung
baseDepositPaymentAmountnumberOptional
Vorkassebetrag Basiswährung
baseCashDiscountableTotalGrossPricenumberOptional
skontierbarer Rechnungsbetrag Basiswährung
forwardEmailToShipperbooleanOptionalDefault:
E-Mail an Versender übergeben
falseforwardPhoneToShipperbooleanOptionalDefault:
Telefon an Versender übergeben
falseposReceiptPaymentSumnumberOptional
Quittung: Summe Zahlbetrag
posReceiptBalancenumberOptional
Quittung: Saldo positiver Wert: Betrag der noch zu zahlen ist negativer Wert: überzahlter Betrag / Rückgeld
posReceiptChangeAmountnumberOptional
Rückgeld
posReceiptBalancedbooleanOptionalDefault:
Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld true wenn die Quittung ausbalanciert ist
falseposReceiptPayedbooleanOptionalDefault:
Ist die Quittung bezahlt true wenn die Quittung bezahlt ist
falsedropShippingbooleanRead-onlyOptional
Streckengeschäft
totalGrossVolumeInCubicMetersnumberRead-onlyOptional
total gross Volume in cubic meters
get/erp/documents/{id}/flat
GET /erp/documents/{id}/flat HTTP/1.1
Host: api.example.com
Accept: */*
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",
"number": "text",
"accountNumber": "text",
"customerNumber": "text",
"ourCustomerNumber": "text",
"supplierNumber": "text",
"salesAgentNumber": "text",
"externalIdentifier": "text",
"externalNumber": "text",
"published": false,
"frozen": false,
"qualifier": "SALE",
"accountId": "text",
"billingAccountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salesChannelRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"documentDate": "2026-01-01",
"performanceDate": "2026-01-01",
"valueDate": "2026-01-01",
"taxable": true,
"taxIdentificationNumber": "text",
"taxIdVerificationState": "NOT_YET_VERIFIED",
"valitoolValidationState": "NOT_VALIDATED",
"billingType": "GROSS",
"documentType": "text",
"documentTypeId": 1,
"documentTypeCategory": "CUSTOMER_OFFER",
"documentState": {
"label": "text",
"key": "text",
"definition": "SELECTABLE_TYPES"
},
"cancellationReasonRef": {
"id": "text",
"label": "text",
"description": "text"
},
"currencyCode": "text",
"exchangeRate": 1,
"exchangeRateOrigin": "AUTOMATIC",
"responsibleUserRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"totalBeforeModifier": 1,
"totalPriceModifier": 1,
"totalLinePriceModifier": 1,
"totalDocumentPriceModifier": 1,
"totalNetPrice": 1,
"totalVat": 1,
"totalGrossPrice": 1,
"roundingAmount": 1,
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true,
"paymentType": "PREPAYMENT"
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"depositPaymentAmount": 1,
"depositPaymentDate": "2026-01-01",
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryDate": "2026-01-01",
"deliveryDateEnd": "2026-01-01",
"confirmedDeliveryDate": "2026-01-01",
"confirmedDeliveryDateEnd": "2026-01-01",
"shippingDate": "2026-01-01",
"deliveryQuantityPackages": 1,
"deliveryText": "text",
"deliveryApproved": true,
"dropShippingInvoiceApproved": true,
"orderedOn": "2026-01-01",
"orderedByPersonRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"orderedBy": "text",
"taxLiabilityReversed": false,
"collectiveInvoice": false,
"texts": [],
"lines": [],
"shippingCosts": [],
"posPayments": [],
"shippingCostSum": 1,
"priceModifiers": [],
"taxes": [],
"defaultAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"billingAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"deliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"returnDeliveryAddress": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"accountRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"salutation": "text",
"title": "text",
"name1": "text",
"name2": "text",
"name3": "text",
"globalLocationNumber": "text",
"street": "text",
"streetAddressNumber": "text",
"additionalAddressLine1": "text",
"additionalAddressLine2": "text",
"city": "text",
"regionRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"postcode": "text",
"postOfficeBox": "text",
"countryCode": "text",
"phoneContact": "text",
"mailContact": "text",
"languageCode": "text",
"paymentTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"paymentMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryTermRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"deliveryMethodRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
}
},
"custom": {
"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
},
"stackProcessingType": "NO_PICKING",
"stackProcessingPriority": 1,
"maxDeliveries": 1,
"taxPerformanceLocation": "DOMESTIC",
"performanceCountryCode": "text",
"sourceCountryCode": "text",
"afterPickingTargetDocumentTypeRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"grossWeight": 1,
"grossWeightUnit": {
"id": 1,
"name": "text",
"abbreviation": "text"
},
"userDefinedWeight": false,
"tags": [],
"reportGroupRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defaultStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"locationRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDiscountableTotalGrossPrice": 1,
"contractDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"endDate": "2026-01-01",
"runtimeFromDate": "2026-01-01",
"runtimeToDate": "2026-01-01",
"lastCustomerCancellationDate": "2026-01-01",
"lastProviderCancellationDate": "2026-01-01",
"dueDateCalculation": "text",
"dueDate": "2026-01-01",
"nextDueDate": "2026-01-01",
"calculateDirectly": true,
"active": true,
"publishInPortal": false
},
"posDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"posRegisterRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashDrawerRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"cashJournalRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"fiscalizationBackendRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"tssSignature": {
"status": "FINISHED",
"responseData": "text",
"externalReference": "text",
"revision": 1
},
"externalReference": "text",
"timeStart": 1,
"timeEnd": 1,
"clientSerialNumber": "text",
"tssSerialNumber": "text",
"transactionNumber": 1,
"revision": 1,
"signatureCounter": 1,
"signature": "text"
},
"fabricationDetail": {
"version": "text",
"info": {
"createdAt": "2026-01-01T00:00:00.000Z",
"createdFrom": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"updatedFrom": "text"
},
"id": "text",
"startDate": "2026-01-01",
"minimumDegreeOfFulfillment": 1,
"note": "text",
"componentsStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"workbenchStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"qualityAssuranceStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"defectiveStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"targetStorageBinRef": {
"id": "text",
"label": "text",
"description": "text",
"active": true
},
"custom": {
"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
}
},
"buyerReference": "text",
"en16931Profile": "ZUGFERD",
"importType": "NOT_IMPORTED",
"paymentPlan": false,
"calculationMode": "HORIZONTAL",
"processedByWorkflow": true,
"referencedOrderNumber": "text",
"additionalInfo": {
"calculationModeOrigin": "FROM_BILLING_ADDRESS",
"roundingMode": "NONE",
"en16931Origin": "FROM_BILLING_ADDRESS",
"buyerReferenceOrigin": "FROM_BILLING_ADDRESS",
"previousDecisions": "text",
"taxSituationOrigin": "UNDEFINED",
"languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
"contextParameters": [],
"incomingGoodsTarget": {
"storageBinId": 1,
"pickTrolleyId": 1
},
"translations": [],
"incomingGoodsTargetsPerLine": []
},
"languageCode": "text",
"baseCurrencyCode": "text",
"baseTotalNetPrice": 1,
"baseTotalLinePriceModifier": 1,
"baseTotalDocumentPriceModifier": 1,
"baseTotalGrossPrice": 1,
"baseDepositPaymentAmount": 1,
"baseCashDiscountableTotalGrossPrice": 1,
"forwardEmailToShipper": false,
"forwardPhoneToShipper": false,
"posReceiptPaymentSum": 1,
"posReceiptBalance": 1,
"posReceiptChangeAmount": 1,
"posReceiptBalanced": false,
"posReceiptPayed": false,
"dropShipping": true,
"totalGrossVolumeInCubicMeters": 1
}Path parameters
documentIdinteger · int64Required
Responses
200
OK
*/*
quantitynumberOptional
Die Menge dieser Kombination
get/erp/documents/{documentId}/parcels/unassigned-bookings
GET /erp/documents/{documentId}/parcels/unassigned-bookings HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]get
Path parameters
documentIdinteger · int64Required
Responses
200
OK
*/*
Verfügbarkeitsinformationen zu einem Beleg und seinen Positionen
get/erp/documents/{documentId}/availability
GET /erp/documents/{documentId}/availability HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
{
"documentAvailabilityInfo": {
"orderAvailability": "FULL_DELIVERABLE",
"orderStackProcessingType": "NO_PICKING",
"maxPossibleDeliveries": 1
},
"lineAvailabilityInfos": {
"ANY_ADDITIONAL_PROPERTY": {
"orderLineAvailability": "FULL_DELIVERABLE",
"availableQuantity": 1,
"maxAvailableQuantity": 1,
"orderedQuantity": 1
}
}
}Query parameters
languageCodestringRequired
Responses
200
OK
*/*
idstringRequired
das gleiche wie transition id für das UI
transitionIdstringRequired
transition id
transitionLabelstringRead-onlyOptional
label of this transition
stateDefinitionstringRead-onlyOptional
state definition of the target state
typeCategorystring · enumRead-onlyOptionalPossible values:
Dokumenttypen
typeIdstringRead-onlyOptional
document-type-id des ziels
typeKeystringRead-onlyOptional
document-type-key des ziels
typeLabelstringRead-onlyOptional
type-label
isDefaultTypeForCategorybooleanRead-onlyOptional
document-type ist Default für die Kategorie
targetStatestringRead-onlyOptional
Der Ziel-Status der Transition
sortOrderinteger · int32Read-onlyOptional
Sortier-Reihenfolge
get/erp/documents/types
GET /erp/documents/types?languageCode=text HTTP/1.1
Host: api.example.com
Accept: */*
200
OK
[]Last updated
Was this helpful?