Skip to main content
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"
  }
]
Invoice dimensions are custom properties (e.g. cost center, project, department) that you can assign to invoices at header level or to individual line accounts at account level.
  • Header dimensions: apply to the entire invoice.
  • Account dimensions: apply per line item (invoice account).
First create dimensions and their options (the selectable values); then assign them to invoices or accounts via the assignment endpoints. Changes are recorded in invoice history.

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.

Response

Erfolgreich

​
id
string<uuid>

Dimension-UUID

​
label
string

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

​
placement
enum<string>

Ebene (header = Rechnung, account = Kontierung)

Available options:
header,
line_item,
account
​
is_mandatory
boolean

Ob die Dimension Pflicht ist

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