Document

the Document API

create a new document

post

Body

application/json

transitionIdstringRequired

transition id

targetTypeIdinteger · int64Optional

Ggf. die ID der Ziel-Belegart

Responses

200

OK

*/*

post/erp/documents

HTTPcURLJavaScriptPython

POST /api/erp/documents HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 1863

{
  "transitionId": "text",
  "targetTypeId": 1,
  "parameters": [],
  "document": {
    "accountId": "text",
    "salesChannelId": "text",
    "externalId": "text",
    "externalNumber": "text",
    "billingType": "GROSS",
    "calculationMode": "HORIZONTAL",
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "supplierAccountId": 1,
    "lines": [],
    "targetDocumentType": {
      "version": "text",
      "info": {},
      "id": "text",
      "labels": [],
      "category": "CUSTOMER_OFFER",
      "showForManualDocumentCreation": true,
      "defaultTypeOfCategory": false,
      "active": true,
      "shelfDocumentTypeRef": {
        "id": "text"
      },
      "sequencerConfiguration": {
        "version": "text",
        "info": {},
        "id": "text",
        "configurationDetail": {
          "type": "NON_POOLED_SEQUENCES",
          "assignmentMode": "MANUAL",
          "length": 1,
          "padChar": "text",
          "expression": "text",
          "postExpression": "text",
          "initialValue": 1,
          "numberUnique": true
        },
        "alternativeConfiguration": {
          "id": "text"
        },
        "active": true
      },
      "requiresBusinessRelationship": true,
      "publishingPolicy": "AUTOMATIC",
      "sortOrder": 1
    },
    "incomingGoodsPickTrolleyId": 1,
    "incomingGoodsStorageBinId": 1,
    "priceModifiers": [],
    "posRegisterId": 1,
    "cashDrawerId": 1,
    "depositPaymentAmount": 1,
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posRegisterRef": {
        "id": "text"
      },
      "cashDrawerRef": {
        "id": "text"
      },
      "cashJournalRef": {
        "id": "text"
      },
      "fiscalizationBackendRef": {
        "id": "text"
      },
      "tssSignature": {},
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "posPayments": [],
    "texts": [],
    "custom": null,
    "einvoice": true
  }
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

update an existing document

put

Body

application/json

Responses

200

OK

*/*

put/erp/documents

HTTPcURLJavaScriptPython

PUT /api/erp/documents HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 5397

{
  "document": {
    "version": "text",
    "info": {},
    "id": "text",
    "number": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text"
    },
    "salesChannelRef": {
      "id": "text"
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "taxable": true,
    "taxIdentificationNumber": "text",
    "billingType": "GROSS",
    "documentState": {
      "label": "text",
      "key": "text",
      "definition": "SELECTABLE_TYPES"
    },
    "currencyCode": "text",
    "exchangeRate": 1,
    "exchangeRateOrigin": "AUTOMATIC",
    "responsibleUserRef": {
      "id": "text"
    },
    "paymentTermRef": {
      "id": "text",
      "paymentType": "PREPAYMENT"
    },
    "paymentMethodRef": {
      "id": "text"
    },
    "depositPaymentAmount": 1,
    "deliveryTermRef": {
      "id": "text"
    },
    "deliveryMethodRef": {
      "id": "text"
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "orderedOn": "2026-07-21",
    "orderedByPersonRef": {
      "id": "text"
    },
    "orderedBy": "text",
    "taxLiabilityReversed": false,
    "collectiveInvoice": false,
    "texts": [],
    "lines": [],
    "shippingCosts": [],
    "posPayments": [],
    "priceModifiers": [],
    "defaultAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "billingAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "deliveryAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "custom": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text"
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text"
    },
    "defaultStorageRef": {
      "id": "text"
    },
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posRegisterRef": {
        "id": "text"
      },
      "cashDrawerRef": {
        "id": "text"
      },
      "cashJournalRef": {
        "id": "text"
      },
      "fiscalizationBackendRef": {
        "id": "text"
      },
      "tssSignature": {},
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "minimumDegreeOfFulfillment": 1,
      "note": "text",
      "componentsStorageRef": {
        "id": "text"
      },
      "workbenchStorageRef": {
        "id": "text"
      },
      "workbenchStorageBinRef": {
        "id": "text"
      },
      "qualityAssuranceStorageRef": {
        "id": "text"
      },
      "qualityAssuranceStorageBinRef": {
        "id": "text"
      },
      "defectiveStorageRef": {
        "id": "text"
      },
      "defectiveStorageBinRef": {
        "id": "text"
      },
      "targetStorageRef": {
        "id": "text"
      },
      "targetStorageBinRef": {
        "id": "text"
      },
      "custom": null
    },
    "buyerReference": "text",
    "en16931Profile": "ZUGFERD",
    "paymentPlan": false,
    "calculationMode": "HORIZONTAL",
    "additionalInfo": {
      "taxSituationOrigin": "UNDEFINED",
      "languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
      "contextParameters": [],
      "incomingGoodsTarget": {
        "storageBinId": 1,
        "pickTrolleyId": 1
      },
      "translations": [],
      "incomingGoodsTargetsPerLine": [],
      "orderIntoPickingConvertResults": []
    },
    "languageCode": "text",
    "baseCurrencyCode": "text",
    "baseTotalNetPrice": 1,
    "baseTotalLinePriceModifier": 1,
    "baseTotalDocumentPriceModifier": 1,
    "baseTotalGrossPrice": 1,
    "baseDepositPaymentAmount": 1,
    "baseCashDiscountableTotalGrossPrice": 1,
    "forwardEmailToShipper": false,
    "forwardPhoneToShipper": false,
    "posReceiptPaymentSum": 1,
    "posReceiptBalance": 1,
    "posReceiptChangeAmount": 1,
    "posReceiptBalanced": false,
    "posReceiptPayed": false
  },
  "parameters": []
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

return all possible states, the document can transferred into

get

Path parameters

idinteger · int64Required

document identifier

Query parameters

languageCodestringRequired

Responses

200

OK

*/*

idstringRequired

das gleiche wie transition id für das UI

transitionIdstringRequired

transition id

transitionLabelstringRead-onlyOptional

label of this transition

uiHintanyOptional

Search-Dialog

stateDefinitionstringRead-onlyOptional

state definition of the target state

typeCategorystring · enumRead-onlyOptional

Dokumenttypen

Possible values:

typeIdstringRead-onlyOptional

document-type-id des ziels

typeKeystringRead-onlyOptional

document-type-key des ziels

typeLabelstringRead-onlyOptional

type-label

isDefaultTypeForCategorybooleanRead-onlyOptional

document-type ist Default für die Kategorie

targetStatestringRead-onlyOptional

Der Ziel-Status der Transition

sortOrderinteger · int32Read-onlyOptional

Sortier-Reihenfolge

get/erp/documents/{id}/states

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/states?languageCode=text HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

transfer the document into the given state

put

Path parameters

idinteger · int64Required

document identifier

Body

application/json

transitionIdstringRequired

transition id

Responses

200

OK

*/*

put/erp/documents/{id}/states

HTTPcURLJavaScriptPython

PUT /api/erp/documents/{id}/states HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 1846

{
  "transitionId": "text",
  "parameters": [],
  "document": {
    "accountId": "text",
    "salesChannelId": "text",
    "externalId": "text",
    "externalNumber": "text",
    "billingType": "GROSS",
    "calculationMode": "HORIZONTAL",
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "supplierAccountId": 1,
    "lines": [],
    "targetDocumentType": {
      "version": "text",
      "info": {},
      "id": "text",
      "labels": [],
      "category": "CUSTOMER_OFFER",
      "showForManualDocumentCreation": true,
      "defaultTypeOfCategory": false,
      "active": true,
      "shelfDocumentTypeRef": {
        "id": "text"
      },
      "sequencerConfiguration": {
        "version": "text",
        "info": {},
        "id": "text",
        "configurationDetail": {
          "type": "NON_POOLED_SEQUENCES",
          "assignmentMode": "MANUAL",
          "length": 1,
          "padChar": "text",
          "expression": "text",
          "postExpression": "text",
          "initialValue": 1,
          "numberUnique": true
        },
        "alternativeConfiguration": {
          "id": "text"
        },
        "active": true
      },
      "requiresBusinessRelationship": true,
      "publishingPolicy": "AUTOMATIC",
      "sortOrder": 1
    },
    "incomingGoodsPickTrolleyId": 1,
    "incomingGoodsStorageBinId": 1,
    "priceModifiers": [],
    "posRegisterId": 1,
    "cashDrawerId": 1,
    "depositPaymentAmount": 1,
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posRegisterRef": {
        "id": "text"
      },
      "cashDrawerRef": {
        "id": "text"
      },
      "cashJournalRef": {
        "id": "text"
      },
      "fiscalizationBackendRef": {
        "id": "text"
      },
      "tssSignature": {},
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "posPayments": [],
    "texts": [],
    "custom": null,
    "einvoice": true
  }
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

put

Path parameters

idinteger · int64Required

ID des Belegs

protocolIdinteger · int64Required

ID des Eintrags im Belegprotokoll

Body

application/json

Request zur Anlage eines manuellen Eintrags ins Belegprotokoll

customMessagestringRequired

Text für das Belegprotokoll

Responses

200

OK

*/*

Belegprotokoll

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentTypeIdinteger · int64Read-onlyOptional

Typ des Dokuments zu diesem Protokolleintrag

documentNumberstringRead-onlyOptional

Nummer des Dokuments zu diesem Protokolleintrag

typestring · enumRequired

Eintragsarten im DocumentProtocol

Possible values:

customMessagestringOptional

Text dieses Protokolleintrags

userNamestringRead-onlyOptional

Benutzer von dem der Eintrag angelegt wurde

timestampstring · date-timeOptional

Zeitstempel dieses Protokolleintrags

put/erp/documents/{id}/protocol/{protocolId}

HTTPcURLJavaScriptPython

PUT /api/erp/documents/{id}/protocol/{protocolId} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "customMessage": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentTypeId": 1,
  "documentTypeLabels": [],
  "documentNumber": "text",
  "type": "MANUAL",
  "customMessage": "text",
  "localizeableMessage": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  },
  "userName": "text",
  "timestamp": "2026-07-21T00:53:50.128Z"
}

get

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

anyOptional

get/erp/documents/{id}/print

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/print HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

No content

put

Path parameters

idinteger · int64Required

document identifier

Body

application/json

exportFormatstring · enumOptional

output-format für mail/file-export

Possible values:

exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

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

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Default: false

Responses

200

successful operation

application/octet-streamapplication/json

anyOptional

405

printing not allowed for the current document state

application/octet-streamapplication/json

put/erp/documents/{id}/print

HTTPcURLJavaScriptPython

PUT /api/erp/documents/{id}/print HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 129

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

No content

Verlängert eine Sperre

put

Path parameters

idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der zu verlängernden Sperre

Query parameters

leasePeriodinteger · int64Required

Optionale Lease-Dauer in Sekunden

Responses

200

OK

*/*

keystringRequired

tokeninteger · int64Required

userIdinteger · int64Optional

lockedBySystembooleanOptional

validUntilstring · date-timeOptional

idstringRead-onlyOptional

Unique identifier of the Object

Example: 1

put/erp/documents/{id}/leasable-lock/{lockToken}

HTTPcURLJavaScriptPython

PUT /api/erp/documents/{id}/leasable-lock/{lockToken}?leasePeriod=1 HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "key": "text",
  "token": 1,
  "userId": 1,
  "lockedBySystem": true,
  "validUntil": "2026-07-21T00:53:50.128Z",
  "id": "1"
}

Gibt ein Sperre frei

delete

Path parameters

idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der freizugebenden Sperre

Responses

200

OK

No content

delete/erp/documents/{id}/leasable-lock/{lockToken}

HTTPcURLJavaScriptPython

DELETE /api/erp/documents/{id}/leasable-lock/{lockToken} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

No content

Aktualisiert ein Paket zu einem Beleg

put

Path parameters

documentIdinteger · int64Required

parcelIdinteger · int64Required

Body

application/json

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

Responses

200

OK

*/*

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

put/erp/documents/{documentId}/parcel/{parcelId}

HTTPcURLJavaScriptPython

PUT /api/erp/documents/{documentId}/parcel/{parcelId} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "version": "text",
  "info": {},
  "id": "text",
  "documentRef": {
    "id": 1,
    "category": "CUSTOMER_OFFER",
    "documentType": "text",
    "documentState": "text",
    "number": "text"
  },
  "position": 1,
  "weight": 1,
  "weightUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "width": 1,
  "height": 1,
  "sizeUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "lines": []
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentRef": {
    "id": 1,
    "category": "CUSTOMER_OFFER",
    "documentType": "text",
    "documentState": "text",
    "number": "text"
  },
  "position": 1,
  "weight": 1,
  "weightUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "width": 1,
  "height": 1,
  "sizeUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "trackingNumber": "text",
  "lines": []
}

update an existing document with changed position

put

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

Body

application/json

Responses

200

OK

*/*

put/erp/documents/document/{documentId}/line/{lineId}

HTTPcURLJavaScriptPython

PUT /api/erp/documents/document/{documentId}/line/{lineId} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 3605

{
  "documentLine": {
    "version": "text",
    "info": {},
    "id": "text",
    "articleId": "text",
    "lineType": "ARTICLE_LINE",
    "productType": "WITH_STOCK",
    "number": "text",
    "name": "text",
    "description": "text",
    "unitType": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "price": 1,
    "priceUnit": 1,
    "priceSelectionCriteria": {
      "qualifier": "SALES",
      "articleIds": [
        1
      ],
      "selectOnlyDefaultPrice": false,
      "accountIds": [
        1
      ],
      "productGroupId": 1,
      "priceGroupId": 1,
      "date": "2026-07-21",
      "quantity": 1,
      "noteSpecialOfferPrice": true
    },
    "quantity": 1,
    "taxSchemaRef": {
      "id": "text"
    },
    "taxes": [],
    "priceModifiers": [],
    "texts": [],
    "deliveryTermRef": {
      "id": "text"
    },
    "deliveryMethodRef": {
      "id": "text"
    },
    "country": {
      "id": 1,
      "isoAlpha2": "text",
      "isoAlpha3": "text"
    },
    "countryRegion": {
      "id": "text"
    },
    "customsTariffNumber": "text",
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryText": "text",
    "packageOptions": "text",
    "externalReferenceVds": "text",
    "netWeight": 1,
    "totalNetWeight": 1,
    "netWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "grossWeight": 1,
    "totalGrossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "capacity": 1,
    "capacityUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "baseCapacity": 1,
    "baseCapacityUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "sourceLineRef": {
      "id": 1,
      "documentId": 1,
      "category": "CUSTOMER_OFFER",
      "documentType": "text",
      "documentState": "text",
      "number": "text",
      "articleNumber": "text",
      "position": 1,
      "name": "text",
      "quantity": 1,
      "price": 1,
      "displayName": "text"
    },
    "baseLineId": 1,
    "mainArticleLineRef": {
      "id": "text"
    },
    "customerOrderLineRef": {
      "id": 1,
      "documentId": 1,
      "category": "CUSTOMER_OFFER",
      "documentType": "text",
      "documentState": "text",
      "number": "text",
      "articleNumber": "text",
      "position": 1,
      "name": "text",
      "quantity": 1,
      "price": 1,
      "displayName": "text"
    },
    "supplierOrderLineIds": [
      1
    ],
    "storage": {
      "id": "text"
    },
    "components": [],
    "fabricationComponents": [],
    "bookings": [],
    "commissions": [],
    "previousDecisions": null,
    "calculationData": "text",
    "revenueCalculation": {},
    "commissionOrigin": "NOT_COMMISSIONABLE",
    "cashDiscountable": true,
    "discountable": true,
    "commissionable": false,
    "warrantyInMonths": 1,
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posLineType": "CASH_PAYMENT",
      "depositExpenseTypeId": 1,
      "paymentMethodId": 1,
      "externalPaymentId": "text",
      "externalPaymentStatus": "PENDING",
      "externalPaymentErrorMessage": "text",
      "paymentOperation": "PAYMENT",
      "cancelledExternalPaymentId": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "serialNumbers": [],
      "quantityCommitted": 1,
      "quantityInQA": 1,
      "quantityDefective": 1,
      "quantityFinished": 1,
      "custom": null
    },
    "financeBooking": {
      "version": "text",
      "info": {},
      "id": "text",
      "documentLineId": 1,
      "ledgerNumber": "text",
      "transactionKey": "text",
      "costCenter1": "text",
      "comment": "text",
      "description": "text"
    },
    "custom": null,
    "performanceDate": "2026-07-21",
    "basePrice": 1,
    "baseTotalLinePriceModifier": 1,
    "baseTotalDocumentPriceModifier": 1,
    "baseTotalLinePrice": 1,
    "baseSalesValueNet": 1,
    "progressInvoice": false,
    "dropShippingPolicy": "ANY",
    "unitGrossVolumeInCubicMeters": 1,
    "convertedIntoBundleArticleRef": {
      "id": "text"
    },
    "insertTerm": "MANUAL",
    "hasAccessories": false,
    "recalcLinePriceViaComponents": false
  },
  "additionalParameters": []
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

delete a line

delete

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

Responses

200

OK

*/*

delete/erp/documents/document/{documentId}/line/{lineId}

HTTPcURLJavaScriptPython

DELETE /api/erp/documents/document/{documentId}/line/{lineId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

moves a line to a new position

put

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

positioninteger · int32Required

Responses

200

OK

*/*

put/erp/documents/document/{documentId}/line/{lineId}/move/{position}

HTTPcURLJavaScriptPython

PUT /api/erp/documents/document/{documentId}/line/{lineId}/move/{position} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

get finance booking information for documentLine

get

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

Responses

200

OK

*/*

FiBu-Buchung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentLineIdinteger · int64Optional

Id der Dokumentzeile

ledgerNumberstringOptional

FiBu-Kontonummer

transactionKeystringOptional

Buchungsschlüssel

costCenter1stringOptional

Kostenstelle

commentstringOptional

Kommentar

descriptionstringOptional

Buchungstext

get/erp/documents/document/{documentId}/line/{lineId}/financebooking

HTTPcURLJavaScriptPython

GET /api/erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentLineId": 1,
  "ledgerNumber": "text",
  "transactionKey": "text",
  "costCenter1": "text",
  "comment": "text",
  "description": "text"
}

update finance booking information for documentLine

put

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

Body

application/json

FiBu-Buchung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentLineIdinteger · int64Optional

Id der Dokumentzeile

ledgerNumberstringOptional

FiBu-Kontonummer

transactionKeystringOptional

Buchungsschlüssel

costCenter1stringOptional

Kostenstelle

commentstringOptional

Kommentar

descriptionstringOptional

Buchungstext

Responses

200

OK

*/*

FiBu-Buchung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentLineIdinteger · int64Optional

Id der Dokumentzeile

ledgerNumberstringOptional

FiBu-Kontonummer

transactionKeystringOptional

Buchungsschlüssel

costCenter1stringOptional

Kostenstelle

commentstringOptional

Kommentar

descriptionstringOptional

Buchungstext

put/erp/documents/document/{documentId}/line/{lineId}/financebooking

HTTPcURLJavaScriptPython

PUT /api/erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "version": "text",
  "info": {},
  "id": "text",
  "documentLineId": 1,
  "ledgerNumber": "text",
  "transactionKey": "text",
  "costCenter1": "text",
  "comment": "text",
  "description": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentLineId": 1,
  "ledgerNumber": "text",
  "transactionKey": "text",
  "costCenter1": "text",
  "comment": "text",
  "description": "text"
}

delete finance booking information for documentLine

delete

Path parameters

documentIdinteger · int64Required

lineIdinteger · int64Required

Responses

200

OK

No content

delete/erp/documents/document/{documentId}/line/{lineId}/financebooking

HTTPcURLJavaScriptPython

DELETE /api/erp/documents/document/{documentId}/line/{lineId}/financebooking HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

No content

verify the taxIdentificationNumber

post

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

taxIdentificationNumberstring · max: 255Optional

Geprüfte Ust-ID

validitystring · enumOptional

Gültigkeit einer Ust-ID

Possible values:

validatedCompanyNamestringOptional

Geprüfter Firmenname

companyNameValidationResultstring · enumOptional

Ergebnis der Detail-Prüfung einer Ust-ID

Possible values:

validatedCitystringOptional

Geprüfter Ort

cityValidationResultstring · enumOptional

Ergebnis der Detail-Prüfung einer Ust-ID

Possible values:

validatedPostalCodestringOptional

Geprüfte PLZ

postalCodeValidationResultstring · enumOptional

Ergebnis der Detail-Prüfung einer Ust-ID

Possible values:

validatedStreetstringOptional

Geprüfte Straße

streetValidationResultstring · enumOptional

Ergebnis der Detail-Prüfung einer Ust-ID

Possible values:

usedApistring · enumOptional

USt-ID Prüfverfahren

Possible values:

apiResultCodestringOptional

Ergebnis-Code der Prüfung

apiResultMessagestringOptional

Ergebnis-Meldung der Prüfung (falls vorhanden

post/erp/documents/{id}/verifyTaxId

HTTPcURLJavaScriptPython

POST /api/erp/documents/{id}/verifyTaxId HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountAddressRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "documentAddressRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "taxIdentificationNumber": "text",
  "validity": "NOT_YET_VALIDATED",
  "validatedCompanyName": "text",
  "companyNameValidationResult": "VALID",
  "validatedCity": "text",
  "cityValidationResult": "VALID",
  "validatedPostalCode": "text",
  "postalCodeValidationResult": "VALID",
  "validatedStreet": "text",
  "streetValidationResult": "VALID",
  "usedApi": "NONE",
  "apiResultCode": "text",
  "apiResultMessage": "text"
}

list all available document-type-states to clone the current object into

get

Path parameters

idinteger · int64Required

document identifier

Query parameters

languageCodestringRequired

Responses

200

OK

*/*

idstringRequired

das gleiche wie transition id für das UI

transitionIdstringRequired

transition id

transitionLabelstringRead-onlyOptional

label of this transition

uiHintanyOptional

Search-Dialog

stateDefinitionstringRead-onlyOptional

state definition of the target state

typeCategorystring · enumRead-onlyOptional

Dokumenttypen

Possible values:

typeIdstringRead-onlyOptional

document-type-id des ziels

typeKeystringRead-onlyOptional

document-type-key des ziels

typeLabelstringRead-onlyOptional

type-label

isDefaultTypeForCategorybooleanRead-onlyOptional

document-type ist Default für die Kategorie

targetStatestringRead-onlyOptional

Der Ziel-Status der Transition

sortOrderinteger · int32Read-onlyOptional

Sortier-Reihenfolge

get/erp/documents/{id}/types

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/types?languageCode=text HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

create a new document, based on an existing one

post

Path parameters

idinteger · int64Required

the document identifier used as spec for the new document

Body

application/json

transitionIdstringRequired

transition id

targetTypeIdinteger · int64Optional

Ggf. die ID der Ziel-Belegart

Responses

200

OK

*/*

post/erp/documents/{id}/types

HTTPcURLJavaScriptPython

POST /api/erp/documents/{id}/types HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 1863

{
  "transitionId": "text",
  "targetTypeId": 1,
  "parameters": [],
  "document": {
    "accountId": "text",
    "salesChannelId": "text",
    "externalId": "text",
    "externalNumber": "text",
    "billingType": "GROSS",
    "calculationMode": "HORIZONTAL",
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "supplierAccountId": 1,
    "lines": [],
    "targetDocumentType": {
      "version": "text",
      "info": {},
      "id": "text",
      "labels": [],
      "category": "CUSTOMER_OFFER",
      "showForManualDocumentCreation": true,
      "defaultTypeOfCategory": false,
      "active": true,
      "shelfDocumentTypeRef": {
        "id": "text"
      },
      "sequencerConfiguration": {
        "version": "text",
        "info": {},
        "id": "text",
        "configurationDetail": {
          "type": "NON_POOLED_SEQUENCES",
          "assignmentMode": "MANUAL",
          "length": 1,
          "padChar": "text",
          "expression": "text",
          "postExpression": "text",
          "initialValue": 1,
          "numberUnique": true
        },
        "alternativeConfiguration": {
          "id": "text"
        },
        "active": true
      },
      "requiresBusinessRelationship": true,
      "publishingPolicy": "AUTOMATIC",
      "sortOrder": 1
    },
    "incomingGoodsPickTrolleyId": 1,
    "incomingGoodsStorageBinId": 1,
    "priceModifiers": [],
    "posRegisterId": 1,
    "cashDrawerId": 1,
    "depositPaymentAmount": 1,
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posRegisterRef": {
        "id": "text"
      },
      "cashDrawerRef": {
        "id": "text"
      },
      "cashJournalRef": {
        "id": "text"
      },
      "fiscalizationBackendRef": {
        "id": "text"
      },
      "tssSignature": {},
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "posPayments": [],
    "texts": [],
    "custom": null,
    "einvoice": true
  }
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

Creates a shipment within the vds from a given document id

post

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

shipmentIdinteger · int64Optional

description/delivery Text of this order (internal vds description)

post/erp/documents/{id}/shipment

HTTPcURLJavaScriptPython

POST /api/erp/documents/{id}/shipment HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "shipmentId": 1
}

Lists all protocol entries for this document

get

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

Belegprotokoll

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentTypeIdinteger · int64Read-onlyOptional

Typ des Dokuments zu diesem Protokolleintrag

documentNumberstringRead-onlyOptional

Nummer des Dokuments zu diesem Protokolleintrag

typestring · enumRequired

Eintragsarten im DocumentProtocol

Possible values:

customMessagestringOptional

Text dieses Protokolleintrags

userNamestringRead-onlyOptional

Benutzer von dem der Eintrag angelegt wurde

timestampstring · date-timeOptional

Zeitstempel dieses Protokolleintrags

get/erp/documents/{id}/protocol

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/protocol HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

post

Path parameters

idinteger · int64Required

ID des Belegs

Body

application/json

Request zur Anlage eines manuellen Eintrags ins Belegprotokoll

customMessagestringRequired

Text für das Belegprotokoll

Responses

200

OK

*/*

Belegprotokoll

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentTypeIdinteger · int64Read-onlyOptional

Typ des Dokuments zu diesem Protokolleintrag

documentNumberstringRead-onlyOptional

Nummer des Dokuments zu diesem Protokolleintrag

typestring · enumRequired

Eintragsarten im DocumentProtocol

Possible values:

customMessagestringOptional

Text dieses Protokolleintrags

userNamestringRead-onlyOptional

Benutzer von dem der Eintrag angelegt wurde

timestampstring · date-timeOptional

Zeitstempel dieses Protokolleintrags

post/erp/documents/{id}/protocol

HTTPcURLJavaScriptPython

POST /api/erp/documents/{id}/protocol HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "customMessage": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentTypeId": 1,
  "documentTypeLabels": [],
  "documentNumber": "text",
  "type": "MANUAL",
  "customMessage": "text",
  "localizeableMessage": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  },
  "userName": "text",
  "timestamp": "2026-07-21T00:53:50.128Z"
}

Prüft, ob eine Resource gesperrt ist

get

Path parameters

idinteger · int64Required

ID einer Resource

Responses

200

OK

*/*

keystringRequired

tokeninteger · int64Required

userIdinteger · int64Optional

lockedBySystembooleanOptional

validUntilstring · date-timeOptional

idstringRead-onlyOptional

Unique identifier of the Object

Example: 1

get/erp/documents/{id}/leasable-lock

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/leasable-lock HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "key": "text",
  "token": 1,
  "userId": 1,
  "lockedBySystem": true,
  "validUntil": "2026-07-21T00:53:50.128Z",
  "id": "1"
}

Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer

post

Path parameters

idinteger · int64Required

ID der zu sperrenden Resource

Query parameters

leasePeriodinteger · int64Optional

Optionale Lease-Dauer in Sekunden

Responses

200

OK

*/*

keystringRequired

tokeninteger · int64Required

userIdinteger · int64Optional

lockedBySystembooleanOptional

validUntilstring · date-timeOptional

idstringRead-onlyOptional

Unique identifier of the Object

Example: 1

post/erp/documents/{id}/leasable-lock

HTTPcURLJavaScriptPython

POST /api/erp/documents/{id}/leasable-lock HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "key": "text",
  "token": 1,
  "userId": 1,
  "lockedBySystem": true,
  "validUntil": "2026-07-21T00:53:50.128Z",
  "id": "1"
}

Versucht einen Auftrag in Kommissionierung zu übernehmen und protokolliert das Ergebnis

post

Path parameters

documentIdinteger · int64Required

picklistTemplateIdinteger · int64Required

Responses

200

OK

No content

post/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}

HTTPcURLJavaScriptPython

POST /api/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

No content

post

Path parameters

documentIdinteger · int64Required

Body

application/json

Request zur Eingabeverarbeitung zu Belegen

inputDatastringOptional

Benutzereingabe/Scan

lastProcessedLineIdinteger · int64Optional

Die letzte verarbeitete Position

lastProcessedBookingIdinteger · int64Optional

Die letzte verarbeitete Buchung

inputListstring[]Optional

Liste von Eingaben, die nacheinander ausgeführt werden

Responses

200

OK

*/*

Response zur Eingabeverarbeitung zu Belegen

lastProcessedLineIdinteger · int64Optional

Die letzte verarbeitete Position

lastProcessedBookingIdinteger · int64Optional

Die letzte verarbeitete Buchung

post/erp/documents/{documentId}/process-input

HTTPcURLJavaScriptPython

POST /api/erp/documents/{documentId}/process-input HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "inputData": "text",
  "lastProcessedLineId": 1,
  "lastProcessedBookingId": 1,
  "inputList": [
    "text"
  ]
}

200

OK

{
  "message": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  },
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "languageCode": "text",
    "baseCurrencyCode": "text",
    "baseTotalNetPrice": 1,
    "baseTotalLinePriceModifier": 1,
    "baseTotalDocumentPriceModifier": 1,
    "baseTotalGrossPrice": 1,
    "baseDepositPaymentAmount": 1,
    "baseCashDiscountableTotalGrossPrice": 1,
    "forwardEmailToShipper": false,
    "forwardPhoneToShipper": false,
    "posReceiptPaymentSum": 1,
    "posReceiptBalance": 1,
    "posReceiptChangeAmount": 1,
    "posReceiptBalanced": false,
    "posReceiptPayed": false,
    "dropShipping": true,
    "totalGrossVolumeInCubicMeters": 1
  },
  "lastProcessedLineId": 1,
  "lastProcessedBookingId": 1,
  "validationHints": {
    "details": []
  }
}

Liefert die Pakete zu einem Beleg

get

Path parameters

documentIdinteger · int64Required

Responses

200

OK

*/*

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

get/erp/documents/{documentId}/parcels

HTTPcURLJavaScriptPython

GET /api/erp/documents/{documentId}/parcels HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

Erstellt ein Paket zu einem Beleg

post

Path parameters

documentIdinteger · int64Required

Body

application/json

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

Responses

200

OK

*/*

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

post/erp/documents/{documentId}/parcels

HTTPcURLJavaScriptPython

POST /api/erp/documents/{documentId}/parcels HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "version": "text",
  "info": {},
  "id": "text",
  "documentRef": {
    "id": 1,
    "category": "CUSTOMER_OFFER",
    "documentType": "text",
    "documentState": "text",
    "number": "text"
  },
  "position": 1,
  "weight": 1,
  "weightUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "width": 1,
  "height": 1,
  "sizeUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "lines": []
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentRef": {
    "id": 1,
    "category": "CUSTOMER_OFFER",
    "documentType": "text",
    "documentState": "text",
    "number": "text"
  },
  "position": 1,
  "weight": 1,
  "weightUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "length": 1,
  "width": 1,
  "height": 1,
  "sizeUnitTypeRef": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "trackingNumber": "text",
  "lines": []
}

Create a Job according to the Request

post

Body

application/json

Request zur Erstellung des Jobs für Abrechnungen der Verträge

blackListinteger · int64[]Optional

Ignore ID-List

whiteListinteger · int64[]Optional

Use ID-List

documentDatestring · dateOptional

Abweichendes Belegdatum

deliveryDatestring · dateOptional

Abweichendes Lieferdatum

addBillingPeriodbooleanOptional

Abrechnungszeitraum hinzufügen?

Default: true

notestringOptional

Notiz

printbooleanOptional

Drucken?

Default: false

Responses

200

OK

*/*

contextstringOptional

message context

messageValuestringOptional

message

post/erp/documents/perform-contract-evaluation

HTTPcURLJavaScriptPython

POST /api/erp/documents/perform-contract-evaluation HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "blackList": [
    1
  ],
  "whiteList": [
    1
  ],
  "variableSubstitutionList": {
    "variableSubstitutions": []
  },
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "documentDate": "2026-07-21",
  "deliveryDate": "2026-07-21",
  "addBillingPeriod": true,
  "note": "text",
  "print": false
}

200

OK

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

validate a document by using the validation service

post

Path parameters

documentIdinteger · int64Required

Responses

200

OK

*/*

systemErrorstringOptional

shelfDocumentIdinteger · int64Optional

post/erp/documents/document/{documentId}/validate

HTTPcURLJavaScriptPython

POST /api/erp/documents/document/{documentId}/validate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "xmlDetails": {
    "valid": true,
    "hasWarnings": true,
    "validSchema": true,
    "validNamespaces": true,
    "validEncoding": true,
    "validCodelists": true,
    "validFormat": true,
    "validVat": true,
    "validBusinessRules": true,
    "validProfile": [],
    "warnings": [
      "text"
    ],
    "information": [
      "text"
    ],
    "errors": [
      "text"
    ]
  },
  "pdfDetails": {
    "valid": true,
    "foundFlavour": "text",
    "warnings": [
      "text"
    ],
    "information": [
      "text"
    ],
    "errors": [
      "text"
    ]
  },
  "embeddingDetails": {
    "validFileEmbedding": true,
    "validFilename": true,
    "validXMP": true,
    "canExtractXML": true,
    "versionFromXML": "text",
    "documentTypeFromXML": "text",
    "guidelineFromXML": "text",
    "variantFromXML": "text",
    "warnings": [
      "text"
    ],
    "information": [
      "text"
    ],
    "errors": [
      "text"
    ]
  },
  "systemError": "text",
  "shelfDocumentId": 1
}

add new lines to an existing document

post

Path parameters

documentIdinteger · int64Required

Body

application/json

Responses

200

OK

*/*

post/erp/documents/document/{documentId}/multiple_lines

HTTPcURLJavaScriptPython

POST /api/erp/documents/document/{documentId}/multiple_lines HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "documentLines": [],
  "additionalParameters": []
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

add a new line to an existing document

post

Path parameters

documentIdinteger · int64Required

Body

application/json

Responses

200

OK

*/*

post/erp/documents/document/{documentId}/line

HTTPcURLJavaScriptPython

POST /api/erp/documents/document/{documentId}/line HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 3605

{
  "documentLine": {
    "version": "text",
    "info": {},
    "id": "text",
    "articleId": "text",
    "lineType": "ARTICLE_LINE",
    "productType": "WITH_STOCK",
    "number": "text",
    "name": "text",
    "description": "text",
    "unitType": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "price": 1,
    "priceUnit": 1,
    "priceSelectionCriteria": {
      "qualifier": "SALES",
      "articleIds": [
        1
      ],
      "selectOnlyDefaultPrice": false,
      "accountIds": [
        1
      ],
      "productGroupId": 1,
      "priceGroupId": 1,
      "date": "2026-07-21",
      "quantity": 1,
      "noteSpecialOfferPrice": true
    },
    "quantity": 1,
    "taxSchemaRef": {
      "id": "text"
    },
    "taxes": [],
    "priceModifiers": [],
    "texts": [],
    "deliveryTermRef": {
      "id": "text"
    },
    "deliveryMethodRef": {
      "id": "text"
    },
    "country": {
      "id": 1,
      "isoAlpha2": "text",
      "isoAlpha3": "text"
    },
    "countryRegion": {
      "id": "text"
    },
    "customsTariffNumber": "text",
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryText": "text",
    "packageOptions": "text",
    "externalReferenceVds": "text",
    "netWeight": 1,
    "totalNetWeight": 1,
    "netWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "grossWeight": 1,
    "totalGrossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "capacity": 1,
    "capacityUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "baseCapacity": 1,
    "baseCapacityUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "sourceLineRef": {
      "id": 1,
      "documentId": 1,
      "category": "CUSTOMER_OFFER",
      "documentType": "text",
      "documentState": "text",
      "number": "text",
      "articleNumber": "text",
      "position": 1,
      "name": "text",
      "quantity": 1,
      "price": 1,
      "displayName": "text"
    },
    "baseLineId": 1,
    "mainArticleLineRef": {
      "id": "text"
    },
    "customerOrderLineRef": {
      "id": 1,
      "documentId": 1,
      "category": "CUSTOMER_OFFER",
      "documentType": "text",
      "documentState": "text",
      "number": "text",
      "articleNumber": "text",
      "position": 1,
      "name": "text",
      "quantity": 1,
      "price": 1,
      "displayName": "text"
    },
    "supplierOrderLineIds": [
      1
    ],
    "storage": {
      "id": "text"
    },
    "components": [],
    "fabricationComponents": [],
    "bookings": [],
    "commissions": [],
    "previousDecisions": null,
    "calculationData": "text",
    "revenueCalculation": {},
    "commissionOrigin": "NOT_COMMISSIONABLE",
    "cashDiscountable": true,
    "discountable": true,
    "commissionable": false,
    "warrantyInMonths": 1,
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posLineType": "CASH_PAYMENT",
      "depositExpenseTypeId": 1,
      "paymentMethodId": 1,
      "externalPaymentId": "text",
      "externalPaymentStatus": "PENDING",
      "externalPaymentErrorMessage": "text",
      "paymentOperation": "PAYMENT",
      "cancelledExternalPaymentId": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "serialNumbers": [],
      "quantityCommitted": 1,
      "quantityInQA": 1,
      "quantityDefective": 1,
      "quantityFinished": 1,
      "custom": null
    },
    "financeBooking": {
      "version": "text",
      "info": {},
      "id": "text",
      "documentLineId": 1,
      "ledgerNumber": "text",
      "transactionKey": "text",
      "costCenter1": "text",
      "comment": "text",
      "description": "text"
    },
    "custom": null,
    "performanceDate": "2026-07-21",
    "basePrice": 1,
    "baseTotalLinePriceModifier": 1,
    "baseTotalDocumentPriceModifier": 1,
    "baseTotalLinePrice": 1,
    "baseSalesValueNet": 1,
    "progressInvoice": false,
    "dropShippingPolicy": "ANY",
    "unitGrossVolumeInCubicMeters": 1,
    "convertedIntoBundleArticleRef": {
      "id": "text"
    },
    "insertTerm": "MANUAL",
    "hasAccessories": false,
    "recalcLinePriceViaComponents": false
  },
  "additionalParameters": []
}

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

post

Path parameters

contractIdinteger · int64Required

ID eines Vertrags

contractLineIdinteger · int64Required

ID einer Vertragsposition

Responses

200

OK

*/*

post/erp/documents/contract/{contractId}/deactivate-line/{contractLineId}

HTTPcURLJavaScriptPython

POST /api/erp/documents/contract/{contractId}/deactivate-line/{contractLineId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

post

Path parameters

contractIdinteger · int64Required

ID eines Vertrags

contractLineIdinteger · int64Required

ID einer Vertragsposition

Responses

200

OK

*/*

post/erp/documents/contract/{contractId}/activate-line/{contractLineId}

HTTPcURLJavaScriptPython

POST /api/erp/documents/contract/{contractId}/activate-line/{contractLineId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get/erp/documents/{id}

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

patch

Path parameters

idinteger · int64Required

Body

application/json

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

patch/erp/documents/{id}

HTTPcURLJavaScriptPython

PATCH /api/erp/documents/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 5397

{
  "document": {
    "version": "text",
    "info": {},
    "id": "text",
    "number": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text"
    },
    "salesChannelRef": {
      "id": "text"
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "taxable": true,
    "taxIdentificationNumber": "text",
    "billingType": "GROSS",
    "documentState": {
      "label": "text",
      "key": "text",
      "definition": "SELECTABLE_TYPES"
    },
    "currencyCode": "text",
    "exchangeRate": 1,
    "exchangeRateOrigin": "AUTOMATIC",
    "responsibleUserRef": {
      "id": "text"
    },
    "paymentTermRef": {
      "id": "text",
      "paymentType": "PREPAYMENT"
    },
    "paymentMethodRef": {
      "id": "text"
    },
    "depositPaymentAmount": 1,
    "deliveryTermRef": {
      "id": "text"
    },
    "deliveryMethodRef": {
      "id": "text"
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "orderedOn": "2026-07-21",
    "orderedByPersonRef": {
      "id": "text"
    },
    "orderedBy": "text",
    "taxLiabilityReversed": false,
    "collectiveInvoice": false,
    "texts": [],
    "lines": [],
    "shippingCosts": [],
    "posPayments": [],
    "priceModifiers": [],
    "defaultAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "billingAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "deliveryAddress": {
      "version": "text",
      "info": {},
      "id": "text",
      "accountRef": {
        "id": "text"
      },
      "salutation": "text",
      "name1": "text",
      "name2": "text",
      "name3": "text",
      "globalLocationNumber": "text",
      "street": "text",
      "streetAddressNumber": "text",
      "additionalAddressLine1": "text",
      "additionalAddressLine2": "text",
      "city": "text",
      "regionRef": {
        "id": "text"
      },
      "postcode": "text",
      "postOfficeBox": "text",
      "countryCode": "text",
      "phoneContact": "text",
      "mailContact": "text",
      "languageCode": "text",
      "paymentTermRef": {
        "id": "text"
      },
      "paymentMethodRef": {
        "id": "text"
      },
      "deliveryTermRef": {
        "id": "text"
      },
      "deliveryMethodRef": {
        "id": "text"
      }
    },
    "custom": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text"
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text"
    },
    "defaultStorageRef": {
      "id": "text"
    },
    "contractDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "posRegisterRef": {
        "id": "text"
      },
      "cashDrawerRef": {
        "id": "text"
      },
      "cashJournalRef": {
        "id": "text"
      },
      "fiscalizationBackendRef": {
        "id": "text"
      },
      "tssSignature": {},
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {},
      "id": "text",
      "startDate": "2026-07-21",
      "minimumDegreeOfFulfillment": 1,
      "note": "text",
      "componentsStorageRef": {
        "id": "text"
      },
      "workbenchStorageRef": {
        "id": "text"
      },
      "workbenchStorageBinRef": {
        "id": "text"
      },
      "qualityAssuranceStorageRef": {
        "id": "text"
      },
      "qualityAssuranceStorageBinRef": {
        "id": "text"
      },
      "defectiveStorageRef": {
        "id": "text"
      },
      "defectiveStorageBinRef": {
        "id": "text"
      },
      "targetStorageRef": {
        "id": "text"
      },
      "targetStorageBinRef": {
        "id": "text"
      },
      "custom": null
    },
    "buyerReference": "text",
    "en16931Profile": "ZUGFERD",
    "paymentPlan": false,
    "calculationMode": "HORIZONTAL",
    "additionalInfo": {
      "taxSituationOrigin": "UNDEFINED",
      "languageCodeOrigin": "FROM_DELIVERY_ADDRESS",
      "contextParameters": [],
      "incomingGoodsTarget": {
        "storageBinId": 1,
        "pickTrolleyId": 1
      },
      "translations": [],
      "incomingGoodsTargetsPerLine": [],
      "orderIntoPickingConvertResults": []
    },
    "languageCode": "text",
    "baseCurrencyCode": "text",
    "baseTotalNetPrice": 1,
    "baseTotalLinePriceModifier": 1,
    "baseTotalDocumentPriceModifier": 1,
    "baseTotalGrossPrice": 1,
    "baseDepositPaymentAmount": 1,
    "baseCashDiscountableTotalGrossPrice": 1,
    "forwardEmailToShipper": false,
    "forwardPhoneToShipper": false,
    "posReceiptPaymentSum": 1,
    "posReceiptBalance": 1,
    "posReceiptChangeAmount": 1,
    "posReceiptBalanced": false,
    "posReceiptPayed": false
  },
  "parameters": []
}

{
  "document": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "number": "text",
    "accountNumber": "text",
    "customerNumber": "text",
    "ourCustomerNumber": "text",
    "supplierNumber": "text",
    "salesAgentNumber": "text",
    "externalIdentifier": "text",
    "externalNumber": "text",
    "published": false,
    "frozen": false,
    "qualifier": "SALE",
    "accountId": "text",
    "billingAccountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "documentDate": "2026-07-21",
    "performanceDate": "2026-07-21",
    "valueDate": "2026-07-21",
    "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"
    },
    "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-07-21",
    "deliveryTermRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryMethodRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "deliveryDate": "2026-07-21",
    "deliveryDateEnd": "2026-07-21",
    "confirmedDeliveryDate": "2026-07-21",
    "confirmedDeliveryDateEnd": "2026-07-21",
    "shippingDate": "2026-07-21",
    "deliveryQuantityPackages": 1,
    "deliveryText": "text",
    "deliveryApproved": true,
    "dropShippingInvoiceApproved": true,
    "orderedOn": "2026-07-21",
    "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "accountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "salutation": "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": null,
    "stackProcessingType": "NO_PICKING",
    "stackProcessingPriority": 1,
    "maxDeliveries": 1,
    "taxPerformanceLocation": "DOMESTIC",
    "performanceCountryCode": "text",
    "sourceCountryCode": "text",
    "afterPickingTargetDocumentTypeRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "grossWeight": 1,
    "grossWeightUnit": {
      "id": 1,
      "name": "text",
      "abbreviation": "text"
    },
    "userDefinedWeight": false,
    "tags": [],
    "reportGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "defaultStorageRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDiscountableTotalGrossPrice": 1,
    "contractDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "endDate": "2026-07-21",
      "runtimeFromDate": "2026-07-21",
      "runtimeToDate": "2026-07-21",
      "lastCustomerCancellationDate": "2026-07-21",
      "lastProviderCancellationDate": "2026-07-21",
      "dueDateCalculation": "text",
      "dueDate": "2026-07-21",
      "nextDueDate": "2026-07-21",
      "calculateDirectly": true,
      "active": true,
      "publishInPortal": false
    },
    "posDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "posRegisterRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashDrawerRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "cashJournalRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fiscalizationBackendRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "tssSignature": {
        "status": "FINISHED",
        "responseData": "text",
        "externalReference": "text",
        "revision": 1
      },
      "externalReference": "text",
      "timeStart": 1,
      "timeEnd": 1,
      "clientSerialNumber": "text",
      "tssSerialNumber": "text",
      "transactionNumber": 1,
      "revision": 1,
      "signatureCounter": 1,
      "signature": "text"
    },
    "fabricationDetail": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "startDate": "2026-07-21",
      "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": null
    },
    "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": [],
      "orderIntoPickingConvertResults": []
    },
    "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-07-21T00:53:50.128Z",
      "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": []
  }
}

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

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

string · enumOptional

Status einer Workflow-Instanz

Possible values:

404

Es existiert noch keine Workflow-Instanz

*/*

get/erp/documents/{refId}/workflow-state

HTTPcURLJavaScriptPython

GET /api/erp/documents/{refId}/workflow-state HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

CREATED

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

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

Adhoc Preset

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT

Default: QUERYPossible values:

templateIdstringRequired

template dem dieser filter zugeordnet worden ist.

templateGroupKeystringRequired

templateGroupKey dem dieser filter zugeordnet worden ist.

labelstringRequired

label für diesen filter

uiPayloadanyOptional

Search-Dialog

queryStatementstringOptional

bei mode == STATEMENT, das vql-query

forWorkflowbooleanRequired

für Workflows vorgesehen

Default: false

outputReportGroupIdentifierstringOptional

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

get/erp/documents/{refId}/workflow-instances-preset

HTTPcURLJavaScriptPython

GET /api/erp/documents/{refId}/workflow-instances-preset HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

Workflow-Instanz gefunden

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "QUERY",
  "templateId": "text",
  "templateGroupKey": "text",
  "label": "text",
  "uiPayload": null,
  "variables": [],
  "queryStatement": "text",
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "results": [],
  "sortAndOrders": [],
  "pageable": {
    "limit": 1
  },
  "option": {
    "distinctResult": true
  },
  "transformations": [],
  "arithmeticQueryTerms": [],
  "definition": [
    {
      "_type": "text",
      "definition": "[Circular Reference]",
      "value": "[Circular Reference]",
      "key": "text",
      "attribute": "text",
      "path": "text",
      "displayName": "text",
      "displayNameOverride": false,
      "groupDisplayName": "text",
      "parentDisplayName": "text",
      "resultable": true,
      "filterable": true,
      "sortable": true,
      "visible": true,
      "functions": [
        "text"
      ],
      "sortDirection": "text",
      "constraint": {
        "minLength": 1,
        "maxLength": 1,
        "minValue": 1,
        "includeMinValue": true,
        "maxValue": 1,
        "includeMaxValue": true,
        "notNull": false,
        "notBlank": true
      },
      "dataType": {
        "identifier": "text",
        "jsType": "text",
        "objectRefIdentifier": "text",
        "filterOptions": {
          "filterValues": [
            "text"
          ],
          "filterDialog": null,
          "multipleChoice": false
        },
        "functions": [
          "text"
        ],
        "predicateOperations": [
          "AND"
        ]
      },
      "dataTypeIdentifier": "text",
      "modelType": "STATIC",
      "entityIdentifier": "text",
      "referencedEntityIdentifier": "text",
      "headers": []
    }
  ],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  },
  "forWorkflow": false,
  "outputReportGroupIdentifier": "text",
  "userOptions": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "pinned": false
  }
}

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get

Path parameters

refIdinteger · int64Required

Responses

200

Workflow-Instanz gefunden

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

statestring · enumOptional

Status einer Workflow-Instanz

Possible values:

404

Es existiert noch keine Workflow-Instanz

*/*

get/erp/documents/{refId}/latest-workflow-instance

HTTPcURLJavaScriptPython

GET /api/erp/documents/{refId}/latest-workflow-instance HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [],
  "logEntries": []
}

Lists all ui-hints for this document

get

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

documentHintsstring[]Optional

UI-Hints, die sich auf den Dokumenttypen und den Account beziehen

get/erp/documents/{id}/ui-hints

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/ui-hints HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "documentHints": [
    "text"
  ],
  "positionHints": []
}

Lists all ui-hints for this document

get

Path parameters

idinteger · int64Required

document identifier

articleIdinteger · int64Required

article identifier

Responses

200

OK

*/*

string[]Optional

get/erp/documents/{id}/ui-hints/article/{articleId}

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/ui-hints/article/{articleId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[
  "text"
]

Lists all ui-hints for this document

get

Path parameters

idinteger · int64Required

document identifier

accountIdinteger · int64Required

account identifier

Responses

200

OK

*/*

string[]Optional

get/erp/documents/{id}/ui-hints/account/{accountId}

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/ui-hints/account/{accountId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[
  "text"
]

return a tree of predecessors and successors of this document

get

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

documentIdstringOptional

the id of the document

numberstringOptional

the number of the document

documentDatestring · dateOptional

documentDate

totalGrossPricenumberOptional

gross total price (GROSS)

documentTypestringOptional

type of this document

documentTypeIdstringOptional

typeId of this document

documentStatestringOptional

state of this document

documentTypeCategorystringOptional

category of this document

requestedbooleanOptional

indicates that this document was requested

Default: false

chainIdentifierstringOptional

Belegketten-Id

get/erp/documents/{id}/types/history

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/types/history HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

Gibt die manuellen Textbausteine für Kopf-/Fußtexte zurück, die für das Dokument Sinn ergeben

get

Path parameters

idinteger · int64Required

Query parameters

textPositionstring · enumRequiredPossible values:

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

get/erp/documents/{id}/text-templates

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/text-templates?textPosition=HEADER_TEXT HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

Lists successor document lines for predecessor assignment

get

Path parameters

idinteger · int64Required

ID of successor document

Responses

200

OK

*/*

Belegpositionen für die Vorbelegszuordnung

get/erp/documents/{id}/successor-document-assignable-lines

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/successor-document-assignable-lines HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "unassignedLines": [],
  "uncompletedLines": [],
  "completedLines": []
}

Lists predecessor document lines for predecessor assignment

get

Path parameters

idinteger · int64Required

ID of predecessor document

Responses

200

OK

*/*

Liste der Belegpositionen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Read-onlyOptional

Positions-Nummer

positionOfArticleLineinteger · int32Read-onlyOptional

Positionsnummer über alle Artikelpositionen hinweg

articleIdstringOptional

Artikel

lineTypestring · enumRequired

Positionstyp

Possible values:

productTypestring · enumOptional

Artikelarten

Possible values:

serialTypestring · enumRead-onlyOptional

Serientyp eines Artikels

Possible values:

numberstring · max: 255Optional

Artikelnummer

namestring · max: 255Optional

Name des Artikels

descriptionstring · max: 2147483647Optional

Beschreibung des Artikels

pricenumberOptional

Preis pro Menge [Brutto, Netto]

priceUnitnumberOptional

Preiseinheit

priceOriginstring · enumRead-onlyOptional

Preisherkunft

Possible values:

quantitynumberOptional

Menge

quantityCommittednumberRead-onlyOptional

verarbeitete Menge

pickingQuantitynumberRead-onlyOptional

Menge in Pick-Vorgang

preOrderPickedQuantitynumberRead-onlyOptional

vorgeorderte Menge in Pickvorgang

completebooleanRead-onlyOptional

ist diese Position komplett verarbeitet?

Default: false

totalLinePriceModifiernumberRead-onlyOptional

Summe Positionspreisänderungen [Brutto, Netto]

totalDocumentPriceModifiernumberRead-onlyOptional

Summe Dokumentpreisänderungen [Brutto, Netto]

salesValueNetnumberRead-onlyOptional

Netto-Gesamtpreis (nach Preisänderungen)

vatnumberRead-onlyOptional

Steuerbetrag

totalLinePricenumberRead-onlyOptional

Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte

customsTariffNumberstring · max: 15Optional

Zolltarifnummer

deliveryDatestring · dateOptional

Lieferdatum

deliveryDateEndstring · dateOptional

vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)

confirmedDeliveryDatestring · dateOptional

bestätigtes Lieferdatum

confirmedDeliveryDateEndstring · dateOptional

bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)

shippingDatestring · dateOptional

Versanddatum

deliveryTextstring · max: 255Optional

Liefertext

packageOptionsstringOptional

Versenderspezifische Informationen

externalReferenceVdsstring · max: 255Optional

Externe Referenz zum VDS-Paket

netWeightnumberOptional

Nettogewicht

totalNetWeightnumberOptional

Gesamtnettogewicht

grossWeightnumberOptional

Bruttogewicht

totalGrossWeightnumberOptional

Gesamtbruttogewicht

capacitynumberOptional

Inhalt der Maßeinheit

baseCapacitynumberOptional

Inhalt der Grundeinheit

baseLineIdinteger · int64Optional

Referenz zur Basiszeile

supplierOrderLineIdsinteger · int64[]Optional

Referenz zur Lieferantenbestellungszeile

previousDecisionsanyOptional

Search-Dialog

articleTaxLiabilityReversedbooleanRead-onlyOptional

Vorgabe §13b UStG Artikel

Default: false

taxLiabilityReversedbooleanRead-onlyOptional

wird §13b UStG angewendet?

Default: false

presetPricenumberRead-onlyOptional

Vorgabewert für die Preiskalkulation

calculationDatastringOptional

Kalkulationsstruktur

commissionOriginstring · enumOptional

Provisionsursprung

Possible values:

cashDiscountablebooleanOptional

skontierbare Position?

Default: true

discountablebooleanOptional

rabattierbare Position?

Default: true

commissionablebooleanOptional

provisionierbare Position?

Default: false

warrantyInMonthsinteger · int32Optional

Garantie in Monaten

customanyOptional

Search-Dialog

performanceDatestring · dateOptional

Leistungsdatum

basePricenumberOptional

Preis pro Einheit in Basiswährung

baseTotalLinePriceModifiernumberOptional

Preisanpassungen - Position Basiswährung

baseTotalDocumentPriceModifiernumberOptional

Preisanpassungen - anteilig durch Beleg Basiswährung

baseTotalLinePricenumberOptional

Gesamtpreis Position in Basiswährung

baseSalesValueNetnumberOptional

Nettoverkaufswert der Position in Basiswährung

progressInvoicebooleanOptional

Abschlagsposition?

Default: false

dropShippingPolicystring · enumOptional

Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf

Possible values:

unitGrossVolumeInCubicMetersnumberOptional

unit gross Volume in cubic meters

totalGrossVolumeInCubicMetersnumberRead-onlyOptional

unit gross Volume in cubic meters

insertTermstring · enumOptional

Zubehör Einfügeart

Possible values:

hasAccessoriesbooleanOptional

Hat der Artikel Zubehör?

Default: false

recalcLinePriceViaComponentsbooleanOptional

Soll die DocumentLine über die Komponenten neu berechnet werden?

Default: false

get/erp/documents/{id}/predecessor-document-assignable-lines

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/predecessor-document-assignable-lines HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

return all possible storages for this documentLine

get

Path parameters

idinteger · int64Required

document id

lineIdinteger · int64Required

document line id

Responses

200

OK

*/*

storage option for a document-line

reservedQuantitynumberOptional

reserved quantity (from customer-orders)

orderedQuantitynumberOptional

already ordered quantity (from supplier-orders)

stockAmountnumberOptional

the current stock amount

stockAvailablenumberOptional

the current available stock amount

get/erp/documents/{id}/lines/{lineId}/storages

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines/{lineId}/storages HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

get

Path parameters

idinteger · int64Required

document id

lineIdinteger · int64Required

ID of the document line

Responses

200

OK

*/*

Preisermittlungskriterien

qualifierstring · enumOptional

ein qualifier

Possible values:

articleIdsinteger · int64[]Optional

Liste von Artikel-IDs

selectOnlyDefaultPricebooleanOptional

soll nur der Standardpreis selektiert werden?

Default: false

accountIdsinteger · int64[]Optional

Liste von Account-IDs

productGroupIdinteger · int64Optional

Die Warengruppe

priceGroupIdinteger · int64Optional

Die Preisgruppe

datestring · dateOptional

Ein Datum

quantitynumberOptional

Eine Menge

noteSpecialOfferPricebooleanOptional

Aktionspreis beachten?

get/erp/documents/{id}/lines/{lineId}/show-price-origin

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines/{lineId}/show-price-origin HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "qualifier": "SALES",
  "articleIds": [
    1
  ],
  "selectOnlyDefaultPrice": false,
  "accountIds": [
    1
  ],
  "productGroupId": 1,
  "priceGroupId": 1,
  "date": "2026-07-21",
  "quantity": 1,
  "noteSpecialOfferPrice": true
}

liefert dem dEK und letzten EK für ein Artikel einer DocumentLine

get

Path parameters

idinteger · int64Required

document id

lineIdinteger · int64Required

ID of the document line

Responses

200

OK

*/*

Preisstatistiken (DEK und letzter EK)

averagePricenumberRead-onlyOptional

Durchschnitts-Einkaufspreis

averagePriceBookedAtstring · dateRead-onlyOptional

Wertstellungsdatum Durchschnitts-Einkaufspreis

lastPricenumberRead-onlyOptional

letzter Einkaufspreis

lastPriceUpdatedAtstring · date-timeRead-onlyOptional

Erfassungszeitpunkt letzter Einkaufspreis

lastPriceBookedAtstring · dateRead-onlyOptional

Wertstellungsdatum letzter Einkaufspreis

get/erp/documents/{id}/lines/{lineId}/purchase-price-statistic

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines/{lineId}/purchase-price-statistic HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "averagePrice": 1,
  "averagePriceBookedAt": "2026-07-21",
  "lastPrice": 1,
  "lastPriceUpdatedAt": "2026-07-21T00:53:50.128Z",
  "lastPriceBookedAt": "2026-07-21",
  "mainSupplierAccount": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "mainSupplierProductPrice": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "netPrice": 1,
    "grossPrice": 1,
    "priceBase": "NET_PRICE",
    "usedTaxRate": {
      "version": "text",
      "info": {
        "createdAt": "2026-07-21T00:53:50.128Z",
        "createdFrom": "text",
        "updatedAt": "2026-07-21T00:53:50.128Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "typeRef": {
        "id": "text",
        "label": "text",
        "description": "text"
      },
      "active": true,
      "countryCode": "text",
      "rate": 19,
      "validFrom": "2026-07-21"
    },
    "qualifier": "SALES",
    "purchasePriceSource": "NONE",
    "modifierValueType": "PERCENT",
    "modifierValue": 1,
    "accountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "articleRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "accessoryMainArticleRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "productGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "priceGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "currencyRef": {
      "id": 1,
      "isoAlpha3": "text",
      "label": "text",
      "symbol": "text"
    },
    "fromQuantity": 1,
    "validFrom": "2026-07-21",
    "validUntil": "2026-07-21",
    "specialOfferPrice": false,
    "salesChannelRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "customerGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "supplierGroupRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  }
}

Gibt die manuellen Textbausteine für Textpositionen zurück, die für das Dokument Sinn ergeben

get

Path parameters

idinteger · int64Required

document id

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

get/erp/documents/{id}/lines/text-templates

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines/text-templates HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

Lists all orderable document lines

get

Path parameters

idinteger · int64Required

document identifier

Responses

200

OK

*/*

Bestellbare Positionen für Übernahme in Bestellung

documentLineIdstringRead-onlyOptional

Id der DocumentLine

positioninteger · int32Read-onlyOptional

Positionsnummer

articleNumberstringRead-onlyOptional

Artikelnummer

articleNamestringRead-onlyOptional

Artikelbezeichnung

articleIdinteger · int64Read-onlyOptional

Artikelnummer

quantitynumberRequired

Menge

orderbooleanRequired

Bestellen?

Default: true

availableQuantitynumberRead-onlyOptional

Verfügbare Menge

orderedQuantitynumberRead-onlyOptional

Bestellte Menge

dropShippingPolicystring · enumRead-onlyOptional

Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf

Possible values:

get/erp/documents/{id}/lines-to-transfer-to-supplier-order

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines-to-transfer-to-supplier-order HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

List all lines allowed to transfer in supplier delivery

get

Path parameters

idinteger · int64Required

ID of supplier order

Responses

200

OK

*/*

In Lieferschein übernehmbare Positionen mit Belegnummern

externalDocumentNumberstringOptional

externe Belegnummer

documentNumberstringOptional

Belegnummer

get/erp/documents/{id}/lines-to-transfer-to-supplier-delivery

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines-to-transfer-to-supplier-delivery HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "deliveryTransferableLines": [],
  "externalDocumentNumber": "text",
  "documentNumber": "text"
}

List all lines allowed to transfer in customer delivery

get

Path parameters

idinteger · int64Required

ID of customer order

Responses

200

OK

*/*

In Lieferschein übernehmbare Positionen mit Belegnummern

externalDocumentNumberstringOptional

externe Belegnummer

documentNumberstringOptional

Belegnummer

get/erp/documents/{id}/lines-to-transfer-to-customer-delivery

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/lines-to-transfer-to-customer-delivery HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "deliveryTransferableLines": [],
  "externalDocumentNumber": "text",
  "documentNumber": "text"
}

returns the flat document without

get

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

document to update

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstring · max: 255Required

Belegnummer

accountNumberstring · max: 255Read-onlyOptional

Kontonummer der zugehörigen Organisationseinheit

customerNumberstring · max: 255Read-onlyOptional

Kundennummer

ourCustomerNumberstring · max: 255Read-onlyOptional

Kundennummer beim Lieferanten

supplierNumberstring · max: 255Read-onlyOptional

Lieferantennummer

salesAgentNumberstring · max: 255Read-onlyOptional

Vertreternummer

externalIdentifierstring · max: 255Optional

Externe Kennung

externalNumberstring · max: 255Optional

Externe Belegnummer

publishedbooleanRead-onlyOptional

Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?

Default: false

frozenbooleanRead-onlyOptional

Ist der Beleg festgeschrieben?

Default: false

qualifierstring · enumRead-onlyOptional

Art des Belegs

Possible values:

accountIdstringRequired

ID der Organisationseinheit

documentDatestring · dateRequired

Belegdatum

performanceDatestring · dateOptional

Leistungsdatum

valueDatestring · dateOptional

Valutadatum

taxablebooleanOptional

Steuerpflichtig oder steuerfrei

Default: true

taxIdentificationNumberstring · max: 255Optional

Umsatzsteuer-Identifikationsnummer

taxIdVerificationStatestring · enumRead-onlyOptional

Überprüfungsstatus der Steueridentifikationsnummer

Possible values:

valitoolValidationStatestring · enumRead-onlyOptional

Validierungsstatus bei elektronischen Rechnungen

Possible values:

billingTypestring · enumRequired

Abrechnungstyp

Possible values:

documentTypestringRead-onlyOptional

Belegtyp (intern)

documentTypeIdinteger · int64Read-onlyOptional

ID des Belegtyps

documentTypeCategorystring · enumRead-onlyOptional

Dokumenttypen

Possible values:

currencyCodestringRequired

Währung (ISO-Code, Alpha-3)

exchangeRatenumberOptional

Wechselkurs

exchangeRateOriginstring · enumOptional

Ursprung für Währungskursermittlung

Default: AUTOMATICPossible values:

totalBeforeModifiernumberRead-onlyOptional

Gesamtpreis vor Rabatt [BRUTTO, NETTO]

totalPriceModifiernumberRead-onlyOptional

Rabatt gesamt [BRUTTO, NETTO]

totalLinePriceModifiernumberRead-onlyOptional

Positionsrabatt gesamt [BRUTTO, NETTO]

totalDocumentPriceModifiernumberRead-onlyOptional

Belegrabatt gesamt [BRUTTO, NETTO]

totalNetPricenumberRead-onlyOptional

Gesamtpreis netto

totalVatnumberRead-onlyOptional

Gesamte Mehrwertsteuer

totalGrossPricenumberRead-onlyOptional

Gesamtpreis brutto

roundingAmountnumberRead-onlyOptional

Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)

depositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag

depositPaymentDatestring · dateRead-onlyOptional

Vereinbartes Anzahlungsdatum

deliveryDatestring · dateOptional

Voraussichtliches Lieferdatum

deliveryDateEndstring · dateOptional

Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)

confirmedDeliveryDatestring · dateOptional

Bestätigtes Lieferdatum

confirmedDeliveryDateEndstring · dateOptional

Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)

shippingDatestring · dateOptional

Versanddatum

deliveryQuantityPackagesinteger · int32Optional

Voraussichtliche Paketanzahl (nur Info)

deliveryTextstring · max: 255Optional

Zusätzlicher Liefertext

deliveryApprovedbooleanRequired

Ist der Beleg zur Lieferung freigegeben?

Default: true

dropShippingInvoiceApprovedbooleanRead-onlyOptional

Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?

orderedOnstring · dateOptional

Bestelldatum

orderedBystring · max: 255Optional

Name der bestellenden Person

taxLiabilityReversedbooleanOptional

Reverse-Charge-Verfahren nach §13b UStG?

Default: false

collectiveInvoicebooleanOptional

Sammelrechnung?

Default: false

shippingCostSumnumberRead-onlyOptional

Summe der Versandkosten (netto/brutto)

customanyOptional

Search-Dialog

stackProcessingTypestring · enumOptional

Stapelverarbeitungsinformationen für Aufträge

Possible values:

stackProcessingPriorityinteger · int32Optional

Priorität in der Stapelverarbeitung

maxDeliveriesinteger · int32Optional

Maximal mögliche Lieferungen

taxPerformanceLocationstring · enumOptional

Ort der steuerlichen Leistungserbringung

Possible values:

performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3)

grossWeightnumberOptional

Gesamtbruttogewicht

userDefinedWeightbooleanOptional

Gesamtgewicht wurde manuell gesetzt

Default: false

cashDiscountableTotalGrossPricenumberRead-onlyOptional

Skontofähiger Bruttogesamtbetrag

buyerReferencestring · max: 255Optional

Leitweg-ID

en16931Profilestring · enumOptional

EN16931-Profil für elektronische Rechnungen

Possible values:

importTypestring · enumRead-onlyOptional

Importmodus des Belegs

Possible values:

paymentPlanbooleanOptional

Zahlungsplan vorhanden?

Default: false

calculationModestring · enumRequired

Berechnungsmodus

Possible values:

processedByWorkflowbooleanRead-onlyOptional

Wird vom Workflow verarbeitet?

referencedOrderNumberstringRead-onlyOptional

Bestellnummer aus Vorbeleg

languageCodestringOptional

Sprache

baseCurrencyCodestringOptional

Basiswährung des Belegs

baseTotalNetPricenumberOptional

Gesamtpreis - Netto Basiswährung

baseTotalLinePriceModifiernumberOptional

Preisanpassungen - Belegpositionssumme Basiswährung

baseTotalDocumentPriceModifiernumberOptional

Preisanpassungen - Beleg Basiswährung

baseTotalGrossPricenumberOptional

Gesamtpreis - Brutto Basiswährung

baseDepositPaymentAmountnumberOptional

Vorkassebetrag Basiswährung

baseCashDiscountableTotalGrossPricenumberOptional

skontierbarer Rechnungsbetrag Basiswährung

forwardEmailToShipperbooleanOptional

E-Mail an Versender übergeben

Default: false

forwardPhoneToShipperbooleanOptional

Telefon an Versender übergeben

Default: false

posReceiptPaymentSumnumberOptional

Quittung: Summe Zahlbetrag

posReceiptBalancenumberOptional

Quittung: Saldo positiver Wert: Betrag der noch zu zahlen ist negativer Wert: überzahlter Betrag / Rückgeld

posReceiptChangeAmountnumberOptional

Rückgeld

posReceiptBalancedbooleanOptional

Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld true wenn die Quittung ausbalanciert ist

Default: false

posReceiptPayedbooleanOptional

Ist die Quittung bezahlt true wenn die Quittung bezahlt ist

Default: false

dropShippingbooleanRead-onlyOptional

Streckengeschäft

totalGrossVolumeInCubicMetersnumberRead-onlyOptional

total gross Volume in cubic meters

get/erp/documents/{id}/flat

HTTPcURLJavaScriptPython

GET /api/erp/documents/{id}/flat HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:50.128Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:50.128Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "number": "text",
  "accountNumber": "text",
  "customerNumber": "text",
  "ourCustomerNumber": "text",
  "supplierNumber": "text",
  "salesAgentNumber": "text",
  "externalIdentifier": "text",
  "externalNumber": "text",
  "published": false,
  "frozen": false,
  "qualifier": "SALE",
  "accountId": "text",
  "billingAccountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "documentDate": "2026-07-21",
  "performanceDate": "2026-07-21",
  "valueDate": "2026-07-21",
  "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"
  },
  "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-07-21",
  "deliveryTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "deliveryMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "deliveryDate": "2026-07-21",
  "deliveryDateEnd": "2026-07-21",
  "confirmedDeliveryDate": "2026-07-21",
  "confirmedDeliveryDateEnd": "2026-07-21",
  "shippingDate": "2026-07-21",
  "deliveryQuantityPackages": 1,
  "deliveryText": "text",
  "deliveryApproved": true,
  "dropShippingInvoiceApproved": true,
  "orderedOn": "2026-07-21",
  "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-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "accountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salutation": "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-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "accountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salutation": "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-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "accountRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "salutation": "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": null,
  "stackProcessingType": "NO_PICKING",
  "stackProcessingPriority": 1,
  "maxDeliveries": 1,
  "taxPerformanceLocation": "DOMESTIC",
  "performanceCountryCode": "text",
  "sourceCountryCode": "text",
  "afterPickingTargetDocumentTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "grossWeight": 1,
  "grossWeightUnit": {
    "id": 1,
    "name": "text",
    "abbreviation": "text"
  },
  "userDefinedWeight": false,
  "tags": [],
  "reportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "defaultStorageRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "cashDiscountableTotalGrossPrice": 1,
  "contractDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "startDate": "2026-07-21",
    "endDate": "2026-07-21",
    "runtimeFromDate": "2026-07-21",
    "runtimeToDate": "2026-07-21",
    "lastCustomerCancellationDate": "2026-07-21",
    "lastProviderCancellationDate": "2026-07-21",
    "dueDateCalculation": "text",
    "dueDate": "2026-07-21",
    "nextDueDate": "2026-07-21",
    "calculateDirectly": true,
    "active": true,
    "publishInPortal": false
  },
  "posDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "posRegisterRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashDrawerRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "cashJournalRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "fiscalizationBackendRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "tssSignature": {
      "status": "FINISHED",
      "responseData": "text",
      "externalReference": "text",
      "revision": 1
    },
    "externalReference": "text",
    "timeStart": 1,
    "timeEnd": 1,
    "clientSerialNumber": "text",
    "tssSerialNumber": "text",
    "transactionNumber": 1,
    "revision": 1,
    "signatureCounter": 1,
    "signature": "text"
  },
  "fabricationDetail": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T00:53:50.128Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T00:53:50.128Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "startDate": "2026-07-21",
    "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": null
  },
  "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": [],
    "orderIntoPickingConvertResults": []
  },
  "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
}

Liefert alle nicht zu Paketen zugewiesenen Belegpositionsbuchungen zu einem Beleg

get

Path parameters

documentIdinteger · int64Required

Responses

200

OK

*/*

Buchungen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

quantitynumberRequired

Gebuchte Menge

serialNumber1string · max: 255Optional

Seriennummer 1

serialNumber2string · max: 255Optional

Seriennummer 2

expiryDatestring · dateOptional

Haltbarkeitsdatum

notestringOptional

Notiz

udistringOptional

Unique Device Identifier (UDI)

get/erp/documents/{documentId}/parcels/unassigned-bookings

HTTPcURLJavaScriptPython

GET /api/erp/documents/{documentId}/parcels/unassigned-bookings HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

get

Path parameters

documentIdinteger · int64Required

Responses

200

OK

*/*

Verfügbarkeitsinformationen zu einem Beleg und seinen Positionen

get/erp/documents/{documentId}/availability

HTTPcURLJavaScriptPython

GET /api/erp/documents/{documentId}/availability HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "documentAvailabilityInfo": {
    "orderAvailability": "FULL_DELIVERABLE",
    "orderStackProcessingType": "NO_PICKING",
    "maxPossibleDeliveries": 1
  },
  "lineAvailabilityInfos": {
    "ANY_ADDITIONAL_PROPERTY": {
      "orderLineAvailability": "FULL_DELIVERABLE",
      "availableQuantity": 1,
      "maxAvailableQuantity": 1,
      "orderedQuantity": 1
    }
  }
}

return all available document-state-machine starting states

get

Query parameters

languageCodestringRequired

Responses

200

OK

*/*

idstringRequired

das gleiche wie transition id für das UI

transitionIdstringRequired

transition id

transitionLabelstringRead-onlyOptional

label of this transition

uiHintanyOptional

Search-Dialog

stateDefinitionstringRead-onlyOptional

state definition of the target state

typeCategorystring · enumRead-onlyOptional

Dokumenttypen

Possible values:

typeIdstringRead-onlyOptional

document-type-id des ziels

typeKeystringRead-onlyOptional

document-type-key des ziels

typeLabelstringRead-onlyOptional

type-label

isDefaultTypeForCategorybooleanRead-onlyOptional

document-type ist Default für die Kategorie

targetStatestringRead-onlyOptional

Der Ziel-Status der Transition

sortOrderinteger · int32Read-onlyOptional

Sortier-Reihenfolge

get/erp/documents/types

HTTPcURLJavaScriptPython

GET /api/erp/documents/types?languageCode=text HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]