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
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://developer.comstruct.com/llms.txt

Use this file to discover all available pages before exploring further.

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>