Get invoice by ID

Rechnung abrufen

curl --request GET \
  --url https://api.comstruct.com/v1/invoices/{id} \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.comstruct.com/v1/invoices/{id}', 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/invoices/{id}",
  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/invoices/{id}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoices/{id}")

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": "123",
  "external_id": "EXT-123",
  "external_status": "EXPORTED",
  "invoice_number": "INV-2024-001",
  "invoice_date": "2024-01-15",
  "due_date": "2024-02-15",
  "receipt_date": "2023-11-07T05:31:56Z",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_number": "PRJ-2024-001",
  "supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supplier_name": "ABC Supplies Ltd.",
  "supplier_tax_id": "<string>",
  "supplier_iban": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "EUR",
  "net_amount": 1000,
  "total_tax_amount": 190,
  "total_amount": 1190,
  "deducted_net_amount": 800,
  "deducted_total_tax_amount": 152,
  "deducted_total_amount": 952,
  "tax_rate": 123,
  "status": "NEW",
  "document_type": "INVOICE",
  "electronic_invoice_type": "ZUGFERD",
  "down_payment_number": 123,
  "payment_reference": "RF18539007547034",
  "reference_type": "QRR",
  "payment_term": {
    "number": "<string>",
    "title": "<string>"
  },
  "region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legal_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_region": {
    "id": "<string>",
    "title": "<string>",
    "number": "<string>"
  },
  "legal_entity": {
    "id": "<string>",
    "title": "<string>",
    "number": "<string>"
  },
  "supplier": {
    "id": "<string>",
    "title": "<string>",
    "external_id": "<string>",
    "legal_uid": "<string>"
  },
  "project": {
    "id": "<string>",
    "title": "<string>",
    "project_number": "<string>",
    "description": "<string>",
    "project_region": {
      "number": "<string>",
      "title": "<string>"
    },
    "legal_entity": {
      "number": "<string>",
      "title": "<string>"
    }
  },
  "invoice_accounts": [
    {
      "net_amount": 1000,
      "gross_amount": 1190,
      "tax_amount": 190,
      "account_type": "DEBIT",
      "comment": "<string>",
      "quantity": 10,
      "unit": "Stück",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project": {
        "id": "<string>",
        "title": "<string>",
        "project_number": "<string>"
      },
      "account": {
        "id": "<string>",
        "number": "<string>",
        "title": "<string>"
      },
      "tax_code": {
        "id": "<string>",
        "number": "<string>",
        "title": "<string>"
      }
    }
  ],
  "document": {
    "id": "<string>",
    "title": "<string>"
  },
  "comment": "<string>",
  "payment_terms": "<string>",
  "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discount_rate": 123,
  "discount_date": "2023-12-25",
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-16T14:30:00Z",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

GET

invoices

{id}

Rechnung abrufen

curl --request GET \
  --url https://api.comstruct.com/v1/invoices/{id} \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.comstruct.com/v1/invoices/{id}', 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/invoices/{id}",
  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/invoices/{id}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoices/{id}")

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": "123",
  "external_id": "EXT-123",
  "external_status": "EXPORTED",
  "invoice_number": "INV-2024-001",
  "invoice_date": "2024-01-15",
  "due_date": "2024-02-15",
  "receipt_date": "2023-11-07T05:31:56Z",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_number": "PRJ-2024-001",
  "supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supplier_name": "ABC Supplies Ltd.",
  "supplier_tax_id": "<string>",
  "supplier_iban": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "EUR",
  "net_amount": 1000,
  "total_tax_amount": 190,
  "total_amount": 1190,
  "deducted_net_amount": 800,
  "deducted_total_tax_amount": 152,
  "deducted_total_amount": 952,
  "tax_rate": 123,
  "status": "NEW",
  "document_type": "INVOICE",
  "electronic_invoice_type": "ZUGFERD",
  "down_payment_number": 123,
  "payment_reference": "RF18539007547034",
  "reference_type": "QRR",
  "payment_term": {
    "number": "<string>",
    "title": "<string>"
  },
  "region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legal_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_region": {
    "id": "<string>",
    "title": "<string>",
    "number": "<string>"
  },
  "legal_entity": {
    "id": "<string>",
    "title": "<string>",
    "number": "<string>"
  },
  "supplier": {
    "id": "<string>",
    "title": "<string>",
    "external_id": "<string>",
    "legal_uid": "<string>"
  },
  "project": {
    "id": "<string>",
    "title": "<string>",
    "project_number": "<string>",
    "description": "<string>",
    "project_region": {
      "number": "<string>",
      "title": "<string>"
    },
    "legal_entity": {
      "number": "<string>",
      "title": "<string>"
    }
  },
  "invoice_accounts": [
    {
      "net_amount": 1000,
      "gross_amount": 1190,
      "tax_amount": 190,
      "account_type": "DEBIT",
      "comment": "<string>",
      "quantity": 10,
      "unit": "Stück",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project": {
        "id": "<string>",
        "title": "<string>",
        "project_number": "<string>"
      },
      "account": {
        "id": "<string>",
        "number": "<string>",
        "title": "<string>"
      },
      "tax_code": {
        "id": "<string>",
        "number": "<string>",
        "title": "<string>"
      }
    }
  ],
  "document": {
    "id": "<string>",
    "title": "<string>"
  },
  "comment": "<string>",
  "payment_terms": "<string>",
  "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discount_rate": 123,
  "discount_date": "2023-12-25",
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-16T14:30:00Z",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Returns a single invoice by numeric ID. The payload matches a row from GET /invoices (including invoice_accounts, created_at, updated_at), without history or line items. Line items: GET /invoices/{id}/items. History: GET /invoices/{id}/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.

Path Parameters

integer

required

Rechnungs-ID (Integer). Die in Listenantworten zurückgegebene id ist ein String (z. B. "123"), kann aber direkt als Pfadparameter verwendet werden.

Response

Erfolgreich

string

Die eindeutige Kennung der Rechnung (numerischer String, der eine Integer-ID darstellt)

Pattern: ^[0-9]+$

Example:

"123"

external_id

string

Die externe Kennung der Rechnung

Example:

"EXT-123"

external_status

string | null

Freier Status aus einem externen System (gesetzt via PATCH /invoices/{id}/external-status).

Example:

"EXPORTED"

invoice_number

string

Die Rechnungsnummer

Example:

"INV-2024-001"

invoice_date

string<date>

Das Rechnungsdatum

Example:

"2024-01-15"

due_date

string<date>

Das Fälligkeitsdatum der Rechnung

Example:

"2024-02-15"

receipt_date

string<date-time>

Das Eingangsdatum der Rechnung

project_id

string<uuid>

Die Projektkennung

project_number

string

Die Projektnummer

Example:

"PRJ-2024-001"

supplier_id

string<uuid> | null

Die Lieferantenkennung

supplier_name

string

Der Name des Lieferanten

Example:

"ABC Supplies Ltd."

supplier_tax_id

string

Die Steuer-ID des Lieferanten

supplier_iban

string

Die IBAN des Lieferanten

customer_id

string<uuid>

Die Kundenkennung

currency

string

Die Rechnungswährung (ISO 4217-Code)

Example:

"EUR"

net_amount

number<double>

Der Nettobetrag der Rechnung

Example:

1000

total_tax_amount

number<double>

Der Gesamtsteuerbetrag der Rechnung

Example:

190

total_amount

number<double>

Der Gesamtbetrag der Rechnung

Example:

1190

deducted_net_amount

number<double> | null

Der abgezogene Nettobetrag der Rechnung

Example:

800

deducted_total_tax_amount

number<double> | null

Der abgezogene Gesamtsteuerbetrag der Rechnung

Example:

152

deducted_total_amount

number<double> | null

Der abgezogene Gesamtbetrag (brutto) der Rechnung

Example:

952

tax_rate

number<double>

Der Steuersatz der Rechnung

status

enum<string>

Der Rechnungsstatus

Available options:

NEW,

PROCESSING,

FACTUAL_CHECKING,

PRICE_CHECKING,

POSITIONS_CHECK,

CHECKED,

CANCELLED,

ERROR,

OPEN

Example:

"NEW"

document_type

string

Dokumenttyp (z.B. INVOICE, CREDIT_NOTE, DOWN_PAYMENT, FINAL_INVOICE, PAYMENT_REMINDER)

Example:

"INVOICE"

electronic_invoice_type

enum<string>

Typ der elektronischen Rechnung (falls zutreffend)

Available options:

ZUGFERD,

XRECHNUNG,

FACTURX

Example:

"ZUGFERD"

down_payment_number

number

Abschlagszahlungsnummer

payment_reference

string

Zahlungsreferenz (z.B. Schweizer QR-Rechnung Referenz)

Example:

"RF18539007547034"

reference_type

enum<string>

Typ der Zahlungsreferenz

Available options:

QRR,

SCOR,

NON

Example:

"QRR"

payment_term

object | null

Zahlungsbedingungsdetails

Show child attributes

region_id

string<uuid>

Die Regionskennung

legal_entity_id

string<uuid>

Die Gesellschaftskennung

project_region

object | null

Projektregion-Informationen

Show child attributes

legal_entity

object | null

Gesellschaftsinformationen

Show child attributes

supplier

object | null

Lieferanteninformationen

Show child attributes

project

object | null

Projektinformationen

Show child attributes

invoice_accounts

object[]

Rechnungskonten

Show child attributes

document

object | null

Dokumentinformationen

Show child attributes

comment

string

Ein optionaler Kommentar

payment_terms

string

Die Zahlungsbedingungen (Freitext)

payment_term_id

string<uuid> | null

Die Zahlungsbedingungskennung

discount_rate

number<double>

Der Skontosatz

discount_date

string<date>

Das Skontodatum

file_id

string<uuid>

Die Dateikennung für das Rechnungsdokument

created_at

string<date-time>

Der Erstellungszeitstempel der Rechnung

Example:

"2024-01-15T10:00:00Z"

updated_at

string<date-time>

Zeitstempel der letzten Aktualisierung der Rechnung (serverseitig)

Example:

"2024-01-16T14:30:00Z"

assignee_id

string<uuid> | null

Die ID des für die Rechnungsprüfung verantwortlichen Benutzers

Overview

Projects

Deliveries

Invoices

Invoice dimensions

Suppliers

Purchase orders

Orders (Supplier)

Master data

Q-Point Integration

Workflows

Calendar

IDS Orders

Authorizations

Path Parameters

Response