Skip to main content
GET
/
v2
/
invoices
/
{invoiceId}
/
lineitems
Query Invoice Line Items
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/invoices/{invoiceId}/lineitems \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "invoiceId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "name": "<string>",
    "sKU": "<string>",
    "type": 0,
    "quantity": 123,
    "salesUnit": "<string>",
    "salesPriceNet": 123,
    "salesPriceGross": 123,
    "discount": 123,
    "purchasePriceNet": 123,
    "taxRate": 123
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

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

​
x-appversion
string
required

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

​
x-runas
string

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

​
X-SessionId
string<uuid>

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

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
invoiceId
string<uuid>
required

The ID of the invoice that the line items belong to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

The requested line items.

​
id
string<uuid>

Unique ID to identify an invoice line item.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
invoiceId
string<uuid>

Unique ID to identify an invoice.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
salesOrderId
string<uuid>

Unique ID to identify a sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
salesOrderLineItemId
string<uuid>

Unique ID to identify a sales order line item.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
itemId
string<uuid>

Unique ID to identify an item.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
name
string

Name of the item.

​
sKU
string

SKU of the sales invoice item.

​
type
enum<integer>

Type of the sales invoice item.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21
​
quantity
number<decimal>

The quantity of the line item.

​
salesUnit
string

The measurement unit in which the line item is sold.

​
salesPriceNet
number<decimal>

The net sales price of the line item.

​
salesPriceGross
number<decimal>

The gross sales price of the line item.

​
discount
number<decimal>

The discount applied to the line item.

​
purchasePriceNet
number<decimal>

The price for which the merchant has bought the item.

​
taxRate
number<decimal>

The tax rate of the line item.