Zum Hauptinhalt springen
GET
/
invoice-dimensions
Rechnungs-Dimensionen auflisten
curl --request GET \
  --url https://api.comstruct.com/v1/invoice-dimensions \
  --header 'X-API-Key: <api-key>'
[
  {
    "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"
  }
]
Rechnungs-Dimensionen sind benutzerdefinierte Eigenschaften (z. B. Kostenstelle, Projekt, Abteilung), die Sie Rechnungen (auf Header-Ebene) oder einzelnen Kontierungen (auf Konto-Ebene) zuweisen können.
  • Header-Dimensionen: gelten für die gesamte Rechnung.
  • Konto-Dimensionen: gelten pro Kontierung (Rechnungsposition).
Zuerst legen Sie Dimensionen und deren Optionen (die wählbaren Werte) an; anschließend weisen Sie diese über die Zuweisungs-Endpunkte den Rechnungen bzw. Konten zu. Änderungen werden in der Rechnungshistorie erfasst.

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.

Antwort

Erfolgreich

​
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>