Query Invoices

Query Invoices

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v1/invoices"

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/v1/invoices', 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/v1/invoices",
  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/v1/invoices"

	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/v1/invoices")
  .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/v1/invoices")

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

{
  "TotalItems": 123,
  "PageNumber": 123,
  "PageSize": 123,
  "Items": [
    {
      "Id": 123,
      "Number": "<string>",
      "ExternalNumber": "<string>",
      "CompanyId": 123,
      "DepartureCountry": {
        "CountryISO": "<string>",
        "State": "<string>",
        "CurrencyIso": "<string>",
        "CurrencyFactor": 123
      },
      "CustomerId": 123,
      "BillingAddress": {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      },
      "ShipmentAddress": {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      },
      "InvoiceDate": "2023-11-07T05:31:56Z",
      "InvoicePaymentDetails": {
        "PaymentMethodId": 123,
        "TotalGrossAmount": 123,
        "CurrencyIso": "<string>",
        "CurrencyFactor": 123,
        "StillToPay": 123,
        "PaymentTarget": 123,
        "CashDiscount": 123,
        "CashDiscountDays": 123,
        "StopPaymentRequest": true,
        "DunningLevel": 123,
        "NextDueDate": "2023-11-07T05:31:56Z"
      },
      "ColorcodeId": 123,
      "DunningBlock": true,
      "IsExternalInvoice": true,
      "Comment": "<string>",
      "CustomerComment": "<string>",
      "IsCancelled": true,
      "LanguageIso": "<string>",
      "CancellationDetails": {
        "CancellationReasonId": 123,
        "CancellationComment": "<string>",
        "Date": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "TotalPages": 123,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 123,
  "PreviousPageNumber": 123
}

GET

invoices

Query Invoices

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v1/invoices"

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/v1/invoices', 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/v1/invoices",
  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/v1/invoices"

	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/v1/invoices")
  .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/v1/invoices")

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

{
  "TotalItems": 123,
  "PageNumber": 123,
  "PageSize": 123,
  "Items": [
    {
      "Id": 123,
      "Number": "<string>",
      "ExternalNumber": "<string>",
      "CompanyId": 123,
      "DepartureCountry": {
        "CountryISO": "<string>",
        "State": "<string>",
        "CurrencyIso": "<string>",
        "CurrencyFactor": 123
      },
      "CustomerId": 123,
      "BillingAddress": {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      },
      "ShipmentAddress": {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      },
      "InvoiceDate": "2023-11-07T05:31:56Z",
      "InvoicePaymentDetails": {
        "PaymentMethodId": 123,
        "TotalGrossAmount": 123,
        "CurrencyIso": "<string>",
        "CurrencyFactor": 123,
        "StillToPay": 123,
        "PaymentTarget": 123,
        "CashDiscount": 123,
        "CashDiscountDays": 123,
        "StopPaymentRequest": true,
        "DunningLevel": 123,
        "NextDueDate": "2023-11-07T05:31:56Z"
      },
      "ColorcodeId": 123,
      "DunningBlock": true,
      "IsExternalInvoice": true,
      "Comment": "<string>",
      "CustomerComment": "<string>",
      "IsCancelled": true,
      "LanguageIso": "<string>",
      "CancellationDetails": {
        "CancellationReasonId": 123,
        "CancellationComment": "<string>",
        "Date": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "TotalPages": 123,
  "HasPreviousPage": true,
  "HasNextPage": true,
  "NextPageNumber": 123,
  "PreviousPageNumber": 123
}

Authorizations

Authorization

string

header

required

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

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.

Query Parameters

salesOrderNumber

string

Search for a specific sales order number.

externalOrderNumber

string

Search for a specific external order number.

invoiceNumber

string

Search for a specific invoice number.

itemId

integer<int32>

customerId

integer<int32>

Gets the unique identifier for the customer. Represents a unique key for identifying a customer in the JTL system.

IsExisting

boolean

Gets a value indicating whether the customer key represents an existing customer.

paymentStatus

enum<integer>

Search for a specific payment status. 0 = UnPayed, 1 = PartialPayed, 2 = Payed

Available options:

0,

1,

2

isExternalInvoice

boolean

Search only for external invoices

pageNumber

integer<int32>

Number of the page of items to fetch.

pageSize

integer<int32>

Size of the page that is specified by pageNumber.

Response

Returns all non-pending sales orders.

Represents a paginated list of items

TotalItems

integer<int32>

required

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

PageNumber

integer<int32>

required

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

PageSize

integer<int32>

required

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

Items

object[]

required

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

Show child attributes

TotalPages

integer<int32>

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

HasPreviousPage

boolean

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

HasNextPage

boolean

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

NextPageNumber

integer<int32>

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

PreviousPageNumber

integer<int32>

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

Query Invoice Workflow Events Get Invoice

⌘I

Overview

REST API

Authorizations

Headers

Query Parameters

Response