invoiceAPI-Referenz
GET
/v2/invoice/{id}/dataRechnungsdetails und Zahlungspositionen anzeigen
Liefert die gewählte Rechnung mit aktuellem bezahltem und manuell erstattbarem Betrag, Belegen, gespeicherten Rechnungsdaten, Zahlungen/Erstattungen und aufbereiteten Positionen. payment bezeichnet die ursprüngliche öffentliche pay-ID; Erstattungszeilen können eine refund-ID besitzen. Buchhaltungsmetadaten kennzeichnen externe Zuständigkeit.
Operation-ID get_v2_invoice_id_data
01
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Ja
GET-Verhalten laut Spezifikation
read
02
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}03
Parameter
Pfadparameter
iderforderlichv2 object identifier in the selected account.
string
Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.
- pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
"description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
"examples": [
"invoice_012345abcdef_123456"
]
}Query-Parameter
fieldsoptionalJSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.
application/json
array
Schema-Beispiel
[
"id"
]Array-Elemente
string
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"id"
]
]
}Beispiel
[
"id"
]filteroptionalJSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.
application/json
array
Schema-Beispiel
[
{
"property": "id",
"expression": "=",
"value": "invoice_012345abcdef_123456"
}
]Array-Elemente
object
property string expression string value Typ nicht eingeschränkt Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"expression": {
"type": "string"
},
"value": {}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"expression": "=",
"value": "invoice_012345abcdef_123456"
}
]
]
}Beispiel
[
{
"property": "id",
"expression": "=",
"value": "invoice_012345abcdef_123456"
}
]limitoptionalJSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.
application/json
object
Schema-Beispiel
{
"start": 0,
"reply": 25
}start integer - minimum
0
Standardwert: 0
reply integer - maximum
2000
Standardwert: 100
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"default": 0
},
"reply": {
"type": "integer",
"maximum": 2000,
"default": 100
}
},
"examples": [
{
"start": 0,
"reply": 25
}
]
}Beispiel
{
"start": 0,
"reply": 25
}orderoptionalJSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.
application/json
array
Schema-Beispiel
[
{
"property": "id",
"value": "ASC"
}
]Array-Elemente
object
property string value string Erlaubte Werte
"ASC""DESC"Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"value": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"value": "ASC"
}
]
]
}Beispiel
[
{
"property": "id",
"value": "ASC"
}
]response_typeoptionalControls generic collection representation; default is an ID-keyed object.
string
Erlaubte Werte
"array""object"Schema-Beispiel
"array"Vollständiges Schema als JSON
{
"type": "string",
"enum": [
"array",
"object"
],
"examples": [
"array"
]
}Header
languageoptionalAccount language code, where the resource supports setLanguage().
string
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}04
Request Body
Kein Request Body in der Spezifikation beschrieben.
05
Antworten
9HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
ID-indizierte Rechnungssammlung mit erweiterten Detailfeldern und limit-Metadaten.
application/json
object
success boolean error boolean | string error_code string data Typ nicht eingeschränkt Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste.
oneOf · Genau eine Variante muss passen
Variante 1 object Schema für zusätzliche Felder
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number amount_pay number currency string number string description string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"paytrans string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^paytrans_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"paytrans_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_payuntil Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_cancelled Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
status integer offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
offer_start_date_filtered Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
data object | array | null Optionales gespeichertes Rechnungsdatenobjekt bei fields=["data"]; Inhalt entspricht dem damaligen Rechnungsstand.
accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
amount_refundable_manual number receipt Typ nicht eingeschränkt Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste.
oneOf · Genau eine Variante muss passen
Variante 1 object Schema für zusätzliche Felder
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoicereceipt_012345abcdef_123456"invoice string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number currency string number string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
type string Erlaubte Werte
"receipt""cancel_receipt"data object | array | null offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoicereceipt_012345abcdef_123456"invoice string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number currency string number string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
type string Erlaubte Werte
"receipt""cancel_receipt"data object | array | null offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
invoice_data object | array | null pay Typ nicht eingeschränkt Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste.
oneOf · Genau eine Variante muss passen
Variante 1 object Schema für zusätzliche Felder
object
id string amount number currency string status integer date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system_id string payment string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"pay_012345abcdef_123456"is_refund boolean accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string amount number currency string status integer date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system_id string payment string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"pay_012345abcdef_123456"is_refund boolean accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
items object contained array | object Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen.
Array-Elemente
object
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Schema für zusätzliche Felder
object
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
amount number vat_included boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number amount_pay number currency string number string description string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"paytrans string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^paytrans_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"paytrans_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_payuntil Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
date_cancelled Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
status integer offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
offer_start_date_filtered Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
data object | array | null Optionales gespeichertes Rechnungsdatenobjekt bei fields=["data"]; Inhalt entspricht dem damaligen Rechnungsstand.
accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
amount_refundable_manual number receipt Typ nicht eingeschränkt Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste.
oneOf · Genau eine Variante muss passen
Variante 1 object Schema für zusätzliche Felder
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoicereceipt_012345abcdef_123456"invoice string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number currency string number string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
type string Erlaubte Werte
"receipt""cancel_receipt"data object | array | null offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoicereceipt_012345abcdef_123456"invoice string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"amount number currency string number string user string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"date_create Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
type string Erlaubte Werte
"receipt""cancel_receipt"data object | array | null offer_start_date Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
invoice_data object | array | null pay Typ nicht eingeschränkt Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste.
oneOf · Genau eine Variante muss passen
Variante 1 object Schema für zusätzliche Felder
object
id string amount number currency string status integer date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system_id string payment string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"pay_012345abcdef_123456"is_refund boolean accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string amount number currency string status integer date_pay Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 Typ nicht eingeschränkt Fester Wert: false
system_id string payment string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"pay_012345abcdef_123456"is_refund boolean accounting object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
items object contained array | object Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen.
Array-Elemente
object
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Schema für zusätzliche Felder
object
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
amount number vat_included boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"amount_pay": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"paytrans": {
"type": "string",
"pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"paytrans_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_payuntil": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_cancelled": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"status": {
"type": "integer"
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"offer_start_date_filtered": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"data": {
"description": "Optionales gespeichertes Rechnungsdatenobjekt bei fields=[\"data\"]; Inhalt entspricht dem damaligen Rechnungsstand.",
"type": [
"object",
"array",
"null"
]
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"amount_refundable_manual": {
"type": "number"
},
"receipt": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"invoice_data": {
"type": [
"object",
"array",
"null"
]
},
"pay": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"items": {
"type": "object",
"properties": {
"contained": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"additionalProperties": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen."
},
"amount": {
"type": "number"
},
"vat_included": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"amount_pay": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"paytrans": {
"type": "string",
"pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"paytrans_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_payuntil": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_cancelled": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"status": {
"type": "integer"
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"offer_start_date_filtered": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"data": {
"description": "Optionales gespeichertes Rechnungsdatenobjekt bei fields=[\"data\"]; Inhalt entspricht dem damaligen Rechnungsstand.",
"type": [
"object",
"array",
"null"
]
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"amount_refundable_manual": {
"type": "number"
},
"receipt": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"invoice_data": {
"type": [
"object",
"array",
"null"
]
},
"pay": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"items": {
"type": "object",
"properties": {
"contained": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"additionalProperties": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen."
},
"amount": {
"type": "number"
},
"vat_included": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": {
"invoice_012345abcdef_123456": {
"id": "invoice_012345abcdef_123456",
"amount": 120,
"amount_pay": 40,
"currency": "CHF",
"number": "INV-EXAMPLE",
"description": "Beispielkurs",
"user": "user_012345abcdef_123456",
"paytrans": "paytrans_012345abcdef_123456",
"date_create": "2026-10-15T10:00:00+02:00",
"date_payuntil": "2026-11-15T00:00:00+01:00",
"date_pay": false,
"date_cancelled": false,
"status": 1,
"amount_refundable_manual": 40,
"receipt": [],
"invoice_data": null,
"pay": [],
"items": {
"contained": [],
"amount": 120,
"vat_included": true
}
}
}
}400application/json
Invalid request.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40006"
}401application/json
Missing/expired token, missing account context, account paused or model-specific authorization failure.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40103"
}402application/json
Missing/invalid action data or subscription/operation restriction.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80100"
}403application/json
Permission denied. Browser CORS rejection may have an empty body.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40340"
}404application/json
Unknown resource/action or unsupported method.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}422application/json
Validation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80020"
}429application/json
Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.
Response Header
Retry-After
Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.
string
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED42902"
}502application/json
Server-side operation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}06
Quelle & Metadaten
Quelle laut Spezifikation
application/models/v2/Invoice.php:443getInvoice()Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.
x-edoobox-mutates-state
falsex-edoobox-get-effect
"read"x-edoobox-get-permission-review
{
"file": "docs/openapi/reviews/vue-get-permission-02.json",
"pointer": "/operations/18",
"sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}x-edoobox-mutationReview
{
"source": {
"file": "application/config/config.php",
"line": 258,
"reason": "APIPermissions resource mapping to invo.",
"sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82"
},
"reason": "Reads invoice-linked transaction/payment snapshots and formats a structured data response.",
"review": {
"file": "docs/openapi/reviews/vue-get-permission-02.json",
"pointer": "/operations/18",
"sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
}x-edoobox-runtimeMutationGuard
falsex-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/04-accounting.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Invoice.php",
"method": "getInvoice",
"line": 443,
"branch": {
"file": "application/models/v2/Invoice.php",
"line": 735
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "invoice",
"short": "invo",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}Vollständige Operation als JSON
{
"operationId": "get_v2_invoice_id_data",
"summary": "Rechnungsdetails und Zahlungspositionen anzeigen",
"description": "Liefert die gewählte Rechnung mit aktuellem bezahltem und manuell erstattbarem Betrag, Belegen, gespeicherten Rechnungsdaten, Zahlungen/Erstattungen und aufbereiteten Positionen. payment bezeichnet die ursprüngliche öffentliche pay-ID; Erstattungszeilen können eine refund-ID besitzen. Buchhaltungsmetadaten kennzeichnen externe Zuständigkeit.",
"tags": [
"invoice"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "v2 object identifier in the selected account.",
"schema": {
"type": "string",
"pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
"description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
"examples": [
"invoice_012345abcdef_123456"
]
}
},
{
"name": "fields",
"in": "query",
"required": false,
"description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"id"
]
]
},
"example": [
"id"
]
}
}
},
{
"name": "filter",
"in": "query",
"required": false,
"description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"expression": {
"type": "string"
},
"value": {}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"expression": "=",
"value": "invoice_012345abcdef_123456"
}
]
]
},
"example": [
{
"property": "id",
"expression": "=",
"value": "invoice_012345abcdef_123456"
}
]
}
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"default": 0
},
"reply": {
"type": "integer",
"maximum": 2000,
"default": 100
}
},
"examples": [
{
"start": 0,
"reply": 25
}
]
},
"example": {
"start": 0,
"reply": 25
}
}
}
},
{
"name": "order",
"in": "query",
"required": false,
"description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"value": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"value": "ASC"
}
]
]
},
"example": [
{
"property": "id",
"value": "ASC"
}
]
}
}
},
{
"name": "response_type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"array",
"object"
],
"examples": [
"array"
]
},
"description": "Controls generic collection representation; default is an ID-keyed object."
},
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
}
],
"responses": {
"200": {
"description": "ID-indizierte Rechnungssammlung mit erweiterten Detailfeldern und limit-Metadaten.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": {
"invoice_012345abcdef_123456": {
"id": "invoice_012345abcdef_123456",
"amount": 120,
"amount_pay": 40,
"currency": "CHF",
"number": "INV-EXAMPLE",
"description": "Beispielkurs",
"user": "user_012345abcdef_123456",
"paytrans": "paytrans_012345abcdef_123456",
"date_create": "2026-10-15T10:00:00+02:00",
"date_payuntil": "2026-11-15T00:00:00+01:00",
"date_pay": false,
"date_cancelled": false,
"status": 1,
"amount_refundable_manual": 40,
"receipt": [],
"invoice_data": null,
"pay": [],
"items": {
"contained": [],
"amount": 120,
"vat_included": true
}
}
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"amount_pay": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"paytrans": {
"type": "string",
"pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"paytrans_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_payuntil": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_cancelled": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"status": {
"type": "integer"
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"offer_start_date_filtered": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"data": {
"description": "Optionales gespeichertes Rechnungsdatenobjekt bei fields=[\"data\"]; Inhalt entspricht dem damaligen Rechnungsstand.",
"type": [
"object",
"array",
"null"
]
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"amount_refundable_manual": {
"type": "number"
},
"receipt": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"invoice_data": {
"type": [
"object",
"array",
"null"
]
},
"pay": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"items": {
"type": "object",
"properties": {
"contained": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"additionalProperties": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen."
},
"amount": {
"type": "number"
},
"vat_included": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"amount_pay": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"paytrans": {
"type": "string",
"pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"paytrans_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_payuntil": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"date_cancelled": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"status": {
"type": "integer"
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"offer_start_date_filtered": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"data": {
"description": "Optionales gespeichertes Rechnungsdatenobjekt bei fields=[\"data\"]; Inhalt entspricht dem damaligen Rechnungsstand.",
"type": [
"object",
"array",
"null"
]
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"amount_refundable_manual": {
"type": "number"
},
"receipt": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^invoicereceipt_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoicereceipt_012345abcdef_123456"
]
},
"invoice": {
"type": "string",
"pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"invoice_012345abcdef_123456"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"number": {
"type": "string"
},
"user": {
"type": "string",
"pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"user_012345abcdef_123456"
]
},
"date_create": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"type": {
"type": "string",
"enum": [
"receipt",
"cancel_receipt"
]
},
"data": {
"type": [
"object",
"array",
"null"
]
},
"offer_start_date": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"invoice_data": {
"type": [
"object",
"array",
"null"
]
},
"pay": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "integer"
},
"date_pay": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"const": false
}
]
},
"system_id": {
"type": "string"
},
"payment": {
"type": "string",
"pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"pay_012345abcdef_123456"
]
},
"is_refund": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"items": {
"type": "object",
"properties": {
"contained": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"additionalProperties": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Rechnungspositionen (t_booking/t_manualtrans/t_membership) mit Beträgen, MwSt und je nach Typ öffentlichen Verknüpfungen."
},
"amount": {
"type": "number"
},
"vat_included": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
],
"description": "Standard: nach öffentlicher ID indiziertes Objekt; response_type=array liefert eine Liste."
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40006"
}
}
}
},
"401": {
"description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40103"
}
}
}
},
"402": {
"description": "Missing/invalid action data or subscription/operation restriction.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80100"
}
}
}
},
"403": {
"description": "Permission denied. Browser CORS rejection may have an empty body.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40340"
}
}
}
},
"404": {
"description": "Unknown resource/action or unsupported method.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80019"
}
}
}
},
"422": {
"description": "Validation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80020"
}
}
}
},
"429": {
"description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED42902"
}
}
},
"headers": {
"Retry-After": {
"description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
"schema": {
"type": "string",
"examples": [
"30"
]
}
}
}
},
"502": {
"description": "Server-side operation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED50201"
}
}
}
}
},
"x-edoobox-mutates-state": false,
"x-edoobox-get-effect": "read",
"x-edoobox-get-permission-review": {
"file": "docs/openapi/reviews/vue-get-permission-02.json",
"pointer": "/operations/18",
"sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
},
"x-edoobox-mutationReview": {
"source": {
"file": "application/config/config.php",
"line": 258,
"reason": "APIPermissions resource mapping to invo.",
"sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82"
},
"reason": "Reads invoice-linked transaction/payment snapshots and formats a structured data response.",
"review": {
"file": "docs/openapi/reviews/vue-get-permission-02.json",
"pointer": "/operations/18",
"sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
},
"x-edoobox-runtimeMutationGuard": false,
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/04-accounting.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Invoice.php",
"method": "getInvoice",
"line": 443,
"branch": {
"file": "application/models/v2/Invoice.php",
"line": 735
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "invoice",
"short": "invo",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
}