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
}

Purchase orders

List purchase orders

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
}

Filter purchase orders by their delivery date using delivery_date_from and delivery_date_to. Both parameters are optional and inclusive. Use valid calendar dates in YYYY-MM-DD format, without a time or timezone.

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

Supply only delivery_date_from for orders due on or after that date.
Supply only delivery_date_to for orders due on or before that date.
Set both to the same date to retrieve orders for a single day.

The filters apply to the purchase order’s delivery_date, not item dates or linked deliveries. Orders without a delivery date are excluded when either date filter is supplied. Combine these parameters with project_id, supplier_id, and document_type; all supplied filters must match. Pagination and the total count apply to the filtered results. Results remain sorted by created_at descending. Invalid dates, timestamps, or a delivery_date_from later than delivery_date_to return HTTP 400. Omitting both date parameters preserves the existing list behavior, including orders without a delivery date.

Authorizations

X-API-Key

string

header

required

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.

Query Parameters

limit

integer

default:25

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

Required range: 1 <= x <= 500

Example:

25

offset

integer

default:0

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

Required range: x >= 0

Example:

0

project_id

string<uuid>

Nach Projekt-ID filtern

supplier_id

string<uuid>

Nach Lieferanten-ID filtern

document_type

enum<string>

Nach Dokumenttyp filtern

Available options:

ORDER_CONFIRMATION,

ORDER,

ORDER_CONDITIONS

delivery_date_from

string<date>

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

Example:

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

Example:

"2026-11-30"

Response

Erfolgreich

purchaseOrders

object[]

Show child attributes

total

integer

Gesamtanzahl der Bestellungen

Example:

150

limit

integer | null

Anzahl der Einträge pro Seite

Example:

25

offset

integer

Anzahl der übersprungenen Einträge

Example:

0

hasNext

boolean

Ob weitere Seiten verfügbar sind

Example:

true

hasPrevious

boolean

Ob vorherige Seiten verfügbar sind

Example:

false

totalPages

integer

Gesamtanzahl der Seiten

Example:

6

currentPage

integer

Aktuelle Seitennummer (0-basiert)

Example:

0

Overview

Projects

Deliveries

Invoices

Invoice dimensions

Suppliers

Purchase orders

Orders (Supplier)

Master data

Q-Point Integration

Workflows

Calendar

IDS Orders

List purchase orders

Authorizations

Query Parameters

Response