Query Invoice Line Items

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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
  }
]

{
  "errorCode": "<string>",
  "validationErrors": {},
  "errors": {},
  "errorMessage": "<string>",
  "stacktrace": "<string>"
}

GET

sales-invoices

{invoiceId}

line-items

Query Invoice Line Items

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-invoices/{invoiceId}/line-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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
  }
]

{
  "errorCode": "<string>",
  "validationErrors": {},
  "errors": {},
  "errorMessage": "<string>",
  "stacktrace": "<string>"
}

Authorizations

Authorization

string

header

required

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

FlowAuthorization Code

Authorization URL: https://auth.jtl-cloud.com/oauth2/auth
Token URL: https://auth.jtl-cloud.com/oauth2/token

Scopes1

invoices.read

Grants permission to read invoices.

Headers

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.

string<uuid>

required

Unique ID to identify an invoice line item.

Example:

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

invoiceId

string<uuid>

required

Unique ID to identify an invoice.

Example:

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

salesOrderId

string<uuid>

required

Unique ID to identify a sales order.

Example:

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

salesOrderLineItemId

string<uuid>

required

Unique ID to identify a sales order line item.

Example:

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

itemId

string<uuid>

required

Unique ID to identify an item.

Example:

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

name

string

required

Name of the item.

sKU

string

required

SKU of the sales invoice item.

type

enum<integer>

required

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>

required

The quantity of the line item.

salesUnit

string

required

The measurement unit in which the line item is sold.

salesPriceNet

number<decimal>

required

The net sales price of the line item.

salesPriceGross

number<decimal>

required

The gross sales price of the line item.

discount

number<decimal>

required

The discount applied to the line item.

purchasePriceNet

number<decimal>

required

The price for which the merchant has bought the item.

taxRate

number<decimal>

required

The tax rate of the line item.

Overview

GraphQL

REST API

Query Invoice Line Items

Authorizations

Headers

Path Parameters

Response