Rechnung im benutzerdefinierten Format verarbeiten

curl --request POST \
  --url https://api.comstruct.com/v1/invoices/custom \
  --header 'Content-Type: */*' \
  --header 'X-API-Key: <api-key>' \
  --data '"<string>"'

import requests

url = "https://api.comstruct.com/v1/invoices/custom"

payload = "<string>"
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "*/*"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': '*/*'},
  body: JSON.stringify('<string>')
};

fetch('https://api.comstruct.com/v1/invoices/custom', 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/invoices/custom",
  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('<string>'),
  CURLOPT_HTTPHEADER => [
    "Content-Type: */*",
    "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/invoices/custom"

	payload := strings.NewReader("\"<string>\"")

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

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

	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/invoices/custom")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "*/*")
  .body("\"<string>\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoices/custom")

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"] = '*/*'
request.body = "\"<string>\""

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

{
  "invoiceId": "invoice-abc123def456",
  "success": true,
  "jobId": "job-789xyz012"
}

Invoices

Custom invoice upload

Erforderliche Berechtigungen: invoices:write

Verarbeitet ein benutzerdefiniertes Rechnungsformat mittels GPT/KI-Parsing. Akzeptiert PDF- oder TIFF-Dateien bis zu 32MiB und verarbeitet sie mittels generativer KI zur Rechnungsdatenextraktion.

Optionale Request-Header können vordefinierte Werte für Lieferant, Projekt und externe Dokument-ID übergeben und damit die von der KI extrahierten Felder überschreiben.

Der API-Schlüssel muss mit einem Lieferanten verknüpft sein.

POST

invoices

custom

Rechnung im benutzerdefinierten Format verarbeiten

curl --request POST \
  --url https://api.comstruct.com/v1/invoices/custom \
  --header 'Content-Type: */*' \
  --header 'X-API-Key: <api-key>' \
  --data '"<string>"'

import requests

url = "https://api.comstruct.com/v1/invoices/custom"

payload = "<string>"
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "*/*"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': '*/*'},
  body: JSON.stringify('<string>')
};

fetch('https://api.comstruct.com/v1/invoices/custom', 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/invoices/custom",
  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('<string>'),
  CURLOPT_HTTPHEADER => [
    "Content-Type: */*",
    "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/invoices/custom"

	payload := strings.NewReader("\"<string>\"")

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

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

	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/invoices/custom")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "*/*")
  .body("\"<string>\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoices/custom")

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"] = '*/*'
request.body = "\"<string>\""

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

{
  "invoiceId": "invoice-abc123def456",
  "success": true,
  "jobId": "job-789xyz012"
}

Overview

Processes invoices as PDF or TIFF files with AI-assisted data extraction. Optional request headers can supply preset values for supplier, project, and external document ID, overriding fields extracted by the AI parser.

Permissions

Scope	Tenant type
`invoices:write`	Supplier (`SUPPLIER_ONLY`)

The API key must be linked to a supplier.

Headers

Header	Required	Description
`x-api-key`	Yes	API key with scope `invoices:write`
`Content-Type`	Yes	`application/pdf` or `application/tiff`
`kreditorname`	No	Supplier name; overrides the supplier name extracted by the AI parser
`archivdocument`	No	External document ID for archival purposes; stored as the invoice `external_id`
`projekt`	No	Project number; overrides the project assignment extracted by the AI parser
`buchungskreis`	No	Company code (legal entity); fallback for the project number when `projekt` is empty — format `HQ-{buchungskreis}`

Preset header behavior

kreditorname sets supplier_name during invoice processing.
projekt sets project_number. If projekt is missing or empty, HQ-{buchungskreis} is used instead (when buchungskreis is set).
archivdocument is stored as the invoice external ID (external_id).

Example

curl -X POST "https://api.comstruct.com/v1/invoices/custom" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/pdf" \
  -H "kreditorname: Example Supplier GmbH" \
  -H "archivdocument: ARCH-2024-001" \
  -H "projekt: PRJ-001" \
  --data-binary @invoice.pdf

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.

Headers

kreditorname

string

Lieferantenname; überschreibt den von der KI extrahierten Lieferantennamen

archivdocument

string

Externe Dokument-ID für Archivierungszwecke; wird als external_id der Rechnung gespeichert

projekt

string

Projektnummer; überschreibt die von der KI extrahierte Projektzuordnung

buchungskreis

string

Buchungskreis (juristische Einheit); Fallback für die Projektnummer, wenn projekt leer ist (HQ-{buchungskreis})

Body

*/*

Rohe Rechnungsdaten (bis zu 32MiB)

Response

Rechnung erfolgreich verarbeitet und zur Hintergrundverarbeitung eingereiht

invoiceId

string

required

Eindeutige ID der erstellten Rechnung

Example:

"invoice-abc123def456"

success

boolean

required

Example:

true

jobId

string

Job-ID zur Nachverfolgung der Hintergrundverarbeitung

Example:

"job-789xyz012"

Get invoice PDF Email invoice

​Overview

​Permissions

​Headers

​Preset header behavior

​Example

Authorizations

Headers

Body

Response

Overview

Permissions

Headers

Preset header behavior

Example