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
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "placement": "header",
  "is_mandatory": 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

Antwort

Dimension erstellt

id
string<uuid>

Dimension-UUID

label
string

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

placement
enum<string>

Ebene (header = Rechnung, account = Kontierung)

Verfügbare Optionen:
header,
line_item,
account
is_mandatory
boolean

Ob die Dimension Pflicht ist

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