Bestellungen auflisten

curl --request GET \
  --url https://api.comstruct.com/v1/purchase-orders \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.comstruct.com/v1/purchase-orders', 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.comstruct.com/v1/purchase-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.comstruct.com/v1/purchase-orders"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/purchase-orders")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "purchaseOrders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contract_number": "PO-2024-001",
      "alternative_contract_number": "<string>",
      "comment": "<string>",
      "order_number": "<string>",
      "delivery_date": "2023-12-25",
      "delivery_terms": "<string>",
      "delivery_address": "<string>",
      "document_type": "ORDER_CONFIRMATION",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "supplier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "external_id": "<string>"
      },
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "project_number": "<string>"
      },
      "payment_term": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "title": "<string>"
      },
      "purchase_order_items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "title": "<string>",
          "quantity": 123,
          "net_price": 123,
          "price_per_unit": 123,
          "discount": 123,
          "special_discount": 123,
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tax_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product": {
            "title": "<string>",
            "unit": "<string>",
            "product_number": "<string>"
          }
        }
      ]
    }
  ],
  "total": 150,
  "limit": 25,
  "offset": 0,
  "hasNext": true,
  "hasPrevious": false,
  "totalPages": 6,
  "currentPage": 0
}

Bestellungen

Bestellungen auflisten

Erforderliche Berechtigungen: purchase_orders:read

Gibt eine paginierte Liste von Bestellungen des aktuellen Mandanten zurück, inklusive Positionen. Sortierung nach created_at absteigend. Optional nach project_id, supplier_id, document_type, delivery_date_from und delivery_date_to filterbar. Die Lieferdatumsfilter beziehen sich auf delivery_date der Bestellung, nicht auf einzelne Positionen oder verknüpfte Lieferungen. Beide Datumsgrenzen sind inklusive und können einzeln verwendet werden. Für einen einzelnen Tag beide Grenzen auf dasselbe Datum setzen. Bei aktivem Lieferdatumsfilter werden Bestellungen ohne Lieferdatum ausgeschlossen. Alle Filter werden mit UND verknüpft; total zählt nur passende Bestellungen. Datumswerte müssen gültige Kalenderdaten im Format YYYY-MM-DD sein (ohne Uhrzeit oder Zeitzone). Ungültige Datumswerte oder delivery_date_from nach delivery_date_to führen zu HTTP 400.

Beispiel: GET /v1/purchase-orders?delivery_date_from=2026-11-01&delivery_date_to=2026-11-30

GET

purchase-orders

Bestellungen auflisten

curl --request GET \
  --url https://api.comstruct.com/v1/purchase-orders \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.comstruct.com/v1/purchase-orders', 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.comstruct.com/v1/purchase-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.comstruct.com/v1/purchase-orders"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/purchase-orders")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "purchaseOrders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contract_number": "PO-2024-001",
      "alternative_contract_number": "<string>",
      "comment": "<string>",
      "order_number": "<string>",
      "delivery_date": "2023-12-25",
      "delivery_terms": "<string>",
      "delivery_address": "<string>",
      "document_type": "ORDER_CONFIRMATION",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "supplier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "external_id": "<string>"
      },
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "project_number": "<string>"
      },
      "payment_term": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "title": "<string>"
      },
      "purchase_order_items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "title": "<string>",
          "quantity": 123,
          "net_price": 123,
          "price_per_unit": 123,
          "discount": 123,
          "special_discount": 123,
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tax_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product": {
            "title": "<string>",
            "unit": "<string>",
            "product_number": "<string>"
          }
        }
      ]
    }
  ],
  "total": 150,
  "limit": 25,
  "offset": 0,
  "hasNext": true,
  "hasPrevious": false,
  "totalPages": 6,
  "currentPage": 0
}

Filtern Sie Bestellungen nach ihrem Lieferdatum mit delivery_date_from und delivery_date_to. Beide Parameter sind optional und inklusive. Verwenden Sie gültige Kalenderdaten im Format YYYY-MM-DD, ohne Uhrzeit oder Zeitzone.

GET /v1/purchase-orders?delivery_date_from=2026-11-01&delivery_date_to=2026-11-30

Nur delivery_date_from: Bestellungen mit Lieferdatum am oder nach diesem Tag.
Nur delivery_date_to: Bestellungen mit Lieferdatum am oder vor diesem Tag.
Beide Parameter mit demselben Datum: Bestellungen für einen einzelnen Tag.

Die Filter beziehen sich auf delivery_date der Bestellung, nicht auf Positionsdaten oder verknüpfte Lieferungen. Bestellungen ohne Lieferdatum werden ausgeschlossen, sobald ein Datumsfilter angegeben wird. Die Parameter können mit project_id, supplier_id und document_type kombiniert werden; alle angegebenen Filter müssen zutreffen. Paginierung und total beziehen sich auf die gefilterten Ergebnisse. Die Sortierung bleibt nach created_at absteigend. Ungültige Datumswerte, Zeitstempel oder ein delivery_date_from nach delivery_date_to führen zu HTTP 400. Ohne Datumsfilter bleibt das bisherige Verhalten unverändert, einschließlich Bestellungen ohne Lieferdatum.

Autorisierungen

X-API-Key

string

header

erforderlich

API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Abfrageparameter

limit

integer

Standard:25

Anzahl der Einträge pro Seite (max. 500, Standard 25)

Erforderlicher Bereich: 1 <= x <= 500

Beispiel:

25

offset

integer

Standard:0

Anzahl der zu überspringenden Einträge für die Paginierung

Erforderlicher Bereich: x >= 0

Beispiel:

0

project_id

string<uuid>

Nach Projekt-ID filtern

supplier_id

string<uuid>

Nach Lieferanten-ID filtern

document_type

enum<string>

Nach Dokumenttyp filtern

Verfügbare Optionen:

ORDER_CONFIRMATION,

ORDER,

ORDER_CONDITIONS

delivery_date_from

string<date>

Frühestes Lieferdatum der Bestellung (inklusive). Kann ohne delivery_date_to verwendet werden.

Beispiel:

"2026-11-01"

delivery_date_to

string<date>

Spätestes Lieferdatum der Bestellung (inklusive). Muss am oder nach delivery_date_from liegen, falls beide angegeben sind.

Beispiel:

"2026-11-30"

Antwort

Erfolgreich

purchaseOrders

object[]

Show child attributes

total

integer

Gesamtanzahl der Bestellungen

Beispiel:

150

limit

integer | null

Anzahl der Einträge pro Seite

Beispiel:

25

offset

integer

Anzahl der übersprungenen Einträge

Beispiel:

0

hasNext

boolean

Ob weitere Seiten verfügbar sind

Beispiel:

true

hasPrevious

boolean

Ob vorherige Seiten verfügbar sind

Beispiel:

false

totalPages

integer

Gesamtanzahl der Seiten

Beispiel:

6

currentPage

integer

Aktuelle Seitennummer (0-basiert)

Beispiel:

0

Übersicht

Projekte

Lieferungen

Rechnungen

Rechnungs-Dimensionen

Lieferanten

Bestellungen

Bestellungen (Lieferanten)

Stammdaten

Q-Point Integration

Workflows

Kalender

IDS Aufträge

Bestellungen auflisten

Autorisierungen

Abfrageparameter

Antwort