For the complete documentation index, see llms.txt. This page is also available as Markdown.

Document Additional Functions

Manage VARIO document workflows via REST API: update tags, types and states, control delivery, unlock open items and process document lines.

Additional Document Functions

Update the tags

put
Path parameters
documentIdinteger · int64Required
Bodyinteger · int64[]
integer · int64[]Optional
Responses
200

OK

*/*
put/erp/documents/additional-functions/{documentId}/updateTags/
PUT /erp/documents/additional-functions/{documentId}/updateTags/ HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]
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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Change the document type

put
Path parameters
documentIdinteger · int64Required
targetTypeIdinteger · int64Required
Responses
200

OK

*/*
put/erp/documents/additional-functions/{documentId}/update-type/{targetTypeId}
PUT /erp/documents/additional-functions/{documentId}/update-type/{targetTypeId} 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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Change the document state

put
Path parameters
documentIdinteger · int64Required
targetStatestringRequired
Responses
200

OK

*/*
put/erp/documents/additional-functions/{documentId}/update-state/{targetState}
PUT /erp/documents/additional-functions/{documentId}/update-state/{targetState} 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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Unlock an open item

put
Path parameters
documentIdinteger · int64Required
Responses
200

OK

*/*
put/erp/documents/additional-functions/{documentId}/unlock-openitem
PUT /erp/documents/additional-functions/{documentId}/unlock-openitem 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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Change a document line's customer order reference

put
Path parameters
documentIdinteger · int64Required
documentLineIdinteger · int64Required
customerOrderLineIdinteger · int64Required
Responses
200

OK

*/*

Document lines.

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Read-onlyOptional

Position number.

positionOfArticleLineinteger · int32Read-onlyOptional

Position number across all article lines.

articleIdstringOptional

Article.

lineTypestring · enumRequired

Line type.

Possible values:
productTypestring · enumOptional

Article types.

Possible values:
serialTypestring · enumRead-onlyOptional

Article serial type.

Possible values:
numberstring · max: 255Optional

Article number.

namestring · max: 255Optional

Article name.

descriptionstring · max: 2147483647Optional

Article description.

pricenumberOptional

Price per quantity [gross, net].

priceUnitnumberOptional

Price unit.

priceOriginstring · enumRead-onlyOptional

Price origin.

Possible values:
quantitynumberOptional

Quantity.

quantityCommittednumberRead-onlyOptional

Processed quantity.

pickingQuantitynumberRead-onlyOptional

Quantity in the picking process.

preOrderPickedQuantitynumberRead-onlyOptional

Pre-ordered quantity in the picking process.

completebooleanRead-onlyOptional

Is this line completely processed?

Default: false
totalLinePriceModifiernumberRead-onlyOptional

Total of the line price changes [gross, net].

totalDocumentPriceModifiernumberRead-onlyOptional

Total of the document price changes [gross, net].

salesValueNetnumberRead-onlyOptional

Net total price (after the price changes).

vatnumberRead-onlyOptional

Tax amount.

totalLinePricenumberRead-onlyOptional

Line total [gross, net], i.e. price * quantity less the line discounts.

customsTariffNumberstring · max: 15Optional

Customs tariff number.

deliveryDatestring · dateOptional

Delivery date.

deliveryDateEndstring · dateOptional

Expected delivery period end (only required for delivery periods when the delivery date is set).

confirmedDeliveryDatestring · dateOptional

Confirmed delivery date.

confirmedDeliveryDateEndstring · dateOptional

Confirmed delivery period end (only required for delivery periods when the delivery date is set).

shippingDatestring · dateOptional

Shipping date.

deliveryTextstring · max: 255Optional

Delivery text.

packageOptionsstringOptional

Shipper-specific information.

externalReferenceVdsstring · max: 255Optional

External reference to the VDS parcel.

externalArticleNumberstring · max: 255Read-onlyOptional

External article number.

externalArticleNamestring · max: 255Read-onlyOptional

External article name.

externalArticleDescriptionstring · max: 255Read-onlyOptional

External article description.

netWeightnumberOptional

Net weight.

totalNetWeightnumberOptional

Total net weight.

grossWeightnumberOptional

Gross weight.

totalGrossWeightnumberOptional

Total gross weight.

capacitynumberOptional

Unit of measure content.

baseCapacitynumberOptional

Base unit content.

baseLineIdinteger · int64Optional

Reference to the base line.

voucherCodestringOptional

Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)

settledOpenItemBalancenumberOptional

Open remaining amount of the open item to settle (only in the response).

settledOpenItemPaymentDueDatestring · dateOptional

Due date of the open item to settle (only in the response).

settledOpenItemDiscountAmountnumberOptional

Payment discount of the open item to settle that is applicable at the document date (only in the response).

settledOpenItemCommentstringOptional

Note on the open item line - transferred into the open item comment on closing.

supplierOrderLineIdsinteger · int64[]Optional

Reference to the supplier order line.

articleTaxLiabilityReversedbooleanRead-onlyOptional

§13b UStG preset of the article.

Default: false
taxLiabilityReversedbooleanRead-onlyOptional

Is §13b UStG applied?

Default: false
presetPricenumberRead-onlyOptional

Preset value for the price calculation.

calculationDatastringOptional

Calculation structure.

commissionOriginstring · enumOptional

Commission origin.

Possible values:
cashDiscountablebooleanOptional

Is this line eligible for the payment discount?

Default: true
discountablebooleanOptional

Is this line eligible for discount?

Default: true
commissionablebooleanOptional

Is this line eligible for commission?

Default: false
warrantyInMonthsinteger · int32Optional

Warranty in months.

performanceDatestring · dateOptional

Performance date.

basePricenumberOptional

Price per unit in base currency.

baseTotalLinePriceModifiernumberOptional

Price adjustments - line, in base currency.

baseTotalDocumentPriceModifiernumberOptional

Price adjustments - proportionally from the document, in base currency.

baseTotalLinePricenumberOptional

Total line price in base currency.

baseSalesValueNetnumberOptional

Line net sales value in base currency.

progressInvoicebooleanOptional

Is this a progress invoice line?

Default: false
dropShippingPolicystring · enumOptional

Defines whether and how an article may be sold by drop shipping.

Possible values:
unitGrossVolumeInCubicMetersnumberOptional

unit gross Volume in cubic meters

totalGrossVolumeInCubicMetersnumberRead-onlyOptional

unit gross Volume in cubic meters

insertTermstring · enumOptional

Accessory insert term.

Possible values:
hasAccessoriesbooleanOptional

Does the article have accessories?

Default: false
recalcLinePriceViaComponentsbooleanOptional

Should the DocumentLine be recalculated from the components?

Default: false
doPrintLabelbooleanOptional

Should labels be printed for this line?

Default: false
storageInfostring · max: 2147483647Optional

picking hint

put/erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId}
PUT /erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId} 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",
  "position": 1,
  "positionOfArticleLine": 1,
  "articleId": "text",
  "lineType": "ARTICLE_LINE",
  "productType": "WITH_STOCK",
  "serialType": "NONE",
  "number": "text",
  "name": "text",
  "description": "text",
  "unitType": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "price": 1,
  "priceUnit": 1,
  "priceOrigin": "USER_DEFINED",
  "priceSelectionCriteria": {
    "qualifier": "SALES",
    "articleIds": [
      1
    ],
    "selectOnlyDefaultPrice": false,
    "accountIds": [
      1
    ],
    "productGroupId": 1,
    "priceGroupId": 1,
    "date": "2026-01-01",
    "quantity": 1,
    "noteSpecialOfferPrice": true
  },
  "quantity": 1,
  "quantityCommitted": 1,
  "pickingQuantity": 1,
  "preOrderPickedQuantity": 1,
  "complete": false,
  "taxSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "taxes": [],
  "totalLinePriceModifier": 1,
  "totalDocumentPriceModifier": 1,
  "priceModifiers": [],
  "salesValueNet": 1,
  "vat": 1,
  "totalLinePrice": 1,
  "texts": [],
  "shippingCostDetail": {
    "manualCosts": false,
    "freeShipping": false,
    "purchasePrice": 1
  },
  "deliveryTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "deliveryMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "country": {
    "id": 1,
    "isoAlpha2": "text",
    "isoAlpha3": "text",
    "label": "text"
  },
  "countryRegion": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "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",
  "externalArticleNumber": "text",
  "externalArticleName": "text",
  "externalArticleDescription": "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",
    "label": "text",
    "description": "text",
    "active": true
  },
  "settledOpenItemRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherCode": "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",
    "label": "text",
    "description": "text",
    "active": true
  },
  "components": [],
  "fabricationComponents": [],
  "bookings": [],
  "commissions": [],
  "previousDecisions": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "missingNode": true,
    "valueNode": true,
    "container": true,
    "integralNumber": true,
    "binary": true,
    "nodeType": "ARRAY",
    "string": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "floatingPointNumber": true,
    "number": true,
    "embeddedValue": true
  },
  "articleTaxLiabilityReversed": false,
  "taxLiabilityReversed": false,
  "presetPrice": 1,
  "calculationData": "text",
  "revenueCalculation": {
    "productPurchasePrice": 1,
    "salesValue": 1,
    "revenue": 1,
    "revenueInPercent": 1
  },
  "commissionOrigin": "NOT_COMMISSIONABLE",
  "cashDiscountable": true,
  "discountable": true,
  "commissionable": false,
  "warrantyInMonths": 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",
    "posLineType": "CASH_PAYMENT",
    "depositExpenseTypeId": 1,
    "paymentMethodId": 1,
    "externalPaymentId": "text",
    "externalPaymentStatus": "PENDING",
    "externalPaymentErrorMessage": "text",
    "paymentOperation": "PAYMENT",
    "cancelledExternalPaymentId": "text",
    "withdrawalMode": "FULL",
    "balanceBeforeWithdrawal": 1,
    "withdrawalAmount": 1,
    "withdrawToBalance": 1,
    "deletable": false
  },
  "fabricationDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "serialNumbers": [],
    "quantityCommitted": 1,
    "quantityInQA": 1,
    "quantityDefective": 1,
    "quantityFinished": 1,
    "custom": {
      "empty": true,
      "array": true,
      "null": true,
      "object": true,
      "float": true,
      "missingNode": true,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    }
  },
  "returnDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "returnCategory": "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER",
    "goodsExchangeArticleRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "waitForReturnBeforeExchange": true,
    "repairRequested": true,
    "warrantyExchange": true,
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "replacementDeliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "replacementDeliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "returnCauseRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "customerShareOnSurcharge": 1,
    "customerShareOnReduction": 1
  },
  "financeBooking": {
    "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"
  },
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "missingNode": true,
    "valueNode": true,
    "container": true,
    "integralNumber": true,
    "binary": true,
    "nodeType": "ARRAY",
    "string": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "floatingPointNumber": true,
    "number": true,
    "embeddedValue": true
  },
  "variantValues": [],
  "performanceDate": "2026-01-01",
  "basePrice": 1,
  "baseTotalLinePriceModifier": 1,
  "baseTotalDocumentPriceModifier": 1,
  "baseTotalLinePrice": 1,
  "baseSalesValueNet": 1,
  "progressInvoice": false,
  "dropShippingPolicy": "ANY",
  "unitGrossVolumeInCubicMeters": 1,
  "totalGrossVolumeInCubicMeters": 1,
  "convertedIntoBundleArticleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "onGoodsArrivalConvertIntoBundleArticleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "insertTerm": "MANUAL",
  "hasAccessories": false,
  "recalcLinePriceViaComponents": false,
  "doPrintLabel": false,
  "storageInfo": "text"
}

Delete a document line's customer order reference

put
Path parameters
documentIdinteger · int64Required
documentLineIdinteger · int64Required
customerOrderLineIdinteger · int64Required
Responses
200

OK

*/*

Document lines.

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Read-onlyOptional

Position number.

positionOfArticleLineinteger · int32Read-onlyOptional

Position number across all article lines.

articleIdstringOptional

Article.

lineTypestring · enumRequired

Line type.

Possible values:
productTypestring · enumOptional

Article types.

Possible values:
serialTypestring · enumRead-onlyOptional

Article serial type.

Possible values:
numberstring · max: 255Optional

Article number.

namestring · max: 255Optional

Article name.

descriptionstring · max: 2147483647Optional

Article description.

pricenumberOptional

Price per quantity [gross, net].

priceUnitnumberOptional

Price unit.

priceOriginstring · enumRead-onlyOptional

Price origin.

Possible values:
quantitynumberOptional

Quantity.

quantityCommittednumberRead-onlyOptional

Processed quantity.

pickingQuantitynumberRead-onlyOptional

Quantity in the picking process.

preOrderPickedQuantitynumberRead-onlyOptional

Pre-ordered quantity in the picking process.

completebooleanRead-onlyOptional

Is this line completely processed?

Default: false
totalLinePriceModifiernumberRead-onlyOptional

Total of the line price changes [gross, net].

totalDocumentPriceModifiernumberRead-onlyOptional

Total of the document price changes [gross, net].

salesValueNetnumberRead-onlyOptional

Net total price (after the price changes).

vatnumberRead-onlyOptional

Tax amount.

totalLinePricenumberRead-onlyOptional

Line total [gross, net], i.e. price * quantity less the line discounts.

customsTariffNumberstring · max: 15Optional

Customs tariff number.

deliveryDatestring · dateOptional

Delivery date.

deliveryDateEndstring · dateOptional

Expected delivery period end (only required for delivery periods when the delivery date is set).

confirmedDeliveryDatestring · dateOptional

Confirmed delivery date.

confirmedDeliveryDateEndstring · dateOptional

Confirmed delivery period end (only required for delivery periods when the delivery date is set).

shippingDatestring · dateOptional

Shipping date.

deliveryTextstring · max: 255Optional

Delivery text.

packageOptionsstringOptional

Shipper-specific information.

externalReferenceVdsstring · max: 255Optional

External reference to the VDS parcel.

externalArticleNumberstring · max: 255Read-onlyOptional

External article number.

externalArticleNamestring · max: 255Read-onlyOptional

External article name.

externalArticleDescriptionstring · max: 255Read-onlyOptional

External article description.

netWeightnumberOptional

Net weight.

totalNetWeightnumberOptional

Total net weight.

grossWeightnumberOptional

Gross weight.

totalGrossWeightnumberOptional

Total gross weight.

capacitynumberOptional

Unit of measure content.

baseCapacitynumberOptional

Base unit content.

baseLineIdinteger · int64Optional

Reference to the base line.

voucherCodestringOptional

Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)

settledOpenItemBalancenumberOptional

Open remaining amount of the open item to settle (only in the response).

settledOpenItemPaymentDueDatestring · dateOptional

Due date of the open item to settle (only in the response).

settledOpenItemDiscountAmountnumberOptional

Payment discount of the open item to settle that is applicable at the document date (only in the response).

settledOpenItemCommentstringOptional

Note on the open item line - transferred into the open item comment on closing.

supplierOrderLineIdsinteger · int64[]Optional

Reference to the supplier order line.

articleTaxLiabilityReversedbooleanRead-onlyOptional

§13b UStG preset of the article.

Default: false
taxLiabilityReversedbooleanRead-onlyOptional

Is §13b UStG applied?

Default: false
presetPricenumberRead-onlyOptional

Preset value for the price calculation.

calculationDatastringOptional

Calculation structure.

commissionOriginstring · enumOptional

Commission origin.

Possible values:
cashDiscountablebooleanOptional

Is this line eligible for the payment discount?

Default: true
discountablebooleanOptional

Is this line eligible for discount?

Default: true
commissionablebooleanOptional

Is this line eligible for commission?

Default: false
warrantyInMonthsinteger · int32Optional

Warranty in months.

performanceDatestring · dateOptional

Performance date.

basePricenumberOptional

Price per unit in base currency.

baseTotalLinePriceModifiernumberOptional

Price adjustments - line, in base currency.

baseTotalDocumentPriceModifiernumberOptional

Price adjustments - proportionally from the document, in base currency.

baseTotalLinePricenumberOptional

Total line price in base currency.

baseSalesValueNetnumberOptional

Line net sales value in base currency.

progressInvoicebooleanOptional

Is this a progress invoice line?

Default: false
dropShippingPolicystring · enumOptional

Defines whether and how an article may be sold by drop shipping.

Possible values:
unitGrossVolumeInCubicMetersnumberOptional

unit gross Volume in cubic meters

totalGrossVolumeInCubicMetersnumberRead-onlyOptional

unit gross Volume in cubic meters

insertTermstring · enumOptional

Accessory insert term.

Possible values:
hasAccessoriesbooleanOptional

Does the article have accessories?

Default: false
recalcLinePriceViaComponentsbooleanOptional

Should the DocumentLine be recalculated from the components?

Default: false
doPrintLabelbooleanOptional

Should labels be printed for this line?

Default: false
storageInfostring · max: 2147483647Optional

picking hint

put/erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId}/remove
PUT /erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId}/remove 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",
  "position": 1,
  "positionOfArticleLine": 1,
  "articleId": "text",
  "lineType": "ARTICLE_LINE",
  "productType": "WITH_STOCK",
  "serialType": "NONE",
  "number": "text",
  "name": "text",
  "description": "text",
  "unitType": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "price": 1,
  "priceUnit": 1,
  "priceOrigin": "USER_DEFINED",
  "priceSelectionCriteria": {
    "qualifier": "SALES",
    "articleIds": [
      1
    ],
    "selectOnlyDefaultPrice": false,
    "accountIds": [
      1
    ],
    "productGroupId": 1,
    "priceGroupId": 1,
    "date": "2026-01-01",
    "quantity": 1,
    "noteSpecialOfferPrice": true
  },
  "quantity": 1,
  "quantityCommitted": 1,
  "pickingQuantity": 1,
  "preOrderPickedQuantity": 1,
  "complete": false,
  "taxSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "taxes": [],
  "totalLinePriceModifier": 1,
  "totalDocumentPriceModifier": 1,
  "priceModifiers": [],
  "salesValueNet": 1,
  "vat": 1,
  "totalLinePrice": 1,
  "texts": [],
  "shippingCostDetail": {
    "manualCosts": false,
    "freeShipping": false,
    "purchasePrice": 1
  },
  "deliveryTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "deliveryMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "country": {
    "id": 1,
    "isoAlpha2": "text",
    "isoAlpha3": "text",
    "label": "text"
  },
  "countryRegion": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "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",
  "externalArticleNumber": "text",
  "externalArticleName": "text",
  "externalArticleDescription": "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",
    "label": "text",
    "description": "text",
    "active": true
  },
  "settledOpenItemRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "voucherCode": "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",
    "label": "text",
    "description": "text",
    "active": true
  },
  "components": [],
  "fabricationComponents": [],
  "bookings": [],
  "commissions": [],
  "previousDecisions": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "missingNode": true,
    "valueNode": true,
    "container": true,
    "integralNumber": true,
    "binary": true,
    "nodeType": "ARRAY",
    "string": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "floatingPointNumber": true,
    "number": true,
    "embeddedValue": true
  },
  "articleTaxLiabilityReversed": false,
  "taxLiabilityReversed": false,
  "presetPrice": 1,
  "calculationData": "text",
  "revenueCalculation": {
    "productPurchasePrice": 1,
    "salesValue": 1,
    "revenue": 1,
    "revenueInPercent": 1
  },
  "commissionOrigin": "NOT_COMMISSIONABLE",
  "cashDiscountable": true,
  "discountable": true,
  "commissionable": false,
  "warrantyInMonths": 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",
    "posLineType": "CASH_PAYMENT",
    "depositExpenseTypeId": 1,
    "paymentMethodId": 1,
    "externalPaymentId": "text",
    "externalPaymentStatus": "PENDING",
    "externalPaymentErrorMessage": "text",
    "paymentOperation": "PAYMENT",
    "cancelledExternalPaymentId": "text",
    "withdrawalMode": "FULL",
    "balanceBeforeWithdrawal": 1,
    "withdrawalAmount": 1,
    "withdrawToBalance": 1,
    "deletable": false
  },
  "fabricationDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "serialNumbers": [],
    "quantityCommitted": 1,
    "quantityInQA": 1,
    "quantityDefective": 1,
    "quantityFinished": 1,
    "custom": {
      "empty": true,
      "array": true,
      "null": true,
      "object": true,
      "float": true,
      "missingNode": true,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    }
  },
  "returnDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "returnCategory": "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER",
    "goodsExchangeArticleRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "waitForReturnBeforeExchange": true,
    "repairRequested": true,
    "warrantyExchange": true,
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "replacementDeliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "replacementDeliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "returnCauseRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "customerShareOnSurcharge": 1,
    "customerShareOnReduction": 1
  },
  "financeBooking": {
    "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"
  },
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "missingNode": true,
    "valueNode": true,
    "container": true,
    "integralNumber": true,
    "binary": true,
    "nodeType": "ARRAY",
    "string": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "floatingPointNumber": true,
    "number": true,
    "embeddedValue": true
  },
  "variantValues": [],
  "performanceDate": "2026-01-01",
  "basePrice": 1,
  "baseTotalLinePriceModifier": 1,
  "baseTotalDocumentPriceModifier": 1,
  "baseTotalLinePrice": 1,
  "baseSalesValueNet": 1,
  "progressInvoice": false,
  "dropShippingPolicy": "ANY",
  "unitGrossVolumeInCubicMeters": 1,
  "totalGrossVolumeInCubicMeters": 1,
  "convertedIntoBundleArticleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "onGoodsArrivalConvertIntoBundleArticleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "insertTerm": "MANUAL",
  "hasAccessories": false,
  "recalcLinePriceViaComponents": false,
  "doPrintLabel": false,
  "storageInfo": "text"
}

Change the delivery release state

put
Path parameters
documentIdinteger · int64Required
Query parameters
approvedbooleanRequired
Responses
200

OK

*/*
put/erp/documents/additional-functions/{documentId}/change-delivery-status
PUT /erp/documents/additional-functions/{documentId}/change-delivery-status?approved=true 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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Toggle the document finalization state: 'frozen' for purchase documents, 'published' for sales documents

post
Path parameters
documentIdinteger · int64Required
Responses
200

OK

*/*
post/erp/documents/additional-functions/{documentId}/toggle-finalized
POST /erp/documents/additional-functions/{documentId}/toggle-finalized 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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Add lines of different origins to an existing document

post
Path parameters
documentIdinteger · int64Required
Body

Request for adding several source lines to a document.

sourceLineIdsToIgnoreinteger · int64[]Optional

Identifiers of the DocumentLines to ignore.

sourceLineIdsToAddinteger · int64[]Optional

Identifiers of the DocumentLines to add to the document as a source.

Responses
200

OK

*/*
post/erp/documents/additional-functions/{documentId}/multiple_sourcelines
POST /erp/documents/additional-functions/{documentId}/multiple_sourcelines HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "variables": {
    "variableSubstitutions": []
  },
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "sourceLineIdsToIgnore": [
    1
  ],
  "sourceLineIdsToAdd": [
    1
  ]
}
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",
    "externalPaymentReference": "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,
      "valueNode": true,
      "container": true,
      "integralNumber": true,
      "binary": true,
      "nodeType": "ARRAY",
      "string": true,
      "pojo": true,
      "short": true,
      "int": true,
      "long": true,
      "double": true,
      "bigDecimal": true,
      "bigInteger": true,
      "boolean": true,
      "floatingPointNumber": true,
      "number": true,
      "embeddedValue": true
    },
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "mainSupplyType": "GOODS",
    "mainSupplyTypeOrigin": "AUTOMATIC",
    "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",
      "withdrawalFromClosing": false
    },
    "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,
        "valueNode": true,
        "container": true,
        "integralNumber": true,
        "binary": true,
        "nodeType": "ARRAY",
        "string": true,
        "pojo": true,
        "short": true,
        "int": true,
        "long": true,
        "double": true,
        "bigDecimal": true,
        "bigInteger": true,
        "boolean": true,
        "floatingPointNumber": 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
  }
}

Start the background job for creating a collective invoice

post
Body
accountIdstringRequired

Account identifier.

deliveryDocumentIdsToIgnoreinteger · int64[]Optional

Identifiers of the delivery documents to ignore (after the template resolution).

deliveryDocumentIdsToAddinteger · int64[]Optional

Identifiers of the delivery documents to process explicitly. When set, predicate and variables are not evaluated.

Responses
200

OK

*/*
contextstringOptional

message context

messageValuestringOptional

message

post/erp/documents/additional-functions/collectiveInvoice
POST /erp/documents/additional-functions/collectiveInvoice HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "accountId": "text",
  "deliveryDocumentVariables": {
    "variableSubstitutions": []
  },
  "deliveryDocumentQueryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "deliveryDocumentIdsToIgnore": [
    1
  ],
  "deliveryDocumentIdsToAdd": [
    1
  ]
}
200

OK

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

Query the possible valid document states

get
Path parameters
documentIdinteger · int64Required
Responses
200

OK

*/*

Document state instance.

labelstring · min: 1Required

label/name of this state

keystringRequired

unique key for this state

definitionstring · enumOptional

additional state information

Possible values:
get/erp/documents/additional-functions/{documentId}/possible-correct-state
GET /erp/documents/additional-functions/{documentId}/possible-correct-state HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "label": "text",
  "key": "text",
  "definition": "SELECTABLE_TYPES"
}

Last updated

Was this helpful?