Zum Hauptinhalt springen
GET
/
invoice-dimensions
/
assignments
/
invoice
/
{invoiceId}
Dimensions-Zuweisungen einer Rechnung abrufen
curl --request GET \
  --url https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice/{invoiceId} \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice/{invoiceId}"

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/assignments/invoice/{invoiceId}', 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/assignments/invoice/{invoiceId}",
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/assignments/invoice/{invoiceId}"

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/assignments/invoice/{invoiceId}")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice/{invoiceId}")

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",
    "dimension_option_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "text_value": "<string>",
    "invoice_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoice_account_index": 123,
    "invoice_id": 123,
    "invoice_line_item_index": 123,
    "created_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.

Pfadparameter

invoiceId
integer
erforderlich

Antwort

Erfolgreich

id
string<uuid>
dimension_option_id
string<uuid> | null

Gesetzt bei Zuweisungen zu Options-Dimensionen; bei Freitext-Zuweisungen null.

dimension_id
string<uuid> | null

Dimension-UUID bei Freitext-Zuweisungen (type: text); sonst oft null oder redundant zur Option.

text_value
string | null

Freitextwert bei Text-Dimensionen; sonst null.

invoice_account_id
string<uuid> | null
invoice_account_index
integer | null

Index der Kontierung bei noch nicht gespeicherten Konten (temporäre IDs); alternativ zu invoice_account_id.

invoice_id
integer | null
invoice_line_item_index
integer | null
created_at
string<date-time>