> For the complete documentation index, see [llms.txt](https://developer.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.vario-software.de/api-reference/document.md).

# Document

Manage ERP documents, including creation, updates, state transitions, line items, validation, printing, locking, picking, shipments, and workflows.

the Document API

## POST /erp/documents

> create a new document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents":{"post":{"tags":["Document"],"summary":"create a new document","operationId":"createDocument","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentTypeTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentTypeTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"Transition identifier."},"targetTypeId":{"type":"integer","format":"int64","description":"Target document type identifier, if any."},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details of the document to create or update.","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"locationId":{"type":"string","description":"location-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"External document number."},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"supplierAccountId":{"type":"integer","format":"int64","description":"Default supplier when transferring from an order to supplier orders."},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when incomingGoodsStorageBinId is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when incomingGoodsPickTrolleyId is null)."},"priceModifiers":{"type":"array","description":"Document discounts.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"POS register identifier (for POS)."},"cashDrawerId":{"type":"integer","format":"int64","description":"Cash drawer identifier (for POS)."},"depositPaymentAmount":{"type":"number","description":"Deposit amount."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"One or more POS payments.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Document header and footer texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-RequestDocumentLine":{"description":"Details of the document to create or update.","properties":{"name":{"type":"string","description":"Article name."},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Article position number."},"description":{"type":"string","description":"Article description."},"lineId":{"type":"string","description":"Document line identifier in the current document."},"sourceLineId":{"type":"string","description":"Source document line identifier."},"refLineId":{"type":"string","description":"Referenced document line identifier (optional)."},"articleId":{"type":"string","description":"Article identifier of this line (optional)."},"onGoodsArrivalConvertIntoBundleArticleId":{"type":"string","description":"Bundle article the received goods of this line are converted into (optional)."},"externalId":{"type":"string","description":"Reference to the corresponding line in an external system."},"productPrice":{"type":"number","description":"Article price of this line (optional)."},"totalLinePrice":{"type":"number","description":"Total line price (optional)."},"priceModifiers":{"type":"array","description":"Price modifiers for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"Texts for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Quantity to process in this transaction."},"storageId":{"type":"string","description":"Storage identifier (optional)."},"markCompleted":{"type":"boolean","default":false,"description":"Should the source line be marked as completed after a successful processing?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Required for converting a customer order into a supplier order."},"bookings":{"type":"array","description":"Bookings for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Document line commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"settledOpenItemId":{"type":"string","description":"Identifier of the open item to settle (only for OPEN_ITEM_SETTLEMENT)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"voucherTypeId":{"type":"string","description":"Voucher type of the sales line (VOUCHER_SALE only)"},"voucherId":{"type":"string","description":"The affected voucher: for VOUCHER_REDEMPTION the one to redeem, for VOUCHER_SALE on return, credit note or cancellation the returned one"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when `incomingGoodsStorageBinId` is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when `incomingGoodsPickTrolleyId` is null)."},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Trigger the label printing for this line."}}},"erp-document-RequestDocumentPriceModifier":{"description":"Document discounts.","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line","minimum":0},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"Texts for this line (optional).","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Bookings for this document line.","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"Booked source DocumentLineComponent identifier."},"quantity":{"type":"number","description":"Booked quantity."},"storageBinId":{"type":"integer","format":"int64","description":"Identifier of the storage bin booked to."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of a serial number to book, if any."}},"required":["quantity","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Commissions for this document line.","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address number."},"displayName":{"type":"string","description":"Display name.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"Tax number.","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Remark.","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Note."},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"All addresses except the default address.","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Contact person.","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Competent local court.","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Commercial register identifier.","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Cost center."},"languageCode":{"type":"string","description":"Account language."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the tax liability reversed under §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Tax numbers.","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account relations.","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Dunning block."},"payablesSum":{"type":"number","description":"Total payables.","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Total payables currency (ISO Alpha-3).","readOnly":true},"anonymized":{"type":"boolean","description":"Is the account anonymized?","readOnly":true},"receivablesSum":{"type":"number","description":"Total receivables.","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Total receivables currency (ISO Alpha-3).","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Credit limit currency (ISO Alpha-3).","readOnly":true},"accountZoneId":{"type":"string","description":"Account time zone (or time zone offset).","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Business relation types for accounts.","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-account-AccountAddress":{"description":"All addresses except the default address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"Tax identification number (VAT ID).","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI number.","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Address language."},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Default for the account type."}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"Default contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-account-AccountPerson":{"description":"Contact person.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment."},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"Sort order."},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this active?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Default contact person.","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"deliveryBlocked":{"type":"boolean","default":false,"description":"Does the customer have a delivery block?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority for the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Credit limit.","minimum":0},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Trigger the collective billing manually only?"},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the collective billing."},"dueDate":{"type":"string","format":"date","description":"Next collective billing due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date after the current one."}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Should this be dunned?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Billing type, net or gross.","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Order block."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Delivery time in (working) days."},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"Eligible for inclusion in order proposals."},"minimumOrderValue":{"type":"number","description":"Minimum order value."},"freeShippingValue":{"type":"number","description":"Free of freight costs from."},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Creation of an outgoing delivery document for a drop shipping supplier order."},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Indicates whether drop shipping is allowed."}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Descriptions.","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"},"minItems":1},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Is the recommended retail price mandatory?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Descriptions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","minLength":1},"description":{"type":"string","description":"Description."},"languageCode":{"type":"string","description":"Description language.","minLength":1},"manufacturerUrl":{"type":"string","description":"Manufacturer URL."}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Tax numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account relations.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment."},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details of the processed fabrication document line.","properties":{"fabricationSerialNumbers":{"type":"array","description":"Fill this only when the serial numbers are to be determined manually before the fabrication starts.","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Serial number to produce.","properties":{"quantity":{"type":"number","description":"Deviating quantity for lots."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of the serial number to produce (only for the targeted production of serial numbers that are already defined)."},"serialNumber1":{"type":"string","description":"Serial number 1."},"serialNumber2":{"type":"string","description":"Serial number 2."},"expiryDate":{"type":"string","format":"date","description":"Best-before or expiry date."},"note":{"type":"string","description":"Note."}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"May this type be used to create new documents?"},"nextNumber":{"type":"string","description":"Next document number.","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"Is this document type the default document type of its category?"},"active":{"type":"boolean","default":true,"description":"Is this document type active?"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"The business relation is mandatory."},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Assigned DMS document behavior.","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sort order."}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this successor document type active?","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Own number range for serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is the sequencer active?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Sequence type.","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Assignment procedure.","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Length.","minimum":0},"padChar":{"type":"string","description":"Padding character.","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Prefix expression."},"postExpression":{"type":"string","description":"Postfix expression."},"initialValue":{"type":"integer","format":"int64","description":"Initial value."},"numberUnique":{"type":"boolean","default":true,"description":"Uniqueness check."}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## PUT /erp/documents

> update an existing document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents":{"put":{"tags":["Document"],"summary":"update an existing document","operationId":"updateDocument","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentUpdateRequest":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}},"required":["document"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## GET /erp/documents/{id}/states

> return all possible states, the document can transferred into

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/states":{"get":{"tags":["Document"],"summary":"return all possible states, the document can transferred into","operationId":"getPossibleStates","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"Same as the transition identifier, for the UI."},"transitionId":{"type":"string","description":"Transition identifier."},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"Target document type identifier.","readOnly":true},"typeKey":{"type":"string","description":"Target document type key.","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"The document type is the default for the category.","readOnly":true},"targetState":{"type":"string","description":"Transition target state.","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sort order.","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /erp/documents/{id}/states

> transfer the document into the given state

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/states":{"put":{"tags":["Document"],"summary":"transfer the document into the given state","operationId":"transferToState_1","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentStateTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentStateTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"Transition identifier."},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details of the document to create or update.","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"locationId":{"type":"string","description":"location-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"External document number."},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"supplierAccountId":{"type":"integer","format":"int64","description":"Default supplier when transferring from an order to supplier orders."},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when incomingGoodsStorageBinId is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when incomingGoodsPickTrolleyId is null)."},"priceModifiers":{"type":"array","description":"Document discounts.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"POS register identifier (for POS)."},"cashDrawerId":{"type":"integer","format":"int64","description":"Cash drawer identifier (for POS)."},"depositPaymentAmount":{"type":"number","description":"Deposit amount."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"One or more POS payments.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Document header and footer texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-RequestDocumentLine":{"description":"Details of the document to create or update.","properties":{"name":{"type":"string","description":"Article name."},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Article position number."},"description":{"type":"string","description":"Article description."},"lineId":{"type":"string","description":"Document line identifier in the current document."},"sourceLineId":{"type":"string","description":"Source document line identifier."},"refLineId":{"type":"string","description":"Referenced document line identifier (optional)."},"articleId":{"type":"string","description":"Article identifier of this line (optional)."},"onGoodsArrivalConvertIntoBundleArticleId":{"type":"string","description":"Bundle article the received goods of this line are converted into (optional)."},"externalId":{"type":"string","description":"Reference to the corresponding line in an external system."},"productPrice":{"type":"number","description":"Article price of this line (optional)."},"totalLinePrice":{"type":"number","description":"Total line price (optional)."},"priceModifiers":{"type":"array","description":"Price modifiers for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"Texts for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Quantity to process in this transaction."},"storageId":{"type":"string","description":"Storage identifier (optional)."},"markCompleted":{"type":"boolean","default":false,"description":"Should the source line be marked as completed after a successful processing?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Required for converting a customer order into a supplier order."},"bookings":{"type":"array","description":"Bookings for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Document line commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"settledOpenItemId":{"type":"string","description":"Identifier of the open item to settle (only for OPEN_ITEM_SETTLEMENT)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"voucherTypeId":{"type":"string","description":"Voucher type of the sales line (VOUCHER_SALE only)"},"voucherId":{"type":"string","description":"The affected voucher: for VOUCHER_REDEMPTION the one to redeem, for VOUCHER_SALE on return, credit note or cancellation the returned one"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when `incomingGoodsStorageBinId` is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when `incomingGoodsPickTrolleyId` is null)."},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Trigger the label printing for this line."}}},"erp-document-RequestDocumentPriceModifier":{"description":"Document discounts.","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line","minimum":0},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"Texts for this line (optional).","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Bookings for this document line.","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"Booked source DocumentLineComponent identifier."},"quantity":{"type":"number","description":"Booked quantity."},"storageBinId":{"type":"integer","format":"int64","description":"Identifier of the storage bin booked to."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of a serial number to book, if any."}},"required":["quantity","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Commissions for this document line.","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address number."},"displayName":{"type":"string","description":"Display name.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"Tax number.","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Remark.","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Note."},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"All addresses except the default address.","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Contact person.","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Competent local court.","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Commercial register identifier.","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Cost center."},"languageCode":{"type":"string","description":"Account language."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the tax liability reversed under §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Tax numbers.","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account relations.","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Dunning block."},"payablesSum":{"type":"number","description":"Total payables.","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Total payables currency (ISO Alpha-3).","readOnly":true},"anonymized":{"type":"boolean","description":"Is the account anonymized?","readOnly":true},"receivablesSum":{"type":"number","description":"Total receivables.","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Total receivables currency (ISO Alpha-3).","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Credit limit currency (ISO Alpha-3).","readOnly":true},"accountZoneId":{"type":"string","description":"Account time zone (or time zone offset).","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Business relation types for accounts.","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-account-AccountAddress":{"description":"All addresses except the default address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"Tax identification number (VAT ID).","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI number.","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Address language."},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Default for the account type."}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"Default contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-account-AccountPerson":{"description":"Contact person.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment."},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"Sort order."},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this active?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Default contact person.","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"deliveryBlocked":{"type":"boolean","default":false,"description":"Does the customer have a delivery block?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority for the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Credit limit.","minimum":0},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Trigger the collective billing manually only?"},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the collective billing."},"dueDate":{"type":"string","format":"date","description":"Next collective billing due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date after the current one."}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Should this be dunned?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Billing type, net or gross.","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Order block."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Delivery time in (working) days."},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"Eligible for inclusion in order proposals."},"minimumOrderValue":{"type":"number","description":"Minimum order value."},"freeShippingValue":{"type":"number","description":"Free of freight costs from."},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Creation of an outgoing delivery document for a drop shipping supplier order."},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Indicates whether drop shipping is allowed."}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Descriptions.","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"},"minItems":1},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Is the recommended retail price mandatory?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Descriptions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","minLength":1},"description":{"type":"string","description":"Description."},"languageCode":{"type":"string","description":"Description language.","minLength":1},"manufacturerUrl":{"type":"string","description":"Manufacturer URL."}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Tax numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account relations.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment."},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details of the processed fabrication document line.","properties":{"fabricationSerialNumbers":{"type":"array","description":"Fill this only when the serial numbers are to be determined manually before the fabrication starts.","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Serial number to produce.","properties":{"quantity":{"type":"number","description":"Deviating quantity for lots."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of the serial number to produce (only for the targeted production of serial numbers that are already defined)."},"serialNumber1":{"type":"string","description":"Serial number 1."},"serialNumber2":{"type":"string","description":"Serial number 2."},"expiryDate":{"type":"string","format":"date","description":"Best-before or expiry date."},"note":{"type":"string","description":"Note."}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"May this type be used to create new documents?"},"nextNumber":{"type":"string","description":"Next document number.","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"Is this document type the default document type of its category?"},"active":{"type":"boolean","default":true,"description":"Is this document type active?"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"The business relation is mandatory."},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Assigned DMS document behavior.","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sort order."}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this successor document type active?","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Own number range for serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is the sequencer active?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Sequence type.","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Assignment procedure.","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Length.","minimum":0},"padChar":{"type":"string","description":"Padding character.","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Prefix expression."},"postExpression":{"type":"string","description":"Postfix expression."},"initialValue":{"type":"integer","format":"int64","description":"Initial value."},"numberUnique":{"type":"boolean","default":true,"description":"Uniqueness check."}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## PUT /erp/documents/{id}/protocol/{protocolId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/protocol/{protocolId}":{"put":{"tags":["Document"],"operationId":"updateManualDocumentProtocolEntry","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"protocolId","in":"path","description":"Entry identifier in the document protocol.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-CreateOrUpdateManualDocumentProtocolRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}},"components":{"schemas":{"erp-document-CreateOrUpdateManualDocumentProtocolRequest":{"description":"Request for creating a manual entry in the document protocol.","properties":{"customMessage":{"type":"string","description":"Text for the document protocol.","minLength":1}},"required":["customMessage"]},"erp-document-DocumentProtocol":{"description":"Document protocol.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Protocol entry document type.","readOnly":true},"documentTypeLabels":{"type":"array","description":"Document type label of this protocol entry.","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Document number of this protocol entry.","readOnly":true},"type":{"type":"string","description":"Kinds of entries in the DocumentProtocol.","enum":["MANUAL","PROBLEM","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MANUALLY_TRANSFERRED_FROM_WORKFLOW_STATE","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REMAINDER_CLOSED","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Protocol entry text."},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"User who created the entry.","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Protocol entry timestamp."}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}}
```

## GET /erp/documents/{id}/print

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/print":{"get":{"tags":["Document"],"operationId":"getPrintPreview_2","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## PUT /erp/documents/{id}/print

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/print":{"put":{"tags":["Document"],"operationId":"printDocument","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"object"}},"application/json":{"schema":{"type":"object"}}}},"405":{"description":"printing not allowed for the current document state","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}},"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputRequest":{"properties":{"exportFormat":{"type":"string","description":"Output format for the mail or file export.","enum":["PDF","XLSX","JSON_RAW","REPORT_TEMPLATE"]},"exportFilename":{"type":"string","description":"File name (without extension) for a file export."},"mailRecipients":{"type":"array","description":"Recipient.","items":{"$ref":"#/components/schemas/common-output-OutputRecipient.MailRecipient"}},"outputType":{"type":"string","description":"outputType"},"groupIdentifier":{"type":"string","description":"OutputReportGroup identifier (optional), otherwise the module default group."},"published":{"type":"boolean","default":false,"description":"Should only documents that are already published be considered?"},"directPrintEnabled":{"type":"boolean","default":true,"description":"Return output directly to the client."}}},"common-output-OutputRecipient.MailRecipient":{"description":"Recipient.","properties":{"type":{"type":"string","description":"(mail) recipient type","enum":["TO","CC","BCC"]},"address":{"type":"string","description":"(mail) recipient address"},"name":{"type":"string","description":"(mail) recipient name"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /erp/documents/{id}/leasable-lock/{lockToken}

> Extend a lock

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/leasable-lock/{lockToken}":{"put":{"tags":["Document"],"summary":"Extend a lock","operationId":"refreshLeasableLock","parameters":[{"name":"id","in":"path","description":"Locked resource identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lockToken","in":"path","description":"Token of the lock to extend.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"leasePeriod","in":"query","description":"Optional lease duration in seconds.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string","minLength":1},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}}
```

## DELETE /erp/documents/{id}/leasable-lock/{lockToken}

> Release a lock

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/leasable-lock/{lockToken}":{"delete":{"tags":["Document"],"summary":"Release a lock","operationId":"releaseLeasableLock","parameters":[{"name":"id","in":"path","description":"Locked resource identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lockToken","in":"path","description":"Token of the lock to release.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## PUT /erp/documents/{documentId}/parcel/{parcelId}

> Update a document parcel

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/parcel/{parcelId}":{"put":{"tags":["Document"],"summary":"Update a document parcel","operationId":"createOrUpdateParcel","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"parcelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Parcels of documents.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Parcel position."},"weight":{"type":"number","description":"Parcel weight."},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Length."},"width":{"type":"number","description":"Width."},"height":{"type":"number","description":"Height."},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Tracking number.","readOnly":true},"lines":{"type":"array","description":"Parcel content.","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Document parcel content.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the document line."},"documentLineBookingId":{"type":"integer","format":"int64","description":"Reference to the document line booking."},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Quantity."}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /erp/documents/document/{documentId}/line/{lineId}

> update an existing document with changed position

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}":{"put":{"tags":["Document"],"summary":"update an existing document with changed position","operationId":"updateDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPartialUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPartialUpdateRequest":{"properties":{"documentLine":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"additionalParameters":{"type":"array","description":"Additional parameters and user decisions.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## DELETE /erp/documents/document/{documentId}/line/{lineId}

> delete a line

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}":{"delete":{"tags":["Document"],"summary":"delete a line","operationId":"deleteLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## PATCH /erp/documents/document/{documentId}/line/{lineId}

> update an existing document with changed position

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}":{"patch":{"tags":["Document"],"summary":"update an existing document with changed position","operationId":"patchDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentLinePatchRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentLinePatchRequest":{"properties":{"line":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}},"required":["line"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## PUT /erp/documents/document/{documentId}/line/{lineId}/move/{position}

> Move a line to a new position

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/move/{position}":{"put":{"tags":["Document"],"summary":"Move a line to a new position","operationId":"moveLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"position","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## GET /erp/documents/document/{documentId}/line/{lineId}/financebooking

> get finance booking information for documentLine

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"get":{"tags":["Document"],"summary":"get finance booking information for documentLine","operationId":"getFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}}}}}}},"components":{"schemas":{"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}}
```

## PUT /erp/documents/document/{documentId}/line/{lineId}/financebooking

> update finance booking information for documentLine

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"put":{"tags":["Document"],"summary":"update finance booking information for documentLine","operationId":"updateFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}}}}}}},"components":{"schemas":{"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}}
```

## DELETE /erp/documents/document/{documentId}/line/{lineId}/financebooking

> delete finance booking information for documentLine

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"delete":{"tags":["Document"],"summary":"delete finance booking information for documentLine","operationId":"deleteFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## POST /erp/documents/{id}/verifyTaxId

> verify the taxIdentificationNumber

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/verifyTaxId":{"post":{"tags":["Document"],"summary":"verify the taxIdentificationNumber","operationId":"verifyTaxId","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-account-TaxIDProtocol"}}}}}}}},"components":{"schemas":{"erp-account-TaxIDProtocol":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIdentificationNumber":{"type":"string","description":"Validated VAT ID.","maxLength":255,"minLength":0},"validity":{"type":"string","description":"VAT ID validity.","enum":["NOT_YET_VALIDATED","VALID","VALID_WITH_INVALID_ADDRESS","NOT_VALID"]},"validatedCompanyName":{"type":"string","description":"Validated company name."},"companyNameValidationResult":{"type":"string","description":"Detailed VAT ID validation result.","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedCity":{"type":"string","description":"Validated city."},"cityValidationResult":{"type":"string","description":"Detailed VAT ID validation result.","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedPostalCode":{"type":"string","description":"Validated postal code."},"postalCodeValidationResult":{"type":"string","description":"Detailed VAT ID validation result.","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedStreet":{"type":"string","description":"Validated street."},"streetValidationResult":{"type":"string","description":"Detailed VAT ID validation result.","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"usedApi":{"type":"string","description":"VAT ID validation procedure.","enum":["NONE","BZST","VIES"]},"apiResultCode":{"type":"string","description":"Validation result code."},"apiResultMessage":{"type":"string","description":"Validation result message (if available)."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /erp/documents/{id}/types

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

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/types":{"get":{"tags":["Document"],"summary":"list all available document-type-states to clone the current object into","operationId":"getPossibleTypeClones","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"Same as the transition identifier, for the UI."},"transitionId":{"type":"string","description":"Transition identifier."},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"Target document type identifier.","readOnly":true},"typeKey":{"type":"string","description":"Target document type key.","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"The document type is the default for the category.","readOnly":true},"targetState":{"type":"string","description":"Transition target state.","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sort order.","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## POST /erp/documents/{id}/types

> create a new document, based on an existing one

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/types":{"post":{"tags":["Document"],"summary":"create a new document, based on an existing one","operationId":"transformDocument","parameters":[{"name":"id","in":"path","description":"the document identifier used as spec for the new document","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentTypeTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentTypeTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"Transition identifier."},"targetTypeId":{"type":"integer","format":"int64","description":"Target document type identifier, if any."},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details of the document to create or update.","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"locationId":{"type":"string","description":"location-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"External document number."},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"supplierAccountId":{"type":"integer","format":"int64","description":"Default supplier when transferring from an order to supplier orders."},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when incomingGoodsStorageBinId is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when incomingGoodsPickTrolleyId is null)."},"priceModifiers":{"type":"array","description":"Document discounts.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"POS register identifier (for POS)."},"cashDrawerId":{"type":"integer","format":"int64","description":"Cash drawer identifier (for POS)."},"depositPaymentAmount":{"type":"number","description":"Deposit amount."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"One or more POS payments.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Document header and footer texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-RequestDocumentLine":{"description":"Details of the document to create or update.","properties":{"name":{"type":"string","description":"Article name."},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Article position number."},"description":{"type":"string","description":"Article description."},"lineId":{"type":"string","description":"Document line identifier in the current document."},"sourceLineId":{"type":"string","description":"Source document line identifier."},"refLineId":{"type":"string","description":"Referenced document line identifier (optional)."},"articleId":{"type":"string","description":"Article identifier of this line (optional)."},"onGoodsArrivalConvertIntoBundleArticleId":{"type":"string","description":"Bundle article the received goods of this line are converted into (optional)."},"externalId":{"type":"string","description":"Reference to the corresponding line in an external system."},"productPrice":{"type":"number","description":"Article price of this line (optional)."},"totalLinePrice":{"type":"number","description":"Total line price (optional)."},"priceModifiers":{"type":"array","description":"Price modifiers for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"Texts for this line (optional).","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Quantity to process in this transaction."},"storageId":{"type":"string","description":"Storage identifier (optional)."},"markCompleted":{"type":"boolean","default":false,"description":"Should the source line be marked as completed after a successful processing?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Required for converting a customer order into a supplier order."},"bookings":{"type":"array","description":"Bookings for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions for this document line.","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Document line commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"settledOpenItemId":{"type":"string","description":"Identifier of the open item to settle (only for OPEN_ITEM_SETTLEMENT)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"voucherTypeId":{"type":"string","description":"Voucher type of the sales line (VOUCHER_SALE only)"},"voucherId":{"type":"string","description":"The affected voucher: for VOUCHER_REDEMPTION the one to redeem, for VOUCHER_SALE on return, credit note or cancellation the returned one"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when `incomingGoodsStorageBinId` is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when `incomingGoodsPickTrolleyId` is null)."},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Trigger the label printing for this line."}}},"erp-document-RequestDocumentPriceModifier":{"description":"Document discounts.","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line","minimum":0},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"Texts for this line (optional).","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Bookings for this document line.","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"Booked source DocumentLineComponent identifier."},"quantity":{"type":"number","description":"Booked quantity."},"storageBinId":{"type":"integer","format":"int64","description":"Identifier of the storage bin booked to."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of a serial number to book, if any."}},"required":["quantity","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Commissions for this document line.","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address number."},"displayName":{"type":"string","description":"Display name.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"Tax number.","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Remark.","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Note."},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"All addresses except the default address.","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Contact person.","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Competent local court.","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Commercial register identifier.","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Cost center."},"languageCode":{"type":"string","description":"Account language."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the tax liability reversed under §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Tax numbers.","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account relations.","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Dunning block."},"payablesSum":{"type":"number","description":"Total payables.","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Total payables currency (ISO Alpha-3).","readOnly":true},"anonymized":{"type":"boolean","description":"Is the account anonymized?","readOnly":true},"receivablesSum":{"type":"number","description":"Total receivables.","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Total receivables currency (ISO Alpha-3).","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Credit limit currency (ISO Alpha-3).","readOnly":true},"accountZoneId":{"type":"string","description":"Account time zone (or time zone offset).","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Business relation types for accounts.","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-account-AccountAddress":{"description":"All addresses except the default address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"Tax identification number (VAT ID).","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI number.","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Address language."},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Default for the account type."}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"Default contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-account-AccountPerson":{"description":"Contact person.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment."},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"Sort order."},"remark":{"type":"string","description":"Special remark.","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Initial contact at."},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this active?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Default contact person.","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"deliveryBlocked":{"type":"boolean","default":false,"description":"Does the customer have a delivery block?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority for the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Credit limit.","minimum":0},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Trigger the collective billing manually only?"},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the collective billing."},"dueDate":{"type":"string","format":"date","description":"Next collective billing due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date after the current one."}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Should this be dunned?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Billing type, net or gross.","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Order block."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Delivery time in (working) days."},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"Eligible for inclusion in order proposals."},"minimumOrderValue":{"type":"number","description":"Minimum order value."},"freeShippingValue":{"type":"number","description":"Free of freight costs from."},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Creation of an outgoing delivery document for a drop shipping supplier order."},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Indicates whether drop shipping is allowed."}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code  IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Descriptions.","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"},"minItems":1},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Is the recommended retail price mandatory?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Descriptions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label.","minLength":1},"description":{"type":"string","description":"Description."},"languageCode":{"type":"string","description":"Description language.","minLength":1},"manufacturerUrl":{"type":"string","description":"Manufacturer URL."}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Tax numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account relations.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment."},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details of the processed fabrication document line.","properties":{"fabricationSerialNumbers":{"type":"array","description":"Fill this only when the serial numbers are to be determined manually before the fabrication starts.","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Serial number to produce.","properties":{"quantity":{"type":"number","description":"Deviating quantity for lots."},"serialNumberId":{"type":"integer","format":"int64","description":"Identifier of the serial number to produce (only for the targeted production of serial numbers that are already defined)."},"serialNumber1":{"type":"string","description":"Serial number 1."},"serialNumber2":{"type":"string","description":"Serial number 2."},"expiryDate":{"type":"string","format":"date","description":"Best-before or expiry date."},"note":{"type":"string","description":"Note."}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"May this type be used to create new documents?"},"nextNumber":{"type":"string","description":"Next document number.","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"Is this document type the default document type of its category?"},"active":{"type":"boolean","default":true,"description":"Is this document type active?"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"The business relation is mandatory."},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Assigned DMS document behavior.","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sort order."}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is this successor document type active?","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Own number range for serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Is the sequencer active?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Sequence type.","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Assignment procedure.","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Length.","minimum":0},"padChar":{"type":"string","description":"Padding character.","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Prefix expression."},"postExpression":{"type":"string","description":"Postfix expression."},"initialValue":{"type":"integer","format":"int64","description":"Initial value."},"numberUnique":{"type":"boolean","default":true,"description":"Uniqueness check."}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## POST /erp/documents/{id}/shipment

> Creates a shipment within the vds from a given document id

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/shipment":{"post":{"tags":["Document"],"summary":"Creates a shipment within the vds from a given document id","operationId":"createShipment","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-spi-CreateShipmentResponse"}}}}}}}},"components":{"schemas":{"erp-spi-CreateShipmentResponse":{"properties":{"shipmentId":{"type":"integer","format":"int64","description":"description/delivery Text of this order (internal vds description)"}}}}}}
```

## GET /erp/documents/{id}/protocol

> Lists all protocol entries for this document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/protocol":{"get":{"tags":["Document"],"summary":"Lists all protocol entries for this document","operationId":"getDocumentProtocolEntries","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentProtocol":{"description":"Document protocol.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Protocol entry document type.","readOnly":true},"documentTypeLabels":{"type":"array","description":"Document type label of this protocol entry.","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Document number of this protocol entry.","readOnly":true},"type":{"type":"string","description":"Kinds of entries in the DocumentProtocol.","enum":["MANUAL","PROBLEM","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MANUALLY_TRANSFERRED_FROM_WORKFLOW_STATE","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REMAINDER_CLOSED","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Protocol entry text."},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"User who created the entry.","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Protocol entry timestamp."}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}}
```

## POST /erp/documents/{id}/protocol

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/protocol":{"post":{"tags":["Document"],"operationId":"addManualDocumentProtocolEntry","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-CreateOrUpdateManualDocumentProtocolRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}},"components":{"schemas":{"erp-document-CreateOrUpdateManualDocumentProtocolRequest":{"description":"Request for creating a manual entry in the document protocol.","properties":{"customMessage":{"type":"string","description":"Text for the document protocol.","minLength":1}},"required":["customMessage"]},"erp-document-DocumentProtocol":{"description":"Document protocol.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Protocol entry document type.","readOnly":true},"documentTypeLabels":{"type":"array","description":"Document type label of this protocol entry.","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Document number of this protocol entry.","readOnly":true},"type":{"type":"string","description":"Kinds of entries in the DocumentProtocol.","enum":["MANUAL","PROBLEM","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MANUALLY_TRANSFERRED_FROM_WORKFLOW_STATE","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REMAINDER_CLOSED","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Protocol entry text."},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"User who created the entry.","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Protocol entry timestamp."}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)","minLength":1},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)","minLength":1}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}}
```

## GET /erp/documents/{id}/leasable-lock

> Check whether a resource is locked

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/leasable-lock":{"get":{"tags":["Document"],"summary":"Check whether a resource is locked","operationId":"getLeasableLock","parameters":[{"name":"id","in":"path","description":"Resource identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string","minLength":1},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}}
```

## POST /erp/documents/{id}/leasable-lock

> Create a new lock, optionally with a validity period

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/leasable-lock":{"post":{"tags":["Document"],"summary":"Create a new lock, optionally with a validity period","operationId":"createLeasableLock","parameters":[{"name":"id","in":"path","description":"Identifier of the resource to lock.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"leasePeriod","in":"query","description":"Optional lease duration in seconds.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string","minLength":1},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}}
```

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

> Try to transfer an order into picking and log the result

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}":{"post":{"tags":["Document"],"summary":"Try to transfer an order into picking and log the result","operationId":"tryTransferIntoPicking","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"picklistTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## POST /erp/documents/{documentId}/process-input

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/process-input":{"post":{"tags":["Document"],"operationId":"processInput_3","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentInputProcessingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentInputProcessingResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentInputProcessingRequest":{"description":"Request for the document input processing.","properties":{"inputData":{"type":"string","description":"User input or scan."},"lastProcessedLineId":{"type":"integer","format":"int64","description":"Last processed line."},"lastProcessedBookingId":{"type":"integer","format":"int64","description":"Last processed booking."},"inputList":{"type":"array","description":"Inputs that are executed one after another.","items":{"type":"string","description":"Inputs that are executed one after another."}}}},"erp-document-DocumentInputProcessingResponse":{"description":"Document input processing response.","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"document":{"$ref":"#/components/schemas/erp-document-Document"},"lastProcessedLineId":{"type":"integer","format":"int64","description":"Last processed line."},"lastProcessedBookingId":{"type":"integer","format":"int64","description":"Last processed booking."},"validationHints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"}}},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true}}}}
```

## GET /erp/documents/{documentId}/parcels

> Return the document parcels

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/parcels":{"get":{"tags":["Document"],"summary":"Return the document parcels","operationId":"getParcels","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Parcels of documents.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Parcel position."},"weight":{"type":"number","description":"Parcel weight."},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Length."},"width":{"type":"number","description":"Width."},"height":{"type":"number","description":"Height."},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Tracking number.","readOnly":true},"lines":{"type":"array","description":"Parcel content.","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Document parcel content.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the document line."},"documentLineBookingId":{"type":"integer","format":"int64","description":"Reference to the document line booking."},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Quantity."}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## POST /erp/documents/{documentId}/parcels

> Create a parcel for a document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/parcels":{"post":{"tags":["Document"],"summary":"Create a parcel for a document","operationId":"createOrUpdateParcel_1","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Parcels of documents.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Parcel position."},"weight":{"type":"number","description":"Parcel weight."},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Length."},"width":{"type":"number","description":"Width."},"height":{"type":"number","description":"Height."},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Tracking number.","readOnly":true},"lines":{"type":"array","description":"Parcel content.","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Document parcel content.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the document line."},"documentLineBookingId":{"type":"integer","format":"int64","description":"Reference to the document line booking."},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Quantity."}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## POST /erp/documents/perform-contract-evaluation

> Create a Job according to the Request

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/perform-contract-evaluation":{"post":{"tags":["Document"],"summary":"Create a Job according to the Request","operationId":"createContractTermJobRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-ContractEvaluationJobRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-document-ContractEvaluationJobRequest":{"description":"Request for creating the job for the contract billing.","properties":{"blackList":{"type":"array","description":"Ignore ID-List","items":{"type":"integer","format":"int64","description":"Ignore ID-List"}},"whiteList":{"type":"array","description":"Use ID-List","items":{"type":"integer","format":"int64","description":"Use ID-List"}},"variableSubstitutionList":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"documentDate":{"type":"string","format":"date","description":"Deviating document date."},"deliveryDate":{"type":"string","format":"date","description":"Deviating delivery date."},"addBillingPeriod":{"type":"boolean","default":true,"description":"Add the billing period?"},"note":{"type":"string","description":"Note."},"print":{"type":"boolean","default":false,"description":"Should this be printed?"}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Variable values.","properties":{"variableSubstitutions":{"type":"array","description":"Variable assignments.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Variable assignments.","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Values to insert.","items":{"type":"string","description":"Values to insert."}}}},"common-cunit-QueryPresetVariable":{"description":"Variable to replace.","properties":{"path":{"type":"string","description":"Path that uniquely describes this attribute."},"definition":{"$ref":"#/components/schemas/core-cunit-MetaContent"},"mandatory":{"type":"boolean","description":"Whether the variable is mandatory or not."},"variableName":{"type":"string","description":"Variable name."},"visible":{"type":"boolean","default":true,"description":"Is this a visible variable?"},"alignX":{"type":"integer","format":"int32","description":"Layout in the UI - x coordinate."},"alignY":{"type":"integer","format":"int32","description":"Layout in the UI - y coordinate."},"alignWidth":{"type":"integer","format":"int32","description":"Layout in the UI - width."},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"core-cunit-MetaContent":{"description":"Variable definition.","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"Cell column description (when nested).","items":{"$ref":"#/components/schemas/core-cunit-MetaContent"}}}}]},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifying the attribute."},"attribute":{"type":"string","description":"Name of the attribute containing the result."},"path":{"type":"string","description":"Path that uniquely describes this attribute."},"displayName":{"type":"string","description":"Field name."},"displayNameOverride":{"type":"boolean","default":false,"description":"The field name was overridden (alias or function)."},"groupDisplayName":{"type":"string","description":"Field group name."},"parentDisplayName":{"type":"string","description":"Referencing field name."},"resultable":{"type":"boolean","default":true,"description":"Can this field be a result field?"},"filterable":{"type":"boolean","default":true,"description":"Can this field be filtered by?"},"sortable":{"type":"boolean","default":true,"description":"Is this field sortable?"},"visible":{"type":"boolean","default":true,"description":"Should this field be shown?"},"functions":{"type":"array","description":"Applied functions (when this is used as result metadata).","items":{"type":"string","description":"Applied functions (when this is used as result metadata)."}},"sortDirection":{"type":"string","description":"Information on how this column was sorted."},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"Attribute data type identifier (when dataType is empty).","readOnly":true},"modelType":{"type":"string","description":"The attribute belongs to the model type 'static' or 'dynamic'.","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier of the entity this attribute belongs to (e.g. 'AccountEntity').","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"For relation attributes: fully qualified class name of the target entity (e.g. 'ag.vario.erp.account.AccountEntity').","readOnly":true},"headers":{"type":"array","description":"For a grouped header (e.g. a cross table) the individual groups are described here.","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-CuAttributeConstraint":{"description":"Attribute constraints.","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimum length (of strings or arrays).","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximum length (of strings or arrays).","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"Minimum value.","readOnly":true},"includeMinValue":{"type":"boolean","description":"Is the minimum value inclusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"Maximum value.","readOnly":true},"includeMaxValue":{"type":"boolean","description":"Is the maximum value inclusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"Is the value 'null' forbidden?","readOnly":true},"notBlank":{"type":"boolean","description":"For strings: is a string consisting only of whitespace forbidden?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximum number of decimal places.","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"Attribute data type (when dataTypeIdentifier is empty).","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"Which type it is.","readOnly":true},"objectRefIdentifier":{"type":"string","description":"For Object_Ref: which type exactly it is.","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"Which functions are allowed?","items":{"type":"string","description":"Which functions are allowed?"},"readOnly":true},"predicateOperations":{"type":"array","description":"Which operations are allowed?","items":{"type":"string","description":"Which operations are allowed?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit attribute filter options.","properties":{"filterValues":{"type":"array","description":"Possible filter values.","items":{"type":"string","description":"Possible filter values."}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"For a grouped header (e.g. a cross table) the individual groups are described here.","properties":{"displayName":{"type":"string","description":"Field name."},"displayNameOverride":{"type":"boolean","default":false,"description":"The field name was overridden (alias or function)."},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"Attribute data type identifier (when dataType is empty).","readOnly":true},"groupDisplayName":{"type":"string","description":"Field group name."},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Conditions for selecting storage bins.","properties":{"type":{"type":"string","description":"Filter operation.","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"Child definitions (for a junction).","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"Filter values.","items":{"type":"string","description":"Filter values."}},"visible":{"type":"boolean","default":true,"description":"Visibility for variables."},"functions":{"type":"array","description":"SQL function applied in the predicate.","items":{"type":"string","description":"SQL function applied in the predicate."}}},"required":["operator","type"]},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}}
```

## POST /erp/documents/document/{documentId}/validate

> validate a document by using the validation service

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/validate":{"post":{"tags":["Document"],"summary":"validate a document by using the validation service","operationId":"validateDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationResponse"}}}}}}}},"components":{"schemas":{"einvoice-unknownmodule-ValidationResponse":{"properties":{"xmlDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationXmlDetails"},"pdfDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationPdfDetails"},"embeddingDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationEmbeddingDetails"},"systemError":{"type":"string"},"shelfDocumentId":{"type":"integer","format":"int64"}}},"einvoice-unknownmodule-ValidationXmlDetails":{"properties":{"valid":{"type":"boolean"},"hasWarnings":{"type":"boolean"},"validSchema":{"type":"boolean"},"validNamespaces":{"type":"boolean"},"validEncoding":{"type":"boolean"},"validCodelists":{"type":"boolean"},"validFormat":{"type":"boolean"},"validVat":{"type":"boolean"},"validBusinessRules":{"type":"boolean"},"validProfile":{"type":"array","items":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationXmlType"}},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}},"einvoice-unknownmodule-ValidationXmlType":{"properties":{"value":{"type":"boolean"},"profile":{"type":"integer","format":"int32"}}},"einvoice-unknownmodule-ValidationPdfDetails":{"properties":{"valid":{"type":"boolean"},"foundFlavour":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}},"einvoice-unknownmodule-ValidationEmbeddingDetails":{"properties":{"validFileEmbedding":{"type":"boolean"},"validFilename":{"type":"boolean"},"validXMP":{"type":"boolean"},"canExtractXML":{"type":"boolean"},"versionFromXML":{"type":"string"},"documentTypeFromXML":{"type":"string"},"guidelineFromXML":{"type":"string"},"variantFromXML":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## POST /erp/documents/document/{documentId}/multiple\_lines

> add new lines to an existing document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/multiple_lines":{"post":{"tags":["Document"],"summary":"add new lines to an existing document","operationId":"addLinesToDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentMultipleLinesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentMultipleLinesRequest":{"properties":{"documentLines":{"type":"array","description":"New document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley identifier for the incoming goods (when incomingGoodsStorageBinId is null)."},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"Storage bin identifier for the incoming goods (when incomingGoodsPickTrolleyId is null)."},"additionalParameters":{"type":"array","description":"Additional parameters and user decisions.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## POST /erp/documents/document/{documentId}/line

> add a new line to an existing document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/document/{documentId}/line":{"post":{"tags":["Document"],"summary":"add a new line to an existing document","operationId":"addLineToDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPartialUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPartialUpdateRequest":{"properties":{"documentLine":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"additionalParameters":{"type":"array","description":"Additional parameters and user decisions.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## POST /erp/documents/contract/{contractId}/deactivate-line/{contractLineId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/contract/{contractId}/deactivate-line/{contractLineId}":{"post":{"tags":["Document"],"operationId":"deactivateContractLine","parameters":[{"name":"contractId","in":"path","description":"Contract identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contractLineId","in":"path","description":"Contract line identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## POST /erp/documents/contract/{contractId}/activate-line/{contractLineId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/contract/{contractId}/activate-line/{contractLineId}":{"post":{"tags":["Document"],"operationId":"activateContractLine","parameters":[{"name":"contractId","in":"path","description":"Contract identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contractLineId","in":"path","description":"Contract line identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]}}}}
```

## GET /erp/documents/{id}

> Find an existing Resource by identifier

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}":{"get":{"tags":["Document"],"summary":"Find an existing Resource by identifier","operationId":"getById_149","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## PATCH /erp/documents/{id}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}":{"patch":{"tags":["Document"],"operationId":"patchDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPatchRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPatchRequest":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}},"required":["document"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-DocumentValidationHints":{"description":"Hints.","properties":{"details":{"type":"array","description":"Hints from the validation in the error format.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra displays.","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Is this document taken into account for the credit limit?","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"Possible predecessor document types.","items":{"type":"string","description":"Possible predecessor document types."}},"sumAmountOfProgressInvoices":{"type":"number","description":"Total amount of the progress invoices."},"sumAmountOfDepositInvoices":{"type":"number","description":"Total amount of the deposit invoices."},"sumAmountOfPartialInvoices":{"type":"number","description":"Total amount of the partial invoices."},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Total amount of the invoices and delivery document invoices."},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"Open total amount for progress invoices."},"totalAmountDependingFromBillingType":{"type":"number","description":"Total amount depending on the billing type."},"orderRefs":{"type":"array","description":"References to the customer and supplier orders in the document chain.","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"autoPrintPaperReceipt":{"type":"boolean","description":"Print paper documents automatically (sales channel default, only for POS documents).","readOnly":true}}},"erp-account-AccountLoanValue":{"description":"Currently calculated values for the account credit limit.","properties":{"accountId":{"type":"integer","format":"int64","description":"Account."},"maximalLoan":{"type":"number","description":"Credit limit."},"currentLoan":{"type":"number","description":"Current loan."},"nonInvoicedDocumentLoan":{"type":"number","description":"Amount from orders."},"receivableLoan":{"type":"number","description":"Amount from receivables."},"payablesSum":{"type":"number","description":"Amount from payables (negative)."},"currentDocumentLoan":{"type":"number","description":"Current document amount."},"remainingLoan":{"type":"number","description":"Remaining amount until the credit limit is reached."},"exceededLoan":{"type":"number","description":"Credit amount exceeded."},"unconsideredAmount":{"type":"number","description":"Amount not taken into account."}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Finance information.","properties":{"accountingStatus":{"type":"string","description":"Finance status of the document journal entry.","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Finance transfer date.","readOnly":true},"runState":{"type":"string","description":"Processing state.","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Reference to a Document.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## GET /erp/documents/{refId}/workflow-state

> Return the current workflow instance state for the given reference

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{refId}/workflow-state":{"get":{"tags":["Document"],"summary":"Return the current workflow instance state for the given reference","operationId":"getWorkflowState_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow instance found.","content":{"*/*":{"schema":{"type":"string","description":"Workflow instance status.","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}},"404":{"description":"No workflow instance exists yet.","content":{"*/*":{"schema":{"type":"string","description":"Workflow instance status.","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}}}}}}}
```

## GET /erp/documents/{refId}/workflow-instances-preset

> Return a query preset for selecting all workflow instances for the given reference

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{refId}/workflow-instances-preset":{"get":{"tags":["Document"],"summary":"Return a query preset for selecting all workflow instances for the given reference","operationId":"getWorkflowInstancesPreset_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow instance found.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-cunit-QueryPreset"}}}}}}}},"components":{"schemas":{"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"What this preset can represent, QUERY or STATEMENT.","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"Template this filter was assigned to.","minLength":1},"templateGroupKey":{"type":"string","description":"The templateGroupKey this filter was assigned to.","minLength":1},"label":{"type":"string","description":"Filter label.","minLength":1},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variables for this preset.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"When mode == STATEMENT, the VQL query."},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"Results.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"Additional configurations.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetic terms - this is where the actual calculation goes.","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"Cell column description (when nested).","items":{"$ref":"#/components/schemas/core-cunit-MetaContent"},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"Intended for workflows."},"outputReportGroupIdentifier":{"type":"string","description":"Identifier of an OutputReportGroup (moduleKey=cunit) used as the print template for this preset."},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"common-cunit-QueryPresetVariable":{"description":"Variable to replace.","properties":{"path":{"type":"string","description":"Path that uniquely describes this attribute."},"definition":{"$ref":"#/components/schemas/core-cunit-MetaContent"},"mandatory":{"type":"boolean","description":"Whether the variable is mandatory or not."},"variableName":{"type":"string","description":"Variable name."},"visible":{"type":"boolean","default":true,"description":"Is this a visible variable?"},"alignX":{"type":"integer","format":"int32","description":"Layout in the UI - x coordinate."},"alignY":{"type":"integer","format":"int32","description":"Layout in the UI - y coordinate."},"alignWidth":{"type":"integer","format":"int32","description":"Layout in the UI - width."},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"core-cunit-MetaContent":{"description":"Variable definition.","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"Cell column description (when nested).","items":{"$ref":"#/components/schemas/core-cunit-MetaContent"}}}}]},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifying the attribute."},"attribute":{"type":"string","description":"Name of the attribute containing the result."},"path":{"type":"string","description":"Path that uniquely describes this attribute."},"displayName":{"type":"string","description":"Field name."},"displayNameOverride":{"type":"boolean","default":false,"description":"The field name was overridden (alias or function)."},"groupDisplayName":{"type":"string","description":"Field group name."},"parentDisplayName":{"type":"string","description":"Referencing field name."},"resultable":{"type":"boolean","default":true,"description":"Can this field be a result field?"},"filterable":{"type":"boolean","default":true,"description":"Can this field be filtered by?"},"sortable":{"type":"boolean","default":true,"description":"Is this field sortable?"},"visible":{"type":"boolean","default":true,"description":"Should this field be shown?"},"functions":{"type":"array","description":"Applied functions (when this is used as result metadata).","items":{"type":"string","description":"Applied functions (when this is used as result metadata)."}},"sortDirection":{"type":"string","description":"Information on how this column was sorted."},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"Attribute data type identifier (when dataType is empty).","readOnly":true},"modelType":{"type":"string","description":"The attribute belongs to the model type 'static' or 'dynamic'.","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier of the entity this attribute belongs to (e.g. 'AccountEntity').","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"For relation attributes: fully qualified class name of the target entity (e.g. 'ag.vario.erp.account.AccountEntity').","readOnly":true},"headers":{"type":"array","description":"For a grouped header (e.g. a cross table) the individual groups are described here.","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-CuAttributeConstraint":{"description":"Attribute constraints.","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimum length (of strings or arrays).","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximum length (of strings or arrays).","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"Minimum value.","readOnly":true},"includeMinValue":{"type":"boolean","description":"Is the minimum value inclusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"Maximum value.","readOnly":true},"includeMaxValue":{"type":"boolean","description":"Is the maximum value inclusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"Is the value 'null' forbidden?","readOnly":true},"notBlank":{"type":"boolean","description":"For strings: is a string consisting only of whitespace forbidden?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximum number of decimal places.","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"Attribute data type (when dataTypeIdentifier is empty).","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"Which type it is.","readOnly":true},"objectRefIdentifier":{"type":"string","description":"For Object_Ref: which type exactly it is.","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"Which functions are allowed?","items":{"type":"string","description":"Which functions are allowed?"},"readOnly":true},"predicateOperations":{"type":"array","description":"Which operations are allowed?","items":{"type":"string","description":"Which operations are allowed?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit attribute filter options.","properties":{"filterValues":{"type":"array","description":"Possible filter values.","items":{"type":"string","description":"Possible filter values."}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"For a grouped header (e.g. a cross table) the individual groups are described here.","properties":{"displayName":{"type":"string","description":"Field name."},"displayNameOverride":{"type":"boolean","default":false,"description":"The field name was overridden (alias or function)."},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"Attribute data type identifier (when dataType is empty).","readOnly":true},"groupDisplayName":{"type":"string","description":"Field group name."},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Conditions for selecting storage bins.","properties":{"type":{"type":"string","description":"Filter operation.","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"Child definitions (for a junction).","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"Filter values.","items":{"type":"string","description":"Filter values."}},"visible":{"type":"boolean","default":true,"description":"Visibility for variables."},"functions":{"type":"array","description":"SQL function applied in the predicate.","items":{"type":"string","description":"SQL function applied in the predicate."}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Results.","properties":{"property":{"type":"string","description":"property","minLength":1},"displayName":{"type":"string","description":"Column title."},"functions":{"type":"array","description":"Functions.","items":{"type":"string","description":"Functions."}},"visible":{"type":"boolean","default":true,"description":"Visible result column."}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"Sort and order instructions.","properties":{"property":{"type":"string","description":"property","minLength":1},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"Query limit (MaxRecordCount)."}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"Should the query be executed with a DISTINCT?"}}},"common-cunit-QueryPresetTransformation":{"description":"Additional configurations.","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"Contains the fields responsible for forming the rows in a cross table (essentially the group key).","properties":{"rowSpecs":{"type":"array","description":"Contains the fields responsible for forming the rows in a cross table (essentially the group key).","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"minItems":1},"columnSpecs":{"type":"array","description":"Contains the fields that are created as dynamic columns in the cross table.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"minItems":1},"results":{"type":"array","description":"Contains the fields that are determined per rowSpec combination depending on the column value.","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"},"minItems":1}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"Contains the fields that are determined per rowSpec combination depending on the column value.","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"Value representation.","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"Should a column total be created?"},"rowMode":{"type":"string","description":"Should a row total be created?","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"Function the cell values are aggregated with."}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetic terms - this is where the actual calculation goes.","properties":{"termName":{"type":"string","description":"Term name for processing and display."},"terms":{"type":"array","description":"Inner terms - either references to attributes or further nestings of the calculation.","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Operations to be performed on the terms.","items":{"type":"string","description":"Operations to be performed on the terms.","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Inner terms - either references to attributes or further nestings of the calculation.","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Actual attribute from the template."},"fixedValue":{"type":"number","description":"Fixed value."}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Term fragment - a further nesting with its own operations.","properties":{"terms":{"type":"array","description":"Inner terms - either references to attributes or further nestings of the calculation.","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Operations to be performed on the terms.","items":{"type":"string","description":"Operations to be performed on the terms.","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"All user and group permissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"User permissions.","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Group permissions.","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Access rights for all users.","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"User permissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Permission.","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Group permissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Permission.","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"User-related settings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"Is this pinned?"}},"required":["pinned"]}}}}
```

## GET /erp/documents/{refId}/latest-workflow-instance

> Return the latest workflow instance for the given reference

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{refId}/latest-workflow-instance":{"get":{"tags":["Document"],"summary":"Return the latest workflow instance for the given reference","operationId":"getLatestWorkflowInstance_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow instance found.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}},"404":{"description":"No workflow instance exists yet.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Workflow instance status.","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Workflow steps.","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Log entries sorted chronologically.","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Workflow steps.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Work item processing state.","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED","ABORTED_BY_SUB_WORKFLOW"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow element that is represented."},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work item in the parent workflow when this is a sub workflow."},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Log entries sorted chronologically.","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"For split gateways: with which result this work item was executed."}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Log entries sorted chronologically.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"Workflow instance identifier."},"workItemId":{"type":"integer","format":"int64","description":"Work item identifier."},"logTime":{"type":"string","format":"date-time","description":"Timestamp."},"origin":{"type":"string","description":"What triggered this entry?","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Message."},"messageKey":{"type":"string","description":"The i18n key."},"propertyPath":{"type":"string","description":"Path."},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameters for the i18n message."},"description":"Parameters for the i18n message."}}}}}}
```

## GET /erp/documents/{id}/ui-hints

> Lists all ui-hints for this document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/ui-hints":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHints","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentUiHintCollection"}}}}}}}},"components":{"schemas":{"erp-document-DocumentUiHintCollection":{"properties":{"documentHints":{"type":"array","description":"UI hints relating to the document type and the account.","items":{"type":"string","description":"UI hints relating to the document type and the account."}},"positionHints":{"type":"array","description":"UI hints relating to the document type and an article.","items":{"$ref":"#/components/schemas/erp-document-PositionUiHintCollection"}}}},"erp-document-PositionUiHintCollection":{"description":"UI hints relating to the document type and an article.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article the UI hints refer to."},"uiHints":{"type":"array","description":"UI hints for the article and the document types.","items":{"type":"string","description":"UI hints for the article and the document types."}}}}}}}
```

## GET /erp/documents/{id}/ui-hints/article/{articleId}

> Lists all ui-hints for this document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/ui-hints/article/{articleId}":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHintsForArticle","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"articleId","in":"path","description":"article identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## GET /erp/documents/{id}/ui-hints/account/{accountId}

> Lists all ui-hints for this document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/ui-hints/account/{accountId}":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHintsForAccount","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## GET /erp/documents/{id}/types/history

> return a tree of predecessors and successors of this document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/types/history":{"get":{"tags":["Document"],"summary":"return a tree of predecessors and successors of this document","operationId":"nodeHistory","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentHistoryNode"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentHistoryNode":{"properties":{"documentId":{"type":"string","description":"the id of the document"},"number":{"type":"string","description":"the number of the document"},"documentDate":{"type":"string","format":"date","description":"documentDate"},"totalGrossPrice":{"type":"number","description":"gross total price (GROSS)"},"totalNetPrice":{"type":"number","description":"net total price (NET)"},"documentType":{"type":"string","description":"type of this document"},"documentTypeId":{"type":"string","description":"typeId of this document"},"documentState":{"type":"string","description":"state of this document"},"documentTypeCategory":{"type":"string","description":"category of this document"},"childNodes":{"type":"array","description":"list of documents, this document was transferred into","items":{"$ref":"#/components/schemas/erp-document-DocumentHistoryNode"}},"requested":{"type":"boolean","default":false,"description":"indicates that this document was requested"},"chainIdentifier":{"type":"string","description":"Document chain identifier."}}}}}}
```

## GET /erp/documents/{id}/text-templates

> Return the manual text templates for header and footer texts

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/text-templates":{"get":{"tags":["Document"],"summary":"Return the manual text templates for header and footer texts","operationId":"getManualTemplates","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"textPosition","in":"query","required":true,"schema":{"type":"string","enum":["HEADER_TEXT","FOOTER_TEXT"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-texttemplates-TextTemplate"}}}}}}}}},"components":{"schemas":{"erp-texttemplates-TextTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Text template label."},"templateType":{"type":"string","default":"AUTOMATIC","description":"Template purpose.","enum":["UI_HINT","AUTOMATIC","MANUAL"]},"uiHintTypes":{"type":"array","description":"When a UI hint is shown.","items":{"type":"string","description":"When a UI hint is shown.","enum":["UI_HINT_MASTER_DATA","UI_HINT_DOCUMENT"]}},"accountId":{"type":"integer","format":"int64","description":"Account these templates apply to."},"articleId":{"type":"integer","format":"int64","description":"Article these templates apply to."},"targetDocumentTypes":{"type":"array","description":"Target document types; together with the predecessor document types they define the transitions this template applies to.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"sourceDocumentTypes":{"type":"array","description":"Predecessor document types; together with the target document types they define the transitions this template applies to.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","description":"Transfer the generated DocumentTexts when moving to successor documents?","default":null},"separateLine":{"type":"boolean","description":"Is a separate DocumentLine created for the text template?","default":null},"position":{"type":"string","description":"Generated DocumentText position.","enum":["HEADER_TEXT","FOOTER_TEXT"]},"active":{"type":"boolean","default":true,"description":"Is this text template active?","readOnly":true},"languageSpecificContents":{"type":"array","description":"Texts in the offered languages.","items":{"$ref":"#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent"}},"resolveContentInFollowUpDocument":{"type":"boolean","default":false,"description":"Should the text template content only be resolved when the document is transferred?"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-texttemplates-LocalizedTextTemplateContent":{"description":"Texts in the offered languages.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCodeIsoAlpha2":{"type":"string","description":"Text language."},"content":{"type":"string","description":"Text"}},"required":["content","languageCodeIsoAlpha2"]}}}}
```

## GET /erp/documents/{id}/successor-document-assignable-lines

> Lists successor document lines for predecessor assignment

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/successor-document-assignable-lines":{"get":{"tags":["Document"],"summary":"Lists successor document lines for predecessor assignment","operationId":"getSuccessorDocumentAssignableLines","parameters":[{"name":"id","in":"path","description":"ID of successor document","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-SuccessorDocumentAssignableLinesDocumentLine"}}}}}}}},"components":{"schemas":{"erp-document-SuccessorDocumentAssignableLinesDocumentLine":{"description":"Document lines for the predecessor document assignment.","properties":{"unassignedLines":{"type":"array","description":"Lines without a predecessor document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true},"uncompletedLines":{"type":"array","description":"Lines that were not (fully) transferred.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true},"completedLines":{"type":"array","description":"Lines that were fully transferred.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true}}},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}}}}}
```

## GET /erp/documents/{id}/predecessor-document-assignable-lines

> Lists predecessor document lines for predecessor assignment

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/predecessor-document-assignable-lines":{"get":{"tags":["Document"],"summary":"Lists predecessor document lines for predecessor assignment","operationId":"getPredecessorDocumentAssignableLines","parameters":[{"name":"id","in":"path","description":"ID of predecessor document","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}}}}}
```

## GET /erp/documents/{id}/lines/{lineId}/storages

> return all possible storages for this documentLine

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines/{lineId}/storages":{"get":{"tags":["Document"],"summary":"return all possible storages for this documentLine","operationId":"getDocumentLineStorages","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"Document line identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLineStorageResponse"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLineStorageResponse":{"description":"storage option for a document-line","properties":{"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reservedQuantity":{"type":"number","description":"reserved quantity (from customer-orders)"},"orderedQuantity":{"type":"number","description":"already ordered quantity (from supplier-orders)"},"stockAmount":{"type":"number","description":"the current stock amount"},"stockAvailable":{"type":"number","description":"the current available stock amount"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

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

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines/{lineId}/show-price-origin":{"get":{"tags":["Document"],"operationId":"getPriceOriginToLine","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID of the document line","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"}}}}}}}},"components":{"schemas":{"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}}}}}
```

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

> Returns the average and the last purchase price of the DocumentLine article

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines/{lineId}/purchase-price-statistic":{"get":{"tags":["Document"],"summary":"Returns the average and the last purchase price of the DocumentLine article","operationId":"getPurchasePriceStatistic_1","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID of the document line","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-PurchasePriceStatistic"}}}}}}}},"components":{"schemas":{"erp-product-PurchasePriceStatistic":{"description":"Price statistics (average and last purchase price).","properties":{"averagePrice":{"type":"number","description":"Average purchase price.","readOnly":true},"averagePriceBookedAt":{"type":"string","format":"date","description":"Value date of the average purchase price.","readOnly":true},"priceUnitAveragePrice":{"type":"number","description":"Price unit of the average purchase price.","readOnly":true},"lastPrice":{"type":"number","description":"Last purchase price.","readOnly":true},"priceUnitLastPrice":{"type":"number","description":"Price unit of the last purchase price.","readOnly":true},"lastPriceUpdatedAt":{"type":"string","format":"date-time","description":"Last purchase price recording time.","readOnly":true},"lastPriceBookedAt":{"type":"string","format":"date","description":"Value date of the last purchase price.","readOnly":true},"mainSupplierAccount":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainSupplierProductPrice":{"$ref":"#/components/schemas/erp-product-ProductPrice"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Contains a sales or purchase price for a product.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Net price."},"grossPrice":{"type":"number","description":"Gross price."},"priceBase":{"type":"string","description":"Price base.","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Determines whether this is a sales or a purchase price.","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Purchase price for the calculation.","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Surcharge value in the purchase price calculation."},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Determines from which quantity this price is valid."},"validFrom":{"type":"string","format":"date","description":"Valid from."},"validUntil":{"type":"string","format":"date","description":"Valid until."},"specialOfferPrice":{"type":"boolean","default":false,"description":"Special offer price."},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Currency.","properties":{"id":{"type":"integer","format":"int64","description":"Currency identifier."},"isoAlpha3":{"type":"string","description":"Currency ISO Alpha-3 code."},"label":{"type":"string","description":"Currency label.","readOnly":true},"symbol":{"type":"string","description":"Currency symbol.","readOnly":true}}}}}}
```

## GET /erp/documents/{id}/lines/text-templates

> Return the manual text templates for text lines that make sense for the document

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines/text-templates":{"get":{"tags":["Document"],"summary":"Return the manual text templates for text lines that make sense for the document","operationId":"getManualTemplateLines","parameters":[{"name":"id","in":"path","description":"Document identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-texttemplates-TextTemplate"}}}}}}}}},"components":{"schemas":{"erp-texttemplates-TextTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Text template label."},"templateType":{"type":"string","default":"AUTOMATIC","description":"Template purpose.","enum":["UI_HINT","AUTOMATIC","MANUAL"]},"uiHintTypes":{"type":"array","description":"When a UI hint is shown.","items":{"type":"string","description":"When a UI hint is shown.","enum":["UI_HINT_MASTER_DATA","UI_HINT_DOCUMENT"]}},"accountId":{"type":"integer","format":"int64","description":"Account these templates apply to."},"articleId":{"type":"integer","format":"int64","description":"Article these templates apply to."},"targetDocumentTypes":{"type":"array","description":"Target document types; together with the predecessor document types they define the transitions this template applies to.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"sourceDocumentTypes":{"type":"array","description":"Predecessor document types; together with the target document types they define the transitions this template applies to.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","description":"Transfer the generated DocumentTexts when moving to successor documents?","default":null},"separateLine":{"type":"boolean","description":"Is a separate DocumentLine created for the text template?","default":null},"position":{"type":"string","description":"Generated DocumentText position.","enum":["HEADER_TEXT","FOOTER_TEXT"]},"active":{"type":"boolean","default":true,"description":"Is this text template active?","readOnly":true},"languageSpecificContents":{"type":"array","description":"Texts in the offered languages.","items":{"$ref":"#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent"}},"resolveContentInFollowUpDocument":{"type":"boolean","default":false,"description":"Should the text template content only be resolved when the document is transferred?"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-texttemplates-LocalizedTextTemplateContent":{"description":"Texts in the offered languages.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCodeIsoAlpha2":{"type":"string","description":"Text language."},"content":{"type":"string","description":"Text"}},"required":["content","languageCodeIsoAlpha2"]}}}}
```

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

> Lists all orderable document lines

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-supplier-order":{"get":{"tags":["Document"],"summary":"Lists all orderable document lines","operationId":"getOrderableLinesToTransfer","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-OrderableLine"}}}}}}}}},"components":{"schemas":{"erp-document-OrderableLine":{"description":"Orderable lines for the transfer into a supplier order.","properties":{"documentLineId":{"type":"string","description":"DocumentLine identifier.","readOnly":true},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"articleNumber":{"type":"string","description":"Article number.","readOnly":true},"articleName":{"type":"string","description":"Article name.","readOnly":true},"articleId":{"type":"integer","format":"int64","description":"Article number.","readOnly":true},"quantity":{"type":"number","description":"Quantity."},"order":{"type":"boolean","default":true,"description":"Should this be ordered?"},"supplierRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availableQuantity":{"type":"number","description":"Available quantity.","readOnly":true},"orderedQuantity":{"type":"number","description":"Ordered quantity.","readOnly":true},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"],"readOnly":true}},"required":["order","quantity"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

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

> List all lines allowed to transfer in supplier delivery

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-supplier-delivery":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in supplier delivery","operationId":"getToSupplierDeliveryTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of supplier order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"Lines transferable into a delivery document, with document numbers.","properties":{"deliveryTransferableLines":{"type":"array","description":"Lines transferable into a delivery document.","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"External document number."},"documentNumber":{"type":"string","description":"Document number."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-document-DeliveryTransferableLine":{"description":"Line transferable into a delivery document.","properties":{"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"position":{"type":"integer","format":"int32","description":"Position number."},"articleNumber":{"type":"string","description":"Article number."},"articleName":{"type":"string","description":"Article name."},"quantity":{"type":"number","description":"Quantity."},"orderedQuantity":{"type":"number","description":"Ordered quantity."},"targetQuantity":{"type":"number","description":"Target quantity."},"storageId":{"type":"integer","format":"int64","description":"Line storage identifier."},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Does the line's target storage use storage bins?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Label printing preset."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-stock-StorageBinRef":{"description":"Storage bin.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"displayName":{"type":"string","description":"Display name."},"routePosition":{"type":"integer","format":"int32","description":"Route position."},"color":{"type":"string","description":"Display color."},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /erp/documents/{id}/lines-to-transfer-to-picklist

> List all lines allowed to transfer in customer delivery

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-picklist":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in customer delivery","operationId":"getToPicklistTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of customer order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"Lines transferable into a delivery document, with document numbers.","properties":{"deliveryTransferableLines":{"type":"array","description":"Lines transferable into a delivery document.","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"External document number."},"documentNumber":{"type":"string","description":"Document number."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-document-DeliveryTransferableLine":{"description":"Line transferable into a delivery document.","properties":{"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"position":{"type":"integer","format":"int32","description":"Position number."},"articleNumber":{"type":"string","description":"Article number."},"articleName":{"type":"string","description":"Article name."},"quantity":{"type":"number","description":"Quantity."},"orderedQuantity":{"type":"number","description":"Ordered quantity."},"targetQuantity":{"type":"number","description":"Target quantity."},"storageId":{"type":"integer","format":"int64","description":"Line storage identifier."},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Does the line's target storage use storage bins?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Label printing preset."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-stock-StorageBinRef":{"description":"Storage bin.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"displayName":{"type":"string","description":"Display name."},"routePosition":{"type":"integer","format":"int32","description":"Route position."},"color":{"type":"string","description":"Display color."},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

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

> List all lines allowed to transfer in customer delivery

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-customer-delivery":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in customer delivery","operationId":"getToCustomerDeliveryTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of customer order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"Lines transferable into a delivery document, with document numbers.","properties":{"deliveryTransferableLines":{"type":"array","description":"Lines transferable into a delivery document.","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"External document number."},"documentNumber":{"type":"string","description":"Document number."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-document-DeliveryTransferableLine":{"description":"Line transferable into a delivery document.","properties":{"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"position":{"type":"integer","format":"int32","description":"Position number."},"articleNumber":{"type":"string","description":"Article number."},"articleName":{"type":"string","description":"Article name."},"quantity":{"type":"number","description":"Quantity."},"orderedQuantity":{"type":"number","description":"Ordered quantity."},"targetQuantity":{"type":"number","description":"Target quantity."},"storageId":{"type":"integer","format":"int64","description":"Line storage identifier."},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Does the line's target storage use storage bins?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Label printing preset."},"deliveryDate":{"type":"string","format":"date","description":"Requested delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Requested delivery date until."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery date until."}}},"erp-stock-StorageBinRef":{"description":"Storage bin.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier."},"displayName":{"type":"string","description":"Display name."},"routePosition":{"type":"integer","format":"int32","description":"Route position."},"color":{"type":"string","description":"Display color."},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /erp/documents/{id}/flat

> returns the flat document without

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{id}/flat":{"get":{"tags":["Document"],"summary":"returns the flat document without","operationId":"getFlatDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Document number.","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Account number of the associated organizational unit.","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Customer number.","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Customer number at the supplier.","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Supplier number.","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Sales agent number.","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"External identifier.","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"External document number.","maxLength":255,"minLength":0},"externalPaymentReference":{"type":"string","description":"Payment reference from an external system, e.g. the transaction id of the payment provider.","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Is the document published (printed, sent by email)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Is the document frozen?","readOnly":true},"qualifier":{"type":"string","description":"Document qualifier.","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"Organizational unit identifier."},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Document date."},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"valueDate":{"type":"string","format":"date","description":"Value date."},"taxable":{"type":"boolean","default":true,"description":"Taxable or tax free."},"taxIdentificationNumber":{"type":"string","description":"VAT identification number.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Validation status of the tax identification number.","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validation status for electronic invoices.","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Billing type.","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Document type (internal).","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"Document type identifier.","readOnly":true},"documentTypeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"cancellationReasonRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"currencyCode":{"type":"string","description":"Currency (ISO code, Alpha-3)."},"exchangeRate":{"type":"number","description":"Exchange rate."},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Exchange rate determination origin.","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Total price before discount [gross, net].","readOnly":true},"totalPriceModifier":{"type":"number","description":"Total discount [gross, net].","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Total line discount [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total document discount [gross, net].","readOnly":true},"totalNetPrice":{"type":"number","description":"Total price net.","readOnly":true},"totalVat":{"type":"number","description":"Total VAT.","readOnly":true},"totalGrossPrice":{"type":"number","description":"Total price gross.","readOnly":true},"roundingAmount":{"type":"number","description":"Final amount rounding: difference between the rounded gross amount and (net + VAT).","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Agreed deposit amount."},"depositPaymentDate":{"type":"string","format":"date","description":"Agreed deposit date.","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Expected delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery end (only when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery end (only when the confirmed delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Expected number of parcels (information only)."},"deliveryText":{"type":"string","description":"Additional delivery text.","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Is the document released for delivery?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Is the drop shipping document released for invoicing?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Order date."},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name of the ordering person.","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is the reverse charge procedure under §13b UStG applied?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Is this a collective invoice?"},"texts":{"type":"array","description":"Document texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Document lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Shipping cost lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"POS payment lines.","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Total of the shipping costs (net and gross).","readOnly":true},"priceModifiers":{"type":"array","description":"Price changes (e.g. discounts).","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Document tax summary.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priority in the batch processing."},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximum possible deliveries."},"taxPerformanceLocation":{"type":"string","description":"Place of the taxable performance.","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"mainSupplyType":{"type":"string","description":"Predominant supply of a sales document (goods or services). Empty for all other documents. Only taken over from the request if mainSupplyTypeOrigin is USER_DEFINED, then it is required.","enum":["GOODS","SERVICES"]},"mainSupplyTypeOrigin":{"type":"string","default":"AUTOMATIC","description":"Origin of the main supply type. AUTOMATIC determines it from the document lines, PREDECESSOR takes over the value set by the user in the predecessor of a credit note or cancellation, USER_DEFINED keeps the value set by the user.","enum":["AUTOMATIC","PREDECESSOR","USER_DEFINED"]},"performanceCountryCode":{"type":"string","description":"Country code of the performance country (ISO Alpha-3)."},"sourceCountryCode":{"type":"string","description":"Country code of the country of origin (ISO Alpha-3)."},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"The total weight was set manually."},"tags":{"type":"array","description":"Document tags.","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"locationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Total gross amount eligible for the payment discount.","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 profile for electronic invoices.","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Document import mode.","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Is a payment plan present?"},"calculationMode":{"type":"string","description":"Calculation mode.","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Is this processed by the workflow?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Order number from the predecessor document.","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Language."},"baseCurrencyCode":{"type":"string","description":"Document base currency."},"baseTotalNetPrice":{"type":"number","description":"Total price - net in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - document line total, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - document, in base currency."},"baseTotalGrossPrice":{"type":"number","description":"Total price - gross in base currency."},"baseDepositPaymentAmount":{"type":"number","description":"Prepayment amount in base currency."},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"Invoice amount eligible for the payment discount in base currency."},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"Pass the email to the shipper."},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Pass the phone number to the shipper."},"posReceiptPaymentSum":{"type":"number","description":"Receipt: total payment amount."},"posReceiptBalance":{"type":"number","description":"Receipt: balance.\nA positive value is the amount still to be paid.\nA negative value is the overpaid amount or change.\n"},"posReceiptChangeAmount":{"type":"number","description":"Change."},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Is the receipt balanced, i.e. paid with no change?\nTrue when the receipt is balanced.\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Is the receipt paid?\nTrue when the receipt is paid.\n"},"dropShipping":{"type":"boolean","description":"Drop shipping.","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Document state instance.","properties":{"label":{"type":"string","description":"label/name of this state","minLength":1},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-PaymentTermRef":{"description":"Reference to a PaymentTerm flagged as deposit or prepayment.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}},"erp-document-DocumentShippingCost":{"description":"Shipping costs in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Shipping costs."},"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"texts":{"type":"array","description":"Texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Purchase price."},"discountable":{"type":"boolean","description":"Is this eligible for discount?"},"cashDiscountable":{"type":"boolean","description":"Is this eligible for the payment discount?"}}},"erp-document-DocumentPosPayment":{"description":"POS payment in the document.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Amount."},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend.","readOnly":true},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment).","readOnly":true},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL).","readOnly":true},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal (set by the backend).","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount; in mode MANUAL provided by the user, in modes FULL/BALANCE/NONE calculated by the backend from the current balance."},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register."},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Return delivery address.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Title."},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag types.","enum":["COMMON","ACCOUNT","PRODUCT","ASSET","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Tag label."},"color":{"type":"string","description":"Color for displaying the tag."},"editColor":{"type":"string","description":"Color in the management UI."},"searchColor":{"type":"string","description":"Color in the search UI."},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentPosDetail":{"description":"Receipt details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaction start time."},"timeEnd":{"type":"integer","format":"int64","description":"Transaction end time."},"clientSerialNumber":{"type":"string","description":"Client serial number."},"tssSerialNumber":{"type":"string","description":"TSS serial number."},"transactionNumber":{"type":"integer","format":"int64","description":"Transaction number."},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signature counter."},"signature":{"type":"string","description":"Signature."},"withdrawalFromClosing":{"type":"boolean","default":false,"description":"Was this cash withdrawal created by the cash closing? Such a withdrawal cannot be cancelled on its own.","readOnly":true}}},"erp-pos-TssSignature":{"description":"TSS signature.","properties":{"status":{"type":"string","description":"Signing status.","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"TSS response data.","readOnly":true},"externalReference":{"type":"string","description":"External reference.","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Start date."},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimum degree of fulfillment.","maximum":100,"minimum":0},"note":{"type":"string","description":"Note.","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Additional information about decisions in the document context.","properties":{"calculationModeOrigin":{"type":"string","description":"Calculation mode origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Active rounding mode for this document (frozen from the SalesChannel).","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Electronic invoice profile origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Buyer reference origin.","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Contains the results of previous user decisions on this Document.","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Tax situation origin.","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Language origin.","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameters used in the {@link DocumentContext}.","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Translations.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Targets for the incoming goods per document line.","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Additional parameters.","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Translations.","properties":{"entityName":{"type":"string","description":"For which entity?"},"fieldName":{"type":"string","description":"Field name."},"content":{"type":"string","description":"Translation."}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Targets for the incoming goods.","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Storage bin for the incoming goods."},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pick trolley for the incoming goods."},"lineId":{"type":"integer","format":"int64","description":"Document line identifier."},"sourceLineId":{"type":"integer","format":"int64","description":"Predecessor document line identifier."}}}}}}
```

## GET /erp/documents/{documentId}/parcels/unassigned-bookings

> Return all document line bookings of a document that are not assigned to a parcel

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/parcels/unassigned-bookings":{"get":{"tags":["Document"],"summary":"Return all document line bookings of a document that are not assigned to a parcel","operationId":"getUnassignedDocumentLinesWithBookings","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLineWithBooking"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLineWithBooking":{"properties":{"line":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"component":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"},"booking":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"},"quantity":{"type":"number","description":"Combination quantity."}}},"erp-document-DocumentLine":{"description":"Document lines.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position number.","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Position number across all article lines.","readOnly":true},"articleId":{"type":"string","description":"Article."},"lineType":{"type":"string","description":"Line type.","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT","VOUCHER_SALE","VOUCHER_REDEMPTION"]},"productType":{"type":"string","description":"Article types.","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Article number.","maxLength":255,"minLength":0},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Price per quantity [gross, net]."},"priceUnit":{"type":"number","description":"Price unit."},"priceOrigin":{"type":"string","description":"Price origin.","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Quantity."},"quantityCommitted":{"type":"number","description":"Processed quantity.","readOnly":true},"pickingQuantity":{"type":"number","description":"Quantity in the picking process.","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"Pre-ordered quantity in the picking process.","readOnly":true},"complete":{"type":"boolean","default":false,"description":"Is this line completely processed?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Taxes.","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Total of the line price changes [gross, net].","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Total of the document price changes [gross, net].","readOnly":true},"priceModifiers":{"type":"array","description":"Applied price changes.","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Net total price (after the price changes).","readOnly":true},"vat":{"type":"number","description":"Tax amount.","readOnly":true},"totalLinePrice":{"type":"number","description":"Line total [gross, net], i.e. price * quantity less the line discounts.","readOnly":true},"texts":{"type":"array","description":"Line texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Customs tariff number.","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Delivery date."},"deliveryDateEnd":{"type":"string","format":"date","description":"Expected delivery period end (only required for delivery periods when the delivery date is set)."},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Confirmed delivery date."},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Confirmed delivery period end (only required for delivery periods when the delivery date is set)."},"shippingDate":{"type":"string","format":"date","description":"Shipping date."},"deliveryText":{"type":"string","description":"Delivery text.","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Shipper-specific information."},"externalReferenceVds":{"type":"string","description":"External reference to the VDS parcel.","maxLength":255,"minLength":0},"externalArticleNumber":{"type":"string","description":"External article number.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleName":{"type":"string","description":"External article name.","maxLength":255,"minLength":0,"readOnly":true},"externalArticleDescription":{"type":"string","description":"External article description.","maxLength":255,"minLength":0,"readOnly":true},"netWeight":{"type":"number","description":"Net weight."},"totalNetWeight":{"type":"number","description":"Total net weight."},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Gross weight."},"totalGrossWeight":{"type":"number","description":"Total gross weight."},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Unit of measure content."},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Base unit content."},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Reference to the base line."},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"voucherCode":{"type":"string","description":"Scanned code of the preprinted voucher card (VOUCHER_SALE of a voucher type with scanned codes only)"},"settledOpenItemBalance":{"type":"number","description":"Open remaining amount of the open item to settle (only in the response)."},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Due date of the open item to settle (only in the response)."},"settledOpenItemDiscountAmount":{"type":"number","description":"Payment discount of the open item to settle that is applicable at the document date (only in the response)."},"settledOpenItemComment":{"type":"string","description":"Note on the open item line - transferred into the open item comment on closing."},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Reference to the supplier order line.","items":{"type":"integer","format":"int64","description":"Reference to the supplier order line."}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Bookings.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Commissions.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"§13b UStG preset of the article.","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Is §13b UStG applied?","readOnly":true},"presetPrice":{"type":"number","description":"Preset value for the price calculation.","readOnly":true},"calculationData":{"type":"string","description":"Calculation structure."},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Commission origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"Is this line eligible for the payment discount?"},"discountable":{"type":"boolean","default":true,"description":"Is this line eligible for discount?"},"commissionable":{"type":"boolean","default":false,"description":"Is this line eligible for commission?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Warranty in months."},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Product variant values.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Performance date."},"basePrice":{"type":"number","description":"Price per unit in base currency."},"baseTotalLinePriceModifier":{"type":"number","description":"Price adjustments - line, in base currency."},"baseTotalDocumentPriceModifier":{"type":"number","description":"Price adjustments - proportionally from the document, in base currency."},"baseTotalLinePrice":{"type":"number","description":"Total line price in base currency."},"baseSalesValueNet":{"type":"number","description":"Line net sales value in base currency."},"progressInvoice":{"type":"boolean","default":false,"description":"Is this a progress invoice line?"},"dropShippingPolicy":{"type":"string","description":"Defines whether and how an article may be sold by drop shipping.","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Accessory insert term.","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Does the article have accessories?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Should the DocumentLine be recalculated from the components?"},"doPrintLabel":{"type":"boolean","default":false,"description":"Should labels be printed for this line?"},"storageInfo":{"type":"string","description":"picking hint","maxLength":2147483647,"minLength":0}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Price determination criteria.","properties":{"qualifier":{"type":"string","description":"Qualifier.","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Article identifiers.","items":{"type":"integer","format":"int64","description":"Article identifiers."}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"Should only the default price be selected?"},"accountIds":{"type":"array","description":"Account identifiers.","items":{"type":"integer","format":"int64","description":"Account identifiers."}},"productGroupId":{"type":"integer","format":"int64","description":"Product group."},"priceGroupId":{"type":"integer","format":"int64","description":"Price group."},"date":{"type":"string","format":"date","description":"Date."},"quantity":{"type":"number","description":"Quantity."},"noteSpecialOfferPrice":{"type":"boolean","description":"Consider the special offer price?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Document tax summary.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Tax type.","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Is this tax free?"},"baseTaxableAmount":{"type":"number","description":"Taxable amount in base currency."},"baseTaxValue":{"type":"number","description":"Tax amount in base currency."},"baseGrossAmount":{"type":"number","description":"Gross amount in base currency."}}},"erp-document-DocumentPriceModifier":{"description":"Price changes (e.g. discounts).","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value","minimum":0},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP","PREDECESSOR_DOCUMENT"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Modifier value in base currency.","minimum":0},"baseCalculatedValue":{"type":"number","description":"Calculated modifier value in base currency."}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texts.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Removed and should therefore no longer be shown."},"initialized":{"type":"boolean","description":"Is the content filled?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Shipping cost details; only set for shipping cost lines that are kept as a numbered document line (e.g. in a collective invoice).","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Were the shipping costs entered manually?"},"freeShipping":{"type":"boolean","default":false,"description":"No shipping costs (free shipping)."},"purchasePrice":{"type":"number","description":"Purchase price in base currency."}}},"common-masterdata-CountryReference":{"description":"Country of origin.","properties":{"id":{"type":"integer","format":"int64","description":"Country identifier."},"isoAlpha2":{"type":"string","description":"Country ISO Alpha-2 code."},"isoAlpha3":{"type":"string","description":"Country ISO Alpha-3 code."},"label":{"type":"string","description":"Country label.","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Reference to a DocumentLine.","properties":{"id":{"type":"integer","format":"int64","description":"Document line identifier."},"documentId":{"type":"integer","format":"int64","description":"Document identifier."},"category":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Document type."},"documentState":{"type":"string","description":"Document state."},"number":{"type":"string","description":"Document number."},"articleNumber":{"type":"string","description":"Article number."},"position":{"type":"integer","format":"int32","description":"Position number."},"name":{"type":"string","description":"Article name.","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Customer short label."}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Components.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Reference to the component article."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Quantity."},"price":{"type":"number","description":"Unit price."},"quantityCommitted":{"type":"number","description":"Delivered quantity."},"pickingQuantity":{"type":"number","description":"Quantity in picking."},"quantityPerAssemblyGroup":{"type":"number","description":"Quantity per assembly."},"name":{"type":"string","description":"Article name.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Article description.","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Component position in the assembly."},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Reference to the component in the source Document."},"bookings":{"type":"array","description":"Bookings for this component.","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Component texts.","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Bookings.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Booked quantity."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"note":{"type":"string","description":"Note."},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"},"batchSelectedAutomatically":{"type":"boolean","description":"Was the batch selected automatically at the POS by the earliest best before date?","readOnly":true}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Component fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Use for the serial number inheritance."},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"All articles belonging to this product.","properties":{"id":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Label."},"description":{"type":"string","description":"Description."},"serialType":{"type":"string","description":"Article serial type.","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document line component of a fabrication article in customer offers and customer orders.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position."},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Quantity."},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Deviating production costs."},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis for inheriting the serial number."},"name":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description.","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Commissions.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Description."},"comment":{"type":"string","description":"Comment."},"valueType":{"type":"string","description":"Value type.","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission percentage or value."},"origin":{"type":"string","description":"Origin.","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Gross profit determination.","properties":{"productPurchasePrice":{"type":"number","description":"Purchase price.","readOnly":true},"salesValue":{"type":"number","description":"Net revenue.","readOnly":true},"revenue":{"type":"number","description":"Contribution margin (absolute).","readOnly":true},"revenueInPercent":{"type":"number","description":"Contribution margin (percent).","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Contract details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Contract start (header only)."},"endDate":{"type":"string","format":"date","description":"Contract end (header only)."},"runtimeFromDate":{"type":"string","format":"date","description":"Term from."},"runtimeToDate":{"type":"string","format":"date","description":"Term until."},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the customer."},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Latest possible termination date for the provider."},"dueDateCalculation":{"type":"string","description":"Cron expression for calculating the due date.","minLength":1},"dueDate":{"type":"string","format":"date","description":"Due date."},"nextDueDate":{"type":"string","format":"date","description":"Next due date."},"calculateDirectly":{"type":"boolean","description":"Bill immediately?"},"active":{"type":"boolean","default":true,"description":"Is the contract active?"},"publishInPortal":{"type":"boolean","default":false,"description":"Show in the portal?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"POS information.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Line type.","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","VOUCHER_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Deposit or expense type."},"paymentMethodId":{"type":"integer","format":"int64","description":"Payment method."},"externalPaymentId":{"type":"string","description":"External payment identifier for the connection to the payment backend."},"externalPaymentStatus":{"type":"string","description":"External payment status.","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Error message from the payment backend (only for a failed payment)."},"paymentOperation":{"type":"string","description":"Payment operation type (PAYMENT, CANCEL, REFUND).","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"External payment identifier of the payment to cancel (only for CANCEL)."},"withdrawalMode":{"type":"string","description":"Mode for the withdrawal of a POS payment method at the cash closing.","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Payment method balance before the withdrawal.","readOnly":true},"withdrawalAmount":{"type":"number","description":"Withdrawal amount (mode MANUAL).","readOnly":true},"withdrawToBalance":{"type":"number","description":"Withdrawal to amount (mode BALANCE) — remaining amount that stays in the POS register.","readOnly":true},"deletable":{"type":"boolean","default":false,"description":"Can this payment line be removed from the document? False while the payment is still running or has already been executed successfully.","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Line fabrication details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produced serial numbers.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Quantity produced."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produced line serial numbers.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produced or planned quantity."},"quantityCommitted":{"type":"number","description":"Actually produced quantity."},"quantityInQA":{"type":"number","description":"Quantity in quality assurance."},"quantityDefective":{"type":"number","description":"Quantity defective."},"quantityFinished":{"type":"number","description":"Quantity completed."},"bookedComponents":{"type":"array","description":"Booked components.","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Serial number.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Serial number 1.","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Serial number 2.","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Expiry date."},"ignoreExpiryDateOnStockBooking":{"type":"boolean","description":"Ignore expiry date on stock booking","readOnly":true},"note":{"type":"string","description":"Note."},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Booked components of a produced serial number.","properties":{"articleId":{"type":"integer","format":"int64","description":"Article identifier."},"number":{"type":"string","description":"Article number."},"name":{"type":"string","description":"Article name."},"description":{"type":"string","description":"Article description."},"quantity":{"type":"number","description":"Quantity used."},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Document line return details.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Return category.","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Wait for the return before the goods replacement (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"repairRequested":{"type":"boolean","description":"Is a repair requested (only for GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)?"},"warrantyExchange":{"type":"boolean","description":"Is this a warranty exchange (only for *_ITEM_GETS_SEND_BACK)?"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Customer share of a surcharge in percent (0-100). How much % of the surcharge does the customer pay?"},"customerShareOnReduction":{"type":"number","description":"Customer share of a price reduction in percent (0-100). How much % of the saving is credited to the customer?"}}},"erp-document-DocumentFinanceBooking":{"description":"Finance booking.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Document line identifier."},"ledgerNumber":{"type":"string","description":"Finance account number."},"transactionKey":{"type":"string","description":"Transaction key."},"costCenter1":{"type":"string","description":"Cost center."},"comment":{"type":"string","description":"Comment."},"description":{"type":"string","description":"Booking text."}}}}}}
```

## GET /erp/documents/{documentId}/availability

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/{documentId}/availability":{"get":{"tags":["Document"],"operationId":"getOrderLineAvailabilityInfo","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-CompleteDocumentAvailabilityInfoApi"}}}}}}}},"components":{"schemas":{"erp-document-CompleteDocumentAvailabilityInfoApi":{"description":"Availability information of a document and its lines.","properties":{"documentAvailabilityInfo":{"$ref":"#/components/schemas/erp-document-DocumentAvailabilityInfoApi"},"lineAvailabilityInfos":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-document-DocumentLineAvailabilityInfoApi"},"description":"Availability information of the individual lines."}}},"erp-document-DocumentAvailabilityInfoApi":{"description":"Document availability information.","properties":{"orderAvailability":{"type":"string","description":"Order availability.","enum":["FULL_DELIVERABLE","NOTHING_DELIVERABLE","AT_LEAST_ONE_LINE_IS_FULL_DELIVERABLE","AT_LEAST_ONE_LINE_IS_PARTIALLY_DELIVERABLE"]},"orderStackProcessingType":{"type":"string","description":"Batch processing information for orders.","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"maxPossibleDeliveries":{"type":"integer","format":"int32","description":"Maximum number of deliveries."}}},"erp-document-DocumentLineAvailabilityInfoApi":{"description":"Line availability information.","properties":{"orderLineAvailability":{"type":"string","description":"Order line availability.","enum":["FULL_DELIVERABLE","NOTHING_DELIVERABLE","PARTIALLY_DELIVERABLE","LINE_ALREADY_DELIVERED"]},"availableQuantity":{"type":"number","description":"Required available quantity."},"maxAvailableQuantity":{"type":"number","description":"Maximum available quantity."},"orderedQuantity":{"type":"number","description":"Ordered quantity."}}}}}}
```

## GET /erp/documents/types

> return all available document-state-machine starting states&#x20;

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"api.example.com"}],"paths":{"/erp/documents/types":{"get":{"tags":["Document"],"summary":"return all available document-state-machine starting states ","operationId":"getDocumentTypesForCreate","parameters":[{"name":"qualifiers","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"]},"uniqueItems":true}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"Same as the transition identifier, for the UI."},"transitionId":{"type":"string","description":"Transition identifier."},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Document categories.","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_DEPOSIT_CANCELLATION","POS_CASH_JOURNAL_EXPENSE_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL_CANCELLATION","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"Target document type identifier.","readOnly":true},"typeKey":{"type":"string","description":"Target document type key.","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"The document type is the default for the category.","readOnly":true},"targetState":{"type":"string","description":"Transition target state.","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sort order.","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.vario-software.de/api-reference/document.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
