> ## Documentation Index > Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieves a single sales order by its ID. > Retrieves a single sales order by its ID. ## OpenAPI ````yaml /openapi/2.0.json get /v2/sales-orders/{salesOrderId} openapi: 3.0.0 info: title: JTL-WAWI API (Cloud) description: "JTL-Wawi-Version: 2.1.0\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system." contact: name: JTL-Software-GmbH url: https://developer.jtl-software.com/ email: partner@jtl-software.com version: '2.0' x-application-version: 2.1.0.0 servers: - url: https://api.jtl-cloud.com/erp description: Production Environment Cloud API Gateway security: [] tags: - name: Worker description: >-

Returns the Available Syncs of the Worker - name: WMS description: >-

Query all pick lists for a specific wms warehouse that are not completed. - name: Wawi App description: >-

Get a specific customer - name: Warehouses description: >-

Queries all storage locations for a given warehouse. - name: Units description: Development - name: Transaction Status description: >-

Queries all transaction statuses for a sales order. - name: Tax description: >-

Returns the tax rate for the given item. - name: Inventory description: >-

Queries stocks for a specific item, warehouse or storage location. - name: Sales Order description: Planned - name: Sales Invoice Correction description: Planned - name: Sales Channel description: >-

Gets all sales channels. - name: Return description: >-

Create a new return with associated items and packages. - name: Item description: >-

Queries all responsible persons. - name: Refund description: Planned - name: Property description: >-

Queries all properties of items. - name: Printer description: >-

Retrieves all installed printers. - name: Master Data description: >-

Queries all on hold reasons for sales orders. - name: Manufacturer description: Development - name: Label description: Development - name: Sales Invoice description: Planned - name: Info description: >-

Returns the status of the API. - name: Features description: >-

Returns the available feature sets with release state and API version. - name: Extensibility description: Planned - name: Shipment description: Development - name: Delivery Note description: Planned - name: Custom Field description: Development - name: Customer description: >-

Deletes a specific customer. - name: Authentication description: >-

Send a registration request for an (external) application - name: Attribute description: Development - name: Sales Quotation description: >-

Execute the printing of a sales quotation - name: Production - name: Resources - name: Company - name: Marketplace Order - name: Marketplace Offer - name: Marketplace Invoicing - name: Warehouse Assistant paths: /v2/sales-orders/{salesOrderId}: get: tags: - Sales Order summary: Retrieves a single sales order by its ID. description: Retrieves a single sales order by its ID. operationId: SalesOrderDomain_GetSalesOrderById parameters: - name: salesOrderId in: path required: true schema: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey' example: b45f6432-2462-4c6f-b00f-1d9d01000000 x-position: 1 - name: x-companyid in: header description: >- The Company-Id (int or uuid) of the company on whose behalf the request is executed. schema: type: string - name: x-tenant-id in: header required: true schema: type: string format: uuid description: The tenant ID for the target ERP instance. responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrder '400': description: '' content: application/json: {} '401': description: '' content: application/json: {} '403': description: '' content: application/json: {} '404': description: '' content: application/json: {} '500': description: '' content: application/json: {} security: - oauth2-authorization-code: - salesorders.read - oauth2-client-credentials: - salesorders.read components: schemas: JTL.Data.Contracts.Keys.VerkaufAuftragKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrder: type: object description: A single sales order. additionalProperties: false required: - id - isCancelled - isPending - itemDescriptionType - readOnlyType - salesOrderStatus - salesOrderNumber - departureCountry - externalDetails - paymentDetails - shippingDetails - taxDetails properties: id: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey' description: Unique ID to identify a sales order. customerId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey' description: Customer this SalesOrder belongs to. paymentInfo: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderPaymentInfo description: SalesOrderPaymentInfo text: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderText description: SalesOrderText salesOrderDate: type: string description: The SalesOrder Date format: date-time isCancelled: type: boolean description: Indicates if the order has been cancelled. isPending: type: boolean description: The SalesOrder IsPending itemDescriptionType: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ItemDescriptionType description: The SalesOrder ItemDescriptionType readOnlyType: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ReadOnlyType description: The SalesOrder ReadOnlyType salesOrderStatus: type: integer description: The SalesOrder SalesOrderStatus format: int32 salesOrderNumber: type: string description: The SalesOrder SalesOrderNumber departureCountry: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderDepartureCountry description: DepartureCountry externalDetails: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderExternalDetails description: ExternalDetails paymentDetails: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderPaymentDetails description: PaymentDetails shippingDetails: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderShippingDetails description: ShippingDetails taxDetails: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderTaxDetails description: TaxDetails processColourId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FarbeKey' description: The SalesOrder Process colour id onHoldReasonId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.RueckhaltegrundKey' description: The SalesOrder OnHold reason id cartonItemId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' description: The SalesOrder Carton item id paymentMethodId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZahlungsartKey' description: The SalesOrder Payment method id shippingMethodId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandartKey' description: The SalesOrder Shipping method id processStatusId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VorgangsstatusKey' description: The SalesOrder Process status id languageIso: type: string description: The SalesOrder Language iso code customerSalesOrderNumber: type: string description: The SalesOrder Customer sales order number vatId: type: string description: The SalesOrder Vat Id companyId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey' description: The SalesOrder Company Id shipmentAddress: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderAddress description: SalesOrderShipmentAddress billingAddress: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderAddress description: SalesOrderBillingAddress lineItems: type: array description: List of SalesOrderLineItem items: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderLineItem keyFigures: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderKeyFigures description: Key figures of the sales order. JTL.Data.Contracts.Keys.KundeKey: type: string description: Represents a unique key for identifying a customer in the JTL system. format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderPaymentInfo: type: object description: Payment information and bank details for a sales order additionalProperties: false required: - paymentInfoType properties: accountHolder: type: string description: The SalesOrderPaymentInfo AccountHolder bankName: type: string description: The SalesOrderPaymentInfo BankName bIC: type: string description: The SalesOrderPaymentInfo BIC creditorId: type: string description: The SalesOrderPaymentInfo CreditorId dueDate: type: string description: The SalesOrderPaymentInfo DueDate format: date-time endToEndId: type: string description: The SalesOrderPaymentInfo EndToEndId iBAN: type: string description: The SalesOrderPaymentInfo IBAN mandateReference: type: string description: The SalesOrderPaymentInfo MandateReference paymentInfo: type: string description: The SalesOrderPaymentInfo PaymentInfo paymentInfoType: type: integer description: The SalesOrderPaymentInfo PaymentInfoType format: int32 paymentReference: type: string description: The SalesOrderPaymentInfo PaymentReference referenceEmail: type: string description: The SalesOrderPaymentInfo ReferenceEmail JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderText: type: object description: Text and comment information for a sales order additionalProperties: false properties: comment: type: string description: The SalesOrderText Comment customerComment: type: string description: The SalesOrderText CustomerComment printText: type: string description: The SalesOrderText PrintText processStatus: type: string description: The SalesOrderText ProcessStatus JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ItemDescriptionType: type: integer description: 0 = None, 1 = Brief, 2 = Long format: int32 x-enumNames: - None - Brief - Long enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ReadOnlyType: type: integer description: 0 = ChangesAllowed, 1 = InvoicedExternally, 2 = ChangesForbidden format: int32 x-enumNames: - ChangesAllowed - InvoicedExternally - ChangesForbidden enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderDepartureCountry: type: object description: Departure country information for a sales order additionalProperties: false required: - currencyFactor properties: countryIso: type: string description: The SalesOrder CountryISO currencyIso: type: string description: The SalesOrder DepartureCountry CurrencyISO currencyFactor: type: number description: The SalesOrder DepartureCountry CurrencyFactor format: decimal state: type: string description: The SalesOrder State JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderExternalDetails: type: object description: External details for a sales order additionalProperties: false required: - externalInvoiceType properties: externalCreatedDate: type: string description: The SalesOrder ExternalCreatedDate format: date-time externalInvoiceType: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ExternalSalesInvoiceType description: The SalesOrder ExternalInvoiceType externalSalesOrderNumber: type: string description: The SalesOrder ExternalSalesOrderNumber JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderPaymentDetails: type: object description: Payment details for a sales order additionalProperties: false required: - cashDiscount - cashDiscountDays - financingCosts - paymentDueDateInDays - currencyFactor properties: cashDiscount: type: number description: The SalesOrder CashDiscount format: decimal cashDiscountDays: type: integer description: The SalesOrder CashDiscountDays format: int32 financingCosts: type: number description: The SalesOrder FinancingCosts format: decimal paymentDueDateInDays: type: integer description: The SalesOrder PaymentDueDateInDays format: int32 currencyIso: type: string description: The currency ISO code currencyFactor: type: number description: The currency factor format: decimal JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderShippingDetails: type: object description: Shipping details for a sales order additionalProperties: false required: - extraWeight - maxDeliveryDays - shippingPriority properties: deliveryFromDate: type: string description: The SalesOrder DeliveryFromDate format: date-time estimatedDeliveryDate: type: string description: The SalesOrder EstimatedDeliveryDate format: date-time extraWeight: type: number description: The SalesOrder ExtraWeight format: decimal maxDeliveryDays: type: integer description: The SalesOrder MaxDeliveryDays format: int32 shippingDate: type: string description: The SalesOrder ShippingDate format: date-time shippingPriority: type: integer description: The SalesOrder ShippingPriority format: int32 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderTaxDetails: type: object description: Tax details for a sales order additionalProperties: false required: - taxReference - specialTaxTreatment - taxSetting properties: taxReference: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference description: >- The SalesOrder TaxReference. This setting controls which data is used during tax calculation. specialTaxTreatment: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment description: The SalesOrder SpecialTaxTreatment taxSetting: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxSetting description: The SalesOrder TaxSetting JTL.Data.Contracts.Keys.FarbeKey: type: string description: Represents a key for identifying a color entity in the system. format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.RueckhaltegrundKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.ArtikelKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.ZahlungsartKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.VersandartKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.VorgangsstatusKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.FirmaKey: type: string description: Represents a key for identifying a firm within the application. format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderAddress: type: object description: Address information for a sales order additionalProperties: false required: - salesOrderId - type properties: salesOrderId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey' description: The SalesOrder this address belongs to type: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.AddressType description: The purpose of this address customerId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundeKey' description: The customer this address belongs to salutation: type: string description: The SalesOrderAddress Salutation title: type: string description: The SalesOrderAddress Title firstName: type: string description: The SalesOrderAddress FirstName lastName: type: string description: The SalesOrderAddress LastName company: type: string description: The SalesOrderAddress Company additionalCompanyLine: type: string description: The SalesOrderAddress AdditionalCompanyLine street: type: string description: The SalesOrderAddress Street additionalAddressLine: type: string description: The SalesOrderAddress AdditionalAddressLine city: type: string description: The SalesOrderAddress City postalCode: type: string description: The SalesOrderAddress PostalCode state: type: string description: The SalesOrderAddress State countryIso: type: string description: The SalesOrderAddress CountryISO postId: type: string description: The SalesOrderAddress PostId emailAddress: type: string description: The SalesOrderAddress EmailAddress phoneNumber: type: string description: The SalesOrderAddress PhoneNumber mobilePhoneNumber: type: string description: The SalesOrderAddress MobilePhoneNumber fax: type: string description: The SalesOrderAddress Fax country: type: string description: The SalesOrderAddress Countryname customsDocumentsRequired: type: boolean description: Information about the need for additional documents vatId: type: string description: The SalesOrderAddress VAT ID JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderLineItem: type: object description: A single line item of a sales order additionalProperties: false required: - id - salesOrderId - isReserved - type - quantity - salesPriceNet - discountPercent - purchasePriceNet - taxRate - totalSalesPriceNet - totalSalesPriceGross - sortOrder - hasUpload - configurationItemType - billOfMaterialsType properties: id: $ref: >- #/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey description: Id of this position salesOrderId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey' description: Id of the SalesOrder this position belongs to itemId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' description: Unique ID to identify an item. sku: type: string description: Sku isReserved: type: boolean description: Reserved status of that position name: type: string description: Name of the position. fnSku: type: string description: The SalesOrderLineItem FNSKU type: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType description: Type of the sales order line item. quantity: type: number description: The quantity of the line item. format: decimal salesUnit: type: string description: The sales unit of the line item. salesPriceNet: type: number description: The net sales price of the item. format: decimal discountPercent: type: number description: The discount of the line item. format: decimal purchasePriceNet: type: number description: The purchase price of the item. format: decimal taxRate: type: number description: The tax rate of the line item. format: decimal taxClassId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey' description: The SalesOrderLineItem TaxClassId taxCodeId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.SteuerschluesselKey' description: The SalesOrderLineItem TaxCodeId note: type: string description: The SalesOrderLineItem Note totalSalesPriceNet: type: number description: Total price net. format: decimal totalSalesPriceGross: type: number description: Total price gross. format: decimal sortOrder: type: integer description: Sort order. format: int32 standardName: type: string description: The default name. hasUpload: type: boolean description: Information about an uploaded file. parentSalesOrderLineItemId: $ref: >- #/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey description: Id of the parent line item if this is a child line item. configurationItemType: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ConfigurationItemType description: Configuration item type. billOfMaterialsType: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.BillOfMaterialsType description: Bill of materials type. JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.SalesOrderDomain.SalesOrderKeyFigures: type: object description: Provides key figures and status information for a sales order. additionalProperties: false required: - salesOrderId - alreadyPaidAmount - creditsTotalGrossAmount - deliveryStatus - invoiceStatus - invoicesTotalGrossAmount - invoicesTotalNetAmount - isCashOnDelivery - isFullyReturned - isLockedForDelivery - packageCount - paymentStatus - shippedPackageCount - stillToPay - stillToPayWithoutCancellation - totalGrossAmount - totalNetAmount properties: salesOrderId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VerkaufAuftragKey' description: The unique identifier for the sales order. alreadyPaidAmount: type: number description: The total amount already paid by the customer. format: decimal creditsTotalGrossAmount: type: number description: The total gross amount of all related credit notes. format: decimal dateOfPayment: type: string description: The date and time when the payment was received. format: date-time deliveryStatus: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.DeliveryStatus description: The current delivery status of the sales order. emailedDate: type: string description: The date and time when the order was sent via email. format: date-time invoiceNumbers: type: string description: A comma-separated string of associated invoice numbers. invoiceStatus: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.InvoiceStatus description: The overall status of the associated invoices. invoicesTotalGrossAmount: type: number description: The total gross amount of all associated invoices. format: decimal invoicesTotalNetAmount: type: number description: The total net amount of all associated invoices. format: decimal isCashOnDelivery: type: boolean description: Whether the order is handled via cash on delivery. isFullyReturned: type: boolean description: Whether all items in the order have been returned. isLockedForDelivery: type: boolean description: Whether the order is currently blocked for shipping. lastShippingDate: type: string description: The date and time of the last shipping activity. format: date-time packageCount: type: integer description: The total number of packages associated with this order. format: int32 paymentMailDate: type: string description: The date and time when the payment confirmation email was sent. format: date-time paymentStatus: $ref: >- #/components/schemas/JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.InvoicePaymentStatus description: The current payment status of the sales order. printedDate: type: string description: The date and time when the order documents were printed. format: date-time shippedPackageCount: type: integer description: The number of packages that have already been shipped. format: int32 shippingMailDate: type: string description: The date and time when the shipping notification email was sent. format: date-time stillToPay: type: number description: The remaining amount to be paid for this order. format: decimal stillToPayWithoutCancellation: type: number description: The remaining amount to be paid, excluding any cancelled items. format: decimal totalGrossAmount: type: number description: The total gross amount of the sales order. format: decimal totalNetAmount: type: number description: The total net amount of the sales order. format: decimal JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ExternalSalesInvoiceType: type: integer description: 0 = None, 1 = NoInvoiceNoOutput, 2 = NoInvoice format: int32 x-enumNames: - None - NoInvoiceNoOutput - NoInvoice enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxReference: type: integer description: 0 = ShipmentAddress, 1 = BillingAddress format: int32 x-enumNames: - ShipmentAddress - BillingAddress enum: - 0 - 1 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.SpecialTaxTreatment: type: integer description: 0 = None, 1 = ReverseCharge, 2 = ExemptFromVat, 3 = SubjectToVat format: int32 x-enumNames: - None - ReverseCharge - ExemptFromVat - SubjectToVat enum: - 0 - 1 - 2 - 3 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.TaxSetting: type: integer description: >- 0 = DeliveryWithVat, 10 = IntraCommunityDelivery, 15 = ExemptFromVatReverseCharge, 20 = ExemptFromVat format: int32 x-enumNames: - DeliveryWithVat - IntraCommunityDelivery - ExemptFromVatReverseCharge - ExemptFromVat enum: - 0 - 10 - 15 - 20 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.AddressType: type: integer description: 0 = ShipmentAddress, 1 = BillingAddress, 2 = Other format: int32 x-enumNames: - ShipmentAddress - BillingAddress - Other enum: - 0 - 1 - 2 JTL.Data.Contracts.Keys.VerkaufAuftragPositionKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.LineItemType: type: integer description: >- 0 = Custom, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = Packing, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption format: int32 x-enumNames: - Custom - Item - Shipping - Coupon - Voucher - Payment - ShippingSurcharge - NewCustomerCoupon - CashOnDelivery - ShippingSurchargeItem - Packing - GiftForFree - TrustedShops - InterestPremium - ProcessingFee - Carton - ReturnDelivery - MultiPurposeVoucher - MultiPurposeVoucherDigital - SinglePurposeVoucher - SinglePurposeVoucherDigital - SinglePurposeVoucherRedemption enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 JTL.Data.Contracts.Keys.SteuerklasseKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.SteuerschluesselKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.ConfigurationItemType: type: integer description: 0 = None, 1 = ConfigurationItem, 2 = Component format: int32 x-enumNames: - None - ConfigurationItem - Component enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.BillOfMaterialsType: type: integer description: 0 = None, 1 = BillOfMaterials, 2 = Component format: int32 x-enumNames: - None - BillOfMaterials - Component enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.DeliveryStatus: type: integer description: >- 0 = Cancelled, 1 = Open, 2 = PartiallyOnDeliveryNote, 3 = CompletelyOnDeliveryNote, 4 = PartiallyShipped, 5 = CompletelyShipped, 6 = Credited, 7 = CompletedWithoutShipment format: int32 x-enumNames: - Cancelled - Open - PartiallyOnDeliveryNote - CompletelyOnDeliveryNote - PartiallyShipped - CompletelyShipped - Credited - CompletedWithoutShipment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.InvoiceStatus: type: integer description: 0 = NotInvoiced, 1 = PartiallyInvoiced, 2 = CompletelyInvoiced format: int32 x-enumNames: - NotInvoiced - PartiallyInvoiced - CompletelyInvoiced enum: - 0 - 1 - 2 JTL.Wawi.Verkaufsverwaltung.PublicApi.DataTransferObjects.V2.Shared.InvoicePaymentStatus: type: integer description: 0 = Unpaid, 1 = PartiallyPaid, 2 = CompletelyPaid, 3 = NotDeterminable format: int32 x-enumNames: - Unpaid - PartiallyPaid - CompletelyPaid - NotDeterminable enum: - 0 - 1 - 2 - 3 securitySchemes: oauth2-authorization-code: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth tokenUrl: https://auth.jtl-cloud.com/oauth2/token scopes: items.read: Grants permission to read item data. items.write: Grants permission to create and modify item data. all.read: Allows the application to read all data. authentication.updateforeignapp: Grants permission to update registered third-party apps. customers.read: Grants permission to read customer data. customers.write: Grants permission to create and modify customer data. customfields.read: Grants permission to read custom fields. customfields.write: Grants permission to create and modify custom fields. deliveries.read: Grants permission to read deliveries. deliveries.write: Grants permission to create and modify deliveries. deliverynotes.print: Grants permission to print and output delivery notes. deliverynotes.read: Grants permission to read delivery notes. deliverynotes.write: Grants permission to create and modify delivery notes. extensibility.integration: >- Grants permission to manage extensions and integrations of the JTL-Wawi. foreignapps.manage: >- Grants permission to manage registered third-party apps (registration, update and removal). inventories.read: Grants permission to read stock levels. inventories.write: Grants permission to modify stock levels. invoices.read: Grants permission to read invoices. invoices.write: Grants permission to create and modify invoices. labels.read: Grants permission to read labels. labels.write: Grants permission to create and modify labels. masterdata.read: >- Read master data such as shipping methods, payment methods, color codes and tax classes. orders.read: Grants permission to read orders. picklists.read: Grants permission to read pick lists. picklists.write: Grants permission to create and modify pick lists. returns.read: Grants permission to read returns. returns.write: Grants permission to create and modify returns. saleschannels.read: Grants permission to read sales channels. salesinvoicecorrections.read: Grants permission to read invoice corrections. salesinvoicecorrections.write: Grants permission to create and modify invoice corrections. salesorders.print: Grants permission to print and output sales orders. salesorders.read: Grants permission to read sales orders. salesorders.write: Grants permission to create and modify sales orders. system.config.read: Grants permission to read the system configuration. system.config.write: Grants permission to modify the system configuration. system.worker.read: >- Grants permission to read the configuration and status of background workers. system.worker.write: Grants permission to configure and control background workers. taxes.read: Grants permission to read tax data. warehouse.read: Grants permission to read warehouse data. wawiapp.all: Grants access to Wawi app related operations. currencies.read: Grants read access to currencies. jera.read: Grants read access to JERA internal endpoints. paymentmethods.read: Grants read access to payment methods. salesinvoicecorrections.print: Grants permission to print and output invoice corrections. salesinvoices.print: Grants permission to print and output sales invoices. salesinvoices.read: Grants read access to sales invoices. salesinvoices.write: Grants write access to sales invoices. salesquotations.print: Grants permission to print and output sales quotations. salesquotations.read: Grants read access to sales quotations. salesquotations.write: Grants write access to sales quotations. suppliers.read: Grants permission to read suppliers. resources.read: Grants permission to read resource management data. resources.write: Grants permission to create and modify resource management data. pps.read: Grants permission to read production data. pps.write: Grants permission to create and modify production data. masterdata.write: Write master data inventory.read: Grants permission to read stock levels. inventory.write: Grants permission to modify stock levels. taxes.write: Grants permission to create and modify tax data. application.runas: >- Allows the application to execute requests on behalf of another user. oauth2-client-credentials: type: oauth2 flows: clientCredentials: tokenUrl: https://auth.jtl-cloud.com/oauth2/token scopes: items.read: Grants permission to read item data. items.write: Grants permission to create and modify item data. all.read: Allows the application to read all data. authentication.updateforeignapp: Grants permission to update registered third-party apps. customers.read: Grants permission to read customer data. customers.write: Grants permission to create and modify customer data. customfields.read: Grants permission to read custom fields. customfields.write: Grants permission to create and modify custom fields. deliveries.read: Grants permission to read deliveries. deliveries.write: Grants permission to create and modify deliveries. deliverynotes.print: Grants permission to print and output delivery notes. deliverynotes.read: Grants permission to read delivery notes. deliverynotes.write: Grants permission to create and modify delivery notes. extensibility.integration: >- Grants permission to manage extensions and integrations of the JTL-Wawi. foreignapps.manage: >- Grants permission to manage registered third-party apps (registration, update and removal). inventories.read: Grants permission to read stock levels. inventories.write: Grants permission to modify stock levels. invoices.read: Grants permission to read invoices. invoices.write: Grants permission to create and modify invoices. labels.read: Grants permission to read labels. labels.write: Grants permission to create and modify labels. masterdata.read: >- Read master data such as shipping methods, payment methods, color codes and tax classes. orders.read: Grants permission to read orders. picklists.read: Grants permission to read pick lists. picklists.write: Grants permission to create and modify pick lists. returns.read: Grants permission to read returns. returns.write: Grants permission to create and modify returns. saleschannels.read: Grants permission to read sales channels. salesinvoicecorrections.read: Grants permission to read invoice corrections. salesinvoicecorrections.write: Grants permission to create and modify invoice corrections. salesorders.print: Grants permission to print and output sales orders. salesorders.read: Grants permission to read sales orders. salesorders.write: Grants permission to create and modify sales orders. system.config.read: Grants permission to read the system configuration. system.config.write: Grants permission to modify the system configuration. system.worker.read: >- Grants permission to read the configuration and status of background workers. system.worker.write: Grants permission to configure and control background workers. taxes.read: Grants permission to read tax data. warehouse.read: Grants permission to read warehouse data. wawiapp.all: Grants access to Wawi app related operations. currencies.read: Grants read access to currencies. jera.read: Grants read access to JERA internal endpoints. paymentmethods.read: Grants read access to payment methods. salesinvoicecorrections.print: Grants permission to print and output invoice corrections. salesinvoices.print: Grants permission to print and output sales invoices. salesinvoices.read: Grants read access to sales invoices. salesinvoices.write: Grants write access to sales invoices. salesquotations.print: Grants permission to print and output sales quotations. salesquotations.read: Grants read access to sales quotations. salesquotations.write: Grants write access to sales quotations. suppliers.read: Grants permission to read suppliers. resources.read: Grants permission to read resource management data. resources.write: Grants permission to create and modify resource management data. pps.read: Grants permission to read production data. pps.write: Grants permission to create and modify production data. masterdata.write: Write master data inventory.read: Grants permission to read stock levels. inventory.write: Grants permission to modify stock levels. taxes.write: Grants permission to create and modify tax data. application.runas: >- Allows the application to execute requests on behalf of another user. ````