Skip to content

JTL-WAWI API (OnPrem) (1.1)

JTL-Wawi-Version: 1.11.0.0

Introduction

Welcome 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.

Authentication

You 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://wawi-api.jtl-software.com/?#tag/appRegistration. This information has to include the following:

  • AppId
  • DisplayName
  • Description
  • Version
  • ProviderName
  • ProviderWebsite
  • MandatoryApiScopes

This 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.

Before 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.

The 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.

After 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!

This 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.

HTTP Header

To make a successful API request, it is essential to include the correct authentication data in the request header. Upper case and lower case is ignored. The header should contain the following information:

  • X-AppID: This is the name of your application, in this case "MyApp/1.0.0". It is used to identify your application.
  • X-AppVersion: This is where the version number of your application is entered, in this case "1.0.0".
  • X-RunAs: Here, a JTL-Wawi user can be specified to perform an API call on their behalf (more details in the documentation).
  • X-ChallengeCode: You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.
  • Authorization: The API key. Example: "Wawi 00000000-0000-00000-0000-000000000000"
Download OpenAPI description
Languages
Servers
Mock server

https://developer.jtl-software.com/_mock/products/erpapi/openapi/

Local OnPremise Environment

http://127.0.0.1:64110/api/eazybusiness/

odata

worker

Planned

Operations

wms

Query all pick lists for a specific wms warehouse that are not completed.
Operations

warehouse

Query all warehouses
Operations

transactionStatus

Query all transaction status for sales order
Operations

tax

Returns the Taxrate for the given Item
Operations

item

Query all tax classes
Operations

supplier

Query all suppliers
Operations

stock

Query stocks for a specific item, warehouse or storage location
Operations

shippingmethod

Query all shipping methods
Operations

salesorder

Query all sales orders
Operations

cancellationreason

Planned

Operations

salesinvoicecorrection

Development

saleschannel

Get all sales channels
Operations

return

Create a new return with associated items and packages.
Operations

returnstate

Planned

Operations

returnreason

Planned

Operations

property

Query all properties for items
Operations

printer

Returns all Installed Printers
Operations

paymentmethod

Query all payment methods
Operations

onholdreason

Query all on hold reasons for sales orders
Operations

offer

Execute the printing of a Offer
Operations

Configuration

Planned

Operations

invoice

Planned

Operations

info

Returns the status of the API
Operations

features

Returns the available feature sets with release state and API version
Operations

Extensibility

Planned

Operations

shipping

Development

deliverynote

Planned

Operations

customer

Query all customers
Operations

customerGroup

Query all customer groups
Operations

customerCategory

Query all customer categories
Operations

creditnote

Execute the printing of a CreditNote
Operations

company

Query all companies
Operations

colorcodes

Query all color codes for sales orders
Operations

category

Query all categories
Operations

appRegistration

Send a registration request for an (external) application
Operations

login

Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL.
Operations

logout

Sends a request to log out the user
Operations

accountingData

Planned

Operations

Query Accounting Data

Request

Delivers a paginated overview of finalized accounting transactions, including invoices, credits, and their cancellations and corrections.

Security
Wawi
Query
fromstring(date-time)

Filters documents starting from a specific date and time

tostring(date-time)

Filters documents up to a specific date and time

kFirmainteger(int32)
typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.DocumentType)

Specifies the type of document. 0 = Invoice, 1 = Credit, 2 = Invoice correction, 3 = Invoice cancellation, 4 = credit cancellation, 5 = invoice correction cancellation

Enum01234567
exportCurrencyInDepartureCountryboolean

If true, exports total sums in the currency of the departure country

pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
api-versionstring

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/accountingData?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&kFirma=0&type=0&exportCurrencyInDepartureCountry=true&pageNumber=0&pageSize=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'api-version: string' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Provides a detailed overview of all non-pending sales orders, including invoices, credits, invoice corrections, invoice cancellations, credit cancellations, and invoice correction cancellations, along with their associated line items

Bodyapplication/json
TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingData)required

Gets or sets the collection of items contained in the paged list.

Items[].​DocumentNumberstringrequired

The number of the document.

Example: "A1004465"
Items[].​DocumentIdinteger(int32)required

The identifier of the document.

Example: 1
Items[].​DocumentDatestring(date-time)required

The date and time when the document was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​SalesOrderNumberstringrequired

The internal number of the sales order.

Example: "D456-64894-132"
Items[].​SalesOrderIdinteger(int32)(JTL.Data.Contracts.Keys.VerkaufAuftragKey)required
Items[].​ExternalSalesOrderNumberstringrequired

The external number of the sales order.

Example: "B342-46456-4234"
Items[].​DepartureCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country)required

Model Class: Country

Items[].​DepartureCountry.​CountryISOstringrequired

ISO code of the country.

Example: "DE"
Items[].​DepartureCountry.​StateISOstringrequired

ISO code of the state within the country.

Example: "PA"
Items[].​ShipmentCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country)required

Model Class: Country

Items[].​ShipmentCountry.​CountryISOstringrequired

ISO code of the country.

Example: "DE"
Items[].​ShipmentCountry.​StateISOstringrequired

ISO code of the state within the country.

Example: "PA"
Items[].​BillingAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

Items[].​BillingAddress.​Idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
Items[].​BillingAddress.​Companystringrequired

Description of the Company.

Example: "Sportbedarf Sommer"
Items[].​BillingAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​BillingAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​BillingAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​BillingAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​BillingAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​BillingAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​BillingAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​BillingAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​BillingAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​BillingAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​BillingAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​BillingAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​BillingAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​BillingAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​BillingAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​BillingAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Items[].​ShipmentAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

Items[].​ShipmentAddress.​Idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
Items[].​ShipmentAddress.​Companystringrequired

Description of the Company.

Example: "Sportbedarf Sommer"
Items[].​ShipmentAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​ShipmentAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​ShipmentAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​ShipmentAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​ShipmentAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​ShipmentAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​ShipmentAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​ShipmentAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​ShipmentAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​ShipmentAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​ShipmentAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​ShipmentAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​ShipmentAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​ShipmentAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​ShipmentAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​ShipmentAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Items[].​CurrencyIsostringrequired

ISO code of the currency of the departure country.

Example: "EUR"
Items[].​Typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.DocumentType)required

0 = Invoice, 1 = Credit, 2 = InvoiceCorrection, 3 = InvoiceCancellation, 4 = CreditCancellation, 5 = InvoiceCorrectionCancellation, 6 = Liquidation, 7 = LiquidationCancellation

Enum01234567
Items[].​CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
Items[].​CompanyVatIdstringrequired

The VAT Id of the Company

Example: "DE123456789"
Items[].​CustomerVatIdstringrequired

The VAT ID of the customer, if applicable.

Example: "DE123456789"
Items[].​SalesChannelIdstringrequired
Example: "1-1-1"
Items[].​IsCancelledbooleanrequired

Indicates if the document has been cancelled.

Example: false
Items[].​AccountDataLineItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingDataLineItem)required

Detailed list of items included in the document.

Items[].​AccountDataLineItems[].​ItemIdinteger(int32)(JTL.Data.Contracts.Keys.ArtikelKey)required
Items[].​AccountDataLineItems[].​Typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.LineItemType)required

0 = CustomLineItem, 1 = Item, 2 = ShippingItem, 3 = Coupon, 4 = Voucher, 5 = PaymentMethod, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDeliveryFee, 9 = ItemShippingSurcharge, 10 = GiftWrapping, 11 = FreeGift, 12 = TrustedShopsFee, 13 = InterestSurcharge, 14 = HandlingFee, 15 = CardboardBoxes, 16 = Return, 17 = MultiPurposeVoucher, 18 = MultiPurposeDigitalVoucher, 19 = SinglePurposeVoucher, 20 = SinglePurposeDigitalVoucher, 21 = SinglePurposeVoucherRedemption

Enum0123456789
Items[].​AccountDataLineItems[].​Namestringrequired

The description of the line item

Example: "USB Headset"
Items[].​AccountDataLineItems[].​TaxClassIdinteger(int32)(JTL.Data.Contracts.Keys.SteuerklasseKey)required
Items[].​AccountDataLineItems[].​GeneralLedgerAccountstringrequired

An account or record used to sort, store and summarize a company's transactions

Example: "4300"
Items[].​AccountDataLineItems[].​Quantitynumber(decimal)required

The number of items

Example: 1
Items[].​AccountDataLineItems[].​VatRatenumber(decimal)required

Applicable VAT rate in percentage

Example: 19
Items[].​AccountDataLineItems[].​VatAmountnumber(decimal)required

Total VAT charged for this item

Example: 24.99
Items[].​AccountDataLineItems[].​TotalDiscountGrossAmountnumber(decimal)required

Total discount amount including VAT

Example: 3
Items[].​AccountDataLineItems[].​TotalDiscountNetAmountnumber(decimal)required

Total discount amount excluding VAT

Example: 2.43
Items[].​AccountDataLineItems[].​TotalGrossAmountnumber(decimal)required

Total item price including VAT

Example: 19.99
Items[].​AccountDataLineItems[].​TotalNetAmountnumber(decimal)required

Total item price excluding VAT

Example: 16.19
Items[].​AccountDataLineItems[].​SortOrderinteger(int32)required

The order in which the line item appears in the document

Example: 1
TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response
application/json
{ "TotalItems": 0, "PageNumber": 0, "PageSize": 0, "Items": [ {} ], "TotalPages": 0, "HasPreviousPage": true, "HasNextPage": true, "NextPageNumber": 0, "PreviousPageNumber": 0 }

Query Accounting DataDeprecated

Request

DEPRECATED: Use Versioning with Header Delivers a paginated overview of finalized accounting transactions, including invoices, credits, and their cancellations and corrections.

Security
Wawi
Query
fromstring(date-time)

Filters documents starting from a specific date and time

tostring(date-time)

Filters documents up to a specific date and time

kFirmainteger(int32)
typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.DocumentType)

Specifies the type of document. 0 = Invoice, 1 = Credit, 2 = Invoice correction, 3 = Invoice cancellation, 4 = credit cancellation, 5 = invoice correction cancellation

Enum01234567
exportCurrencyInDepartureCountryboolean

If true, exports total sums in the currency of the departure country

pageNumberinteger(int32)

Number of the page of items to fetch.

pageSizeinteger(int32)

Size of the page that is specified by pageNumber.

Headers
x-appidstringrequired

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversionstringrequired

This is where the version number of your application is entered, e.g. "1.0.0".

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionIdstring(uuid)

The id of a session in which the call will be executed.

curl -i -X GET \
  'https://developer.jtl-software.com/_mock/products/erpapi/openapi/v1/accountingData?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&kFirma=0&type=0&exportCurrencyInDepartureCountry=true&pageNumber=0&pageSize=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-SessionId: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-appid: string' \
  -H 'x-appversion: string' \
  -H 'x-runas: string'

Responses

Provides a detailed overview of all non-pending sales orders, including invoices, credits, invoice corrections, invoice cancellations, credit cancellations, and invoice correction cancellations, along with their associated line items

Bodyapplication/json
TotalItemsinteger(int32)required

Gets or sets the total number of items available in the data source.

PageNumberinteger(int32)required

Gets or sets the current page number in the paginated list.

PageSizeinteger(int32)required

Gets or sets the number of items per page in the paginated list.

ItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingData)required

Gets or sets the collection of items contained in the paged list.

Items[].​DocumentNumberstringrequired

The number of the document.

Example: "A1004465"
Items[].​DocumentIdinteger(int32)required

The identifier of the document.

Example: 1
Items[].​DocumentDatestring(date-time)required

The date and time when the document was created.

Example: "2023-02-01T12:45:00.0000000+00:00"
Items[].​SalesOrderNumberstringrequired

The internal number of the sales order.

Example: "D456-64894-132"
Items[].​SalesOrderIdinteger(int32)(JTL.Data.Contracts.Keys.VerkaufAuftragKey)required
Items[].​ExternalSalesOrderNumberstringrequired

The external number of the sales order.

Example: "B342-46456-4234"
Items[].​DepartureCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country)required

Model Class: Country

Items[].​DepartureCountry.​CountryISOstringrequired

ISO code of the country.

Example: "DE"
Items[].​DepartureCountry.​StateISOstringrequired

ISO code of the state within the country.

Example: "PA"
Items[].​ShipmentCountryobject(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.Country)required

Model Class: Country

Items[].​ShipmentCountry.​CountryISOstringrequired

ISO code of the country.

Example: "DE"
Items[].​ShipmentCountry.​StateISOstringrequired

ISO code of the state within the country.

Example: "PA"
Items[].​BillingAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

Items[].​BillingAddress.​Idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
Items[].​BillingAddress.​Companystringrequired

Description of the Company.

Example: "Sportbedarf Sommer"
Items[].​BillingAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​BillingAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​BillingAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​BillingAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​BillingAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​BillingAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​BillingAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​BillingAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​BillingAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​BillingAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​BillingAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​BillingAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​BillingAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​BillingAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​BillingAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​BillingAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Items[].​ShipmentAddressobject(JTL.Wawi.Rest.Contracts.Models.V1.Common.Address)required

Model Class: Address

Items[].​ShipmentAddress.​Idinteger(int32)(JTL.Data.Contracts.Keys.AdresseKey)required
Items[].​ShipmentAddress.​Companystringrequired

Description of the Company.

Example: "Sportbedarf Sommer"
Items[].​ShipmentAddress.​Company2stringrequired

Additional company information

Example: "Innovation Division"
Items[].​ShipmentAddress.​FormOfAddressstringrequired

Customer form of address

Example: "Mr."
Items[].​ShipmentAddress.​Titlestringrequired

Official title

Example: "Dr."
Items[].​ShipmentAddress.​FirstNamestringrequired

Customer first name

Example: "John"
Items[].​ShipmentAddress.​LastNamestringrequired

Customer last name

Example: "Doe"
Items[].​ShipmentAddress.​Streetstringrequired

Street name in the customer's address

Example: "Main St. 123"
Items[].​ShipmentAddress.​Address2stringrequired

Additional address information

Example: "Floor 5, Apt 302"
Items[].​ShipmentAddress.​PostalCodestringrequired

Postal code of the customer's address

Example: "12345"
Items[].​ShipmentAddress.​Citystringrequired

Name of city in the customer's address

Example: "Example City"
Items[].​ShipmentAddress.​Statestringrequired

Name of state in the customer's address

Example: "Example State"
Items[].​ShipmentAddress.​CountryIsostringrequired

Country ISO code

Example: "DE"
Items[].​ShipmentAddress.​VatIDstringrequired

Supplier VAT ID number

Example: "DE123456789"
Items[].​ShipmentAddress.​PhoneNumberstringrequired

Landline phone number

Example: "+49 1234 445556661"
Items[].​ShipmentAddress.​MobilePhoneNumberstringrequired

Mobile phone number

Example: "+49 160 123 4567"
Items[].​ShipmentAddress.​EmailAddressstringrequired

Email address

Example: "example@email.com"
Items[].​ShipmentAddress.​Faxstringrequired

Fax number

Example: "+49 1234 4455566615"
Items[].​CurrencyIsostringrequired

ISO code of the currency of the departure country.

Example: "EUR"
Items[].​Typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.DocumentType)required

0 = Invoice, 1 = Credit, 2 = InvoiceCorrection, 3 = InvoiceCancellation, 4 = CreditCancellation, 5 = InvoiceCorrectionCancellation, 6 = Liquidation, 7 = LiquidationCancellation

Enum01234567
Items[].​CompanyIdinteger(int32)(JTL.Data.Contracts.Keys.FirmaKey)required
Items[].​CompanyVatIdstringrequired

The VAT Id of the Company

Example: "DE123456789"
Items[].​CustomerVatIdstringrequired

The VAT ID of the customer, if applicable.

Example: "DE123456789"
Items[].​SalesChannelIdstringrequired
Example: "1-1-1"
Items[].​IsCancelledbooleanrequired

Indicates if the document has been cancelled.

Example: false
Items[].​AccountDataLineItemsArray of objects(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.AccountingDataLineItem)required

Detailed list of items included in the document.

Items[].​AccountDataLineItems[].​ItemIdinteger(int32)(JTL.Data.Contracts.Keys.ArtikelKey)required
Items[].​AccountDataLineItems[].​Typeinteger(int32)(JTL.Wawi.Rest.Contracts.Models.V1.AccountingData.LineItemType)required

0 = CustomLineItem, 1 = Item, 2 = ShippingItem, 3 = Coupon, 4 = Voucher, 5 = PaymentMethod, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDeliveryFee, 9 = ItemShippingSurcharge, 10 = GiftWrapping, 11 = FreeGift, 12 = TrustedShopsFee, 13 = InterestSurcharge, 14 = HandlingFee, 15 = CardboardBoxes, 16 = Return, 17 = MultiPurposeVoucher, 18 = MultiPurposeDigitalVoucher, 19 = SinglePurposeVoucher, 20 = SinglePurposeDigitalVoucher, 21 = SinglePurposeVoucherRedemption

Enum0123456789
Items[].​AccountDataLineItems[].​Namestringrequired

The description of the line item

Example: "USB Headset"
Items[].​AccountDataLineItems[].​TaxClassIdinteger(int32)(JTL.Data.Contracts.Keys.SteuerklasseKey)required
Items[].​AccountDataLineItems[].​GeneralLedgerAccountstringrequired

An account or record used to sort, store and summarize a company's transactions

Example: "4300"
Items[].​AccountDataLineItems[].​Quantitynumber(decimal)required

The number of items

Example: 1
Items[].​AccountDataLineItems[].​VatRatenumber(decimal)required

Applicable VAT rate in percentage

Example: 19
Items[].​AccountDataLineItems[].​VatAmountnumber(decimal)required

Total VAT charged for this item

Example: 24.99
Items[].​AccountDataLineItems[].​TotalDiscountGrossAmountnumber(decimal)required

Total discount amount including VAT

Example: 3
Items[].​AccountDataLineItems[].​TotalDiscountNetAmountnumber(decimal)required

Total discount amount excluding VAT

Example: 2.43
Items[].​AccountDataLineItems[].​TotalGrossAmountnumber(decimal)required

Total item price including VAT

Example: 19.99
Items[].​AccountDataLineItems[].​TotalNetAmountnumber(decimal)required

Total item price excluding VAT

Example: 16.19
Items[].​AccountDataLineItems[].​SortOrderinteger(int32)required

The order in which the line item appears in the document

Example: 1
TotalPagesinteger(int32)read-only

Gets the total number of pages based on the total number of items and the page size.

HasPreviousPagebooleanread-only

Gets a value indicating whether there is a previous page available in the paginated list.

HasNextPagebooleanread-only

Gets a value indicating whether there is a next page available.

NextPageNumberinteger(int32)read-only

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

PreviousPageNumberinteger(int32)read-only

Gets the number of the previous page. If there is no previous page, it returns 1.

Response
application/json
{ "TotalItems": 0, "PageNumber": 0, "PageSize": 0, "Items": [ {} ], "TotalPages": 0, "HasPreviousPage": true, "HasNextPage": true, "NextPageNumber": 0, "PreviousPageNumber": 0 }