Skip to main content
POST
/
invoice-dimensions
/
assignments
/
invoice
Header-Dimensions-Zuweisungen setzen
curl --request POST \
  --url https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "invoice_id": 12345,
  "assignments": [
    {
      "option_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text_value": "<string>"
    }
  ]
}
'
import requests

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

payload = {
    "invoice_id": 12345,
    "assignments": [
        {
            "option_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text_value": "<string>"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    invoice_id: 12345,
    assignments: [
      {
        option_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        dimension_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        text_value: '<string>'
      }
    ]
  })
};

fetch('https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'invoice_id' => 12345,
    'assignments' => [
        [
                'option_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'dimension_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'text_value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"invoice_id\": 12345,\n  \"assignments\": [\n    {\n      \"option_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dimension_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"text_value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.comstruct.com/v1/invoice-dimensions/assignments/invoice")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invoice_id\": 12345,\n  \"assignments\": [\n    {\n      \"option_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dimension_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"text_value\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoice_id\": 12345,\n  \"assignments\": [\n    {\n      \"option_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dimension_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"text_value\": \"<string>\"\n    }\n  ]\n}"

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

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.

Body

application/json
invoice_id
integer
required
Example:

12345

assignments
object[]
required

Response

Zuweisungen gesetzt

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>