Zum Hauptinhalt springen
POST
/
invoice-dimensions
Rechnungs-Dimension anlegen
curl --request POST \
  --url https://api.comstruct.com/v1/invoice-dimensions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "label": "Kostenstelle",
  "placement": "account",
  "is_mandatory": true,
  "type": "option",
  "auto_assign_gl_account": false,
  "recognition": true
}
'
import requests

url = "https://api.comstruct.com/v1/invoice-dimensions"

payload = {
"label": "Kostenstelle",
"placement": "account",
"is_mandatory": True,
"type": "option",
"auto_assign_gl_account": False,
"recognition": True
}
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({
label: 'Kostenstelle',
placement: 'account',
is_mandatory: true,
type: 'option',
auto_assign_gl_account: false,
recognition: true
})
};

fetch('https://api.comstruct.com/v1/invoice-dimensions', 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/invoice-dimensions",
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([
'label' => 'Kostenstelle',
'placement' => 'account',
'is_mandatory' => true,
'type' => 'option',
'auto_assign_gl_account' => false,
'recognition' => true
]),
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/invoice-dimensions"

payload := strings.NewReader("{\n \"label\": \"Kostenstelle\",\n \"placement\": \"account\",\n \"is_mandatory\": true,\n \"type\": \"option\",\n \"auto_assign_gl_account\": false,\n \"recognition\": true\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/invoice-dimensions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Kostenstelle\",\n \"placement\": \"account\",\n \"is_mandatory\": true,\n \"type\": \"option\",\n \"auto_assign_gl_account\": false,\n \"recognition\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoice-dimensions")

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 \"label\": \"Kostenstelle\",\n \"placement\": \"account\",\n \"is_mandatory\": true,\n \"type\": \"option\",\n \"auto_assign_gl_account\": false,\n \"recognition\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "is_mandatory": true,
  "auto_assign_gl_account": true,
  "recognition": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

Body

application/json
label
string
erforderlich
Beispiel:

"Kostenstelle"

placement
enum<string>
erforderlich
Verfügbare Optionen:
header,
line_item,
account
Beispiel:

"account"

is_mandatory
boolean
erforderlich
Beispiel:

true

type
enum<string>
Standard:option

option (Standard) erfordert später Optionen; text erlaubt Freitext-Zuweisungen ohne Optionen.

Verfügbare Optionen:
option,
text
auto_assign_gl_account
boolean
Standard:false
recognition
boolean
Standard:true

Antwort

Dimension erstellt

id
string<uuid>

Dimension-UUID

label
string

Bezeichnung der Dimension (z. B. Kostenstelle, Projekt)

placement
enum<string>

Ebene (header = gesamte Rechnung, line_item = Rechnungsposition, account = Kontierung)

Verfügbare Optionen:
header,
line_item,
account
type
enum<string>

option: Werte aus vordefinierten Dimension-Optionen (option_id bei Zuweisungen). text: Freitext pro Zuweisung (dimension_id + text_value); keine Optionen erforderlich.

Verfügbare Optionen:
option,
text
is_mandatory
boolean

Ob die Dimension Pflicht ist

auto_assign_gl_account
boolean

Wenn aktiv, füllt die Zuweisung einer Option mit verknüpftem Sachkonto das G/L-Feld der Kontierung automatisch (nur sinnvoll bei Options-Dimensionen auf Kontoebene).

recognition
boolean

Wenn false, versucht die KI-Extraktion keine Werte für diese Dimension zu erkennen.

created_at
string<date-time>
updated_at
string<date-time>