Rechnungs-Dimensionen auflisten

curl --request GET \
  --url https://api.comstruct.com/v1/invoice-dimensions \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.comstruct.com/v1/invoice-dimensions")
  .header("X-API-Key", "<api-key>")
  .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::Get.new(url)
request["X-API-Key"] = '<api-key>'

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"
  }
]

Invoice dimensions

Invoice dimensions (custom properties)

Erforderliche Berechtigungen: invoices:read

Gibt alle für den Mandanten konfigurierten Rechnungs-Dimensionen zurück. Dimensionen sind benutzerdefinierte Eigenschaften (z. B. Kostenstelle, Projekt), die Rechnungen (Header), Positionen (placement: line_item) oder Rechnungskontierungen (placement: account) zugeordnet werden können.

Jede Dimension hat ein Feld type: option (vordefinierte Werte über Dimension-Optionen) oder text (beliebiger Freitext pro Zuweisung über dimension_id + text_value). Bei text-Dimensionen sind keine Optionen nötig.

GET

invoice-dimensions

Rechnungs-Dimensionen auflisten

curl --request GET \
  --url https://api.comstruct.com/v1/invoice-dimensions \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.comstruct.com/v1/invoice-dimensions")
  .header("X-API-Key", "<api-key>")
  .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::Get.new(url)
request["X-API-Key"] = '<api-key>'

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"
  }
]

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

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)

Available options:

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.

Available options:

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>

Invoice callback Create invoice dimension