Lieferanten aus SAP-System erstellen oder aktualisieren

curl --request POST \
  --url https://api.comstruct.com/v1/suppliers/sap \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "number": "EXTERNAL-09092",
    "title": "Beispiel GmbH-8",
    "legal_uid": "D456789900022202",
    "country_code": "US",
    "comment": "Bevorzugter Kontakt per E-Mail",
    "payment_term": "90T",
    "wth_tax_code": "90",
    "bank_details": [
      {
        "number": "9999912",
        "iban": "DE89370400440532013000"
      },
      {
        "external_id": "8881112",
        "iban": "GB33BUKB20201555555555"
      }
    ],
    "address": {
      "address": "Müllerstraße 1",
      "city": "Berlin",
      "zip": "10115",
      "country_code": "DE"
    }
  }
]
'

import requests

url = "https://api.comstruct.com/v1/suppliers/sap"

payload = [
    {
        "number": "EXTERNAL-09092",
        "title": "Beispiel GmbH-8",
        "legal_uid": "D456789900022202",
        "country_code": "US",
        "comment": "Bevorzugter Kontakt per E-Mail",
        "payment_term": "90T",
        "wth_tax_code": "90",
        "bank_details": [
            {
                "number": "9999912",
                "iban": "DE89370400440532013000"
            },
            {
                "external_id": "8881112",
                "iban": "GB33BUKB20201555555555"
            }
        ],
        "address": {
            "address": "Müllerstraße 1",
            "city": "Berlin",
            "zip": "10115",
            "country_code": "DE"
        }
    }
]
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      number: 'EXTERNAL-09092',
      title: 'Beispiel GmbH-8',
      legal_uid: 'D456789900022202',
      country_code: 'US',
      comment: 'Bevorzugter Kontakt per E-Mail',
      payment_term: '90T',
      wth_tax_code: '90',
      bank_details: [
        {number: '9999912', iban: 'DE89370400440532013000'},
        {external_id: '8881112', iban: 'GB33BUKB20201555555555'}
      ],
      address: {address: 'Müllerstraße 1', city: 'Berlin', zip: '10115', country_code: 'DE'}
    }
  ])
};

fetch('https://api.comstruct.com/v1/suppliers/sap', 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/suppliers/sap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'number' => 'EXTERNAL-09092',
        'title' => 'Beispiel GmbH-8',
        'legal_uid' => 'D456789900022202',
        'country_code' => 'US',
        'comment' => 'Bevorzugter Kontakt per E-Mail',
        'payment_term' => '90T',
        'wth_tax_code' => '90',
        'bank_details' => [
                [
                                'number' => '9999912',
                                'iban' => 'DE89370400440532013000'
                ],
                [
                                'external_id' => '8881112',
                                'iban' => 'GB33BUKB20201555555555'
                ]
        ],
        'address' => [
                'address' => 'Müllerstraße 1',
                'city' => 'Berlin',
                'zip' => '10115',
                'country_code' => 'DE'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comstruct.com/v1/suppliers/sap"

	payload := strings.NewReader("[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.comstruct.com/v1/suppliers/sap")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/suppliers/sap")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]"

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

{
  "message": "Supplier data received successfully"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "Unauthorized. Key is not linked to any customer."
}

{
  "error": "Unauthorized. Missing scope: suppliers:write"
}

{
  "error": "<string>"
}

Suppliers

Create or update SAP suppliers

Erforderliche Berechtigungen: suppliers:write

Empfängt und verarbeitet Lieferanten aus dem SAP-System. Akzeptiert ein Array von SAP-Lieferanten als Rohdaten. number wird als external_id gespeichert und für Upserts pro Kunde verwendet. API-Schlüssel muss mit einem Kunden verknüpft sein. Validierung: Der Body muss ein Array sein, title ist je Lieferant erforderlich, und angegebene Zahlungsbedingungen müssen im comstruct-Mandanten existieren.

POST

suppliers

sap

Lieferanten aus SAP-System erstellen oder aktualisieren

curl --request POST \
  --url https://api.comstruct.com/v1/suppliers/sap \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "number": "EXTERNAL-09092",
    "title": "Beispiel GmbH-8",
    "legal_uid": "D456789900022202",
    "country_code": "US",
    "comment": "Bevorzugter Kontakt per E-Mail",
    "payment_term": "90T",
    "wth_tax_code": "90",
    "bank_details": [
      {
        "number": "9999912",
        "iban": "DE89370400440532013000"
      },
      {
        "external_id": "8881112",
        "iban": "GB33BUKB20201555555555"
      }
    ],
    "address": {
      "address": "Müllerstraße 1",
      "city": "Berlin",
      "zip": "10115",
      "country_code": "DE"
    }
  }
]
'

import requests

url = "https://api.comstruct.com/v1/suppliers/sap"

payload = [
    {
        "number": "EXTERNAL-09092",
        "title": "Beispiel GmbH-8",
        "legal_uid": "D456789900022202",
        "country_code": "US",
        "comment": "Bevorzugter Kontakt per E-Mail",
        "payment_term": "90T",
        "wth_tax_code": "90",
        "bank_details": [
            {
                "number": "9999912",
                "iban": "DE89370400440532013000"
            },
            {
                "external_id": "8881112",
                "iban": "GB33BUKB20201555555555"
            }
        ],
        "address": {
            "address": "Müllerstraße 1",
            "city": "Berlin",
            "zip": "10115",
            "country_code": "DE"
        }
    }
]
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      number: 'EXTERNAL-09092',
      title: 'Beispiel GmbH-8',
      legal_uid: 'D456789900022202',
      country_code: 'US',
      comment: 'Bevorzugter Kontakt per E-Mail',
      payment_term: '90T',
      wth_tax_code: '90',
      bank_details: [
        {number: '9999912', iban: 'DE89370400440532013000'},
        {external_id: '8881112', iban: 'GB33BUKB20201555555555'}
      ],
      address: {address: 'Müllerstraße 1', city: 'Berlin', zip: '10115', country_code: 'DE'}
    }
  ])
};

fetch('https://api.comstruct.com/v1/suppliers/sap', 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/suppliers/sap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'number' => 'EXTERNAL-09092',
        'title' => 'Beispiel GmbH-8',
        'legal_uid' => 'D456789900022202',
        'country_code' => 'US',
        'comment' => 'Bevorzugter Kontakt per E-Mail',
        'payment_term' => '90T',
        'wth_tax_code' => '90',
        'bank_details' => [
                [
                                'number' => '9999912',
                                'iban' => 'DE89370400440532013000'
                ],
                [
                                'external_id' => '8881112',
                                'iban' => 'GB33BUKB20201555555555'
                ]
        ],
        'address' => [
                'address' => 'Müllerstraße 1',
                'city' => 'Berlin',
                'zip' => '10115',
                'country_code' => 'DE'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comstruct.com/v1/suppliers/sap"

	payload := strings.NewReader("[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.comstruct.com/v1/suppliers/sap")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/suppliers/sap")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"number\": \"EXTERNAL-09092\",\n    \"title\": \"Beispiel GmbH-8\",\n    \"legal_uid\": \"D456789900022202\",\n    \"country_code\": \"US\",\n    \"comment\": \"Bevorzugter Kontakt per E-Mail\",\n    \"payment_term\": \"90T\",\n    \"wth_tax_code\": \"90\",\n    \"bank_details\": [\n      {\n        \"number\": \"9999912\",\n        \"iban\": \"DE89370400440532013000\"\n      },\n      {\n        \"external_id\": \"8881112\",\n        \"iban\": \"GB33BUKB20201555555555\"\n      }\n    ],\n    \"address\": {\n      \"address\": \"Müllerstraße 1\",\n      \"city\": \"Berlin\",\n      \"zip\": \"10115\",\n      \"country_code\": \"DE\"\n    }\n  }\n]"

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

{
  "message": "Supplier data received successfully"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "Unauthorized. Key is not linked to any customer."
}

{
  "error": "Unauthorized. Missing scope: suppliers:write"
}

{
  "error": "<string>"
}

Overview

Use this endpoint to sync suppliers from SAP into comstruct. The request body is always an array, so a single supplier and batches are handled through the same POST call. When number is present, comstruct stores it as the supplier external_id. If a supplier with the same external_id already exists for the customer, that supplier is updated.

Send number for every SAP supplier. The field is not required by schema validation, but it is required for idempotent SAP syncs and later lookups.

Permissions

Scope	Tenant type
`suppliers:write`	Customer API key

The API key must be linked to a customer.

Headers

Header	Required	Description
`x-api-key`	Yes	API key with scope `suppliers:write`
`Content-Type`	Yes	`application/json`

Request body

The body must be a JSON array of suppliers.

Supplier fields

Field	Required	Description
`title`	Yes	Supplier name
`number`	No	SAP supplier number; mapped to `external_id` and used for upserts
`legal_uid`	No	VAT ID or tax ID
`country_code`	No	ISO 3166-1 alpha-2 country code
`comment`	No	Free-text supplier comment
`payment_term`	No	Payment term key; must exist in the comstruct customer tenant
`default_account`	No	Default account number; must exist in the comstruct customer tenant
`wth_tax_code`	No	Withholding tax code; defaults to `00`
`bank_details`	No	Supplier bank details
`address`	No	Supplier address

Bank details (`bank_details[]`)

Field	Required	Description
`iban`	No	Valid IBAN; entries without IBAN are ignored
`number`	No	External bank account number; preferred as the stored bank ID
`external_id`	No	Alternative external ID when `number` is not present

Address (`address`)

Field	Required	Description
`address`	No	Street and house number
`city`	No	City
`zip`	No	Postal code
`country_code`	No	ISO 3166-1 alpha-2 country code

Example

curl -X POST "https://api.comstruct.com/v1/suppliers/sap" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "number": "SAP-SUP-001",
      "title": "Acme Supplies GmbH",
      "legal_uid": "DE123456789",
      "country_code": "DE",
      "comment": "Preferred contact by email",
      "payment_term": "30T",
      "default_account": "4000",
      "wth_tax_code": "00",
      "bank_details": [
        {
          "number": "BANK-001",
          "iban": "DE89370400440532013000"
        }
      ],
      "address": {
        "address": "Example Street 1",
        "city": "Berlin",
        "zip": "10115",
        "country_code": "DE"
      }
    }
  ]'

Behavior

number is stored as external_id; existing suppliers with the same external_id and customer are updated.
On conflicts, only external_id, legal_uid, country_code, withholding_tax_code, payment_term_id, title, comment, address, city, and zip are updated.
payment_term is resolved against the customer’s payment terms. Unknown values return 400.
default_account is resolved against the customer’s accounts. Unknown values return 400. When omitted on upsert, any existing default_account_id is preserved.
If wth_tax_code is omitted, comstruct stores the default value 00.
Bank details are merged by IBAN, supplier, and tenant; on conflicts, the bank detail external ID is updated.

Response codes

Code	Description
`200`	Supplier data processed successfully
`400`	Invalid body, validation error, unknown payment term, or unknown default account
`401`	Unauthorized — API key is not linked to a customer
`403`	Forbidden — missing `suppliers:write` scope
`500`	Internal server error

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.

Body

application/json

title

string

required

Lieferantenname/Titel

Example:

"Beispiel GmbH-8"

number

string

Lieferantennummer aus SAP; wird als external_id gespeichert und für Upserts verwendet

Example:

"EXTERNAL-09092"

legal_uid

string

Optionale Umsatzsteuer-ID

Example:

"D456789900022202"

country_code

string

ISO 3166-1 alpha-2 Ländercode

Example:

"US"

comment

string

Freitext-Kommentar zum Lieferanten

Example:

"Bevorzugter Kontakt per E-Mail"

payment_term

string

Optionaler SAP-Zahlungsbedingungsschlüssel; muss, falls angegeben, im comstruct-Mandanten existieren

Example:

"90T"

default_account

string

Optionale Kontonummer des Standardkontos; muss, falls angegeben, im comstruct-Mandanten existieren

Example:

"4000"

wth_tax_code

string

Optionaler Quellensteuercode

Example:

"90"

bank_details

object[]

Optionale Bankverbindungen

Show child attributes

address

object

Show child attributes

Response

Lieferantendaten erfolgreich empfangen

message

string

Example:

"Supplier data received successfully"

Overview

Projects

Deliveries

Invoices

Invoice dimensions

Suppliers

Purchase orders

Orders (Supplier)

Master data

Q-Point Integration

Workflows

Calendar

IDS Orders

Create or update SAP suppliers

Overview

Permissions

Headers

Request body

Supplier fields

Bank details (`bank_details[]`)

Address (`address`)

Example

Behavior

Response codes

Authorizations

Body

Response

​Overview

​Permissions

​Headers

​Request body

​Supplier fields

​Bank details (bank_details[])

​Address (address)

​Example

​Behavior

​Response codes

Authorizations

Body

Response

Overview

Permissions

Headers

Request body

Supplier fields

Bank details (`bank_details[]`)

Address (`address`)

Example

Behavior

Response codes