accountingAPI-Referenz
GET
/v2/accounting/connections/{connectionId}Buchhaltungsverbindung prüfen
Liefert eine Buchhaltungsverbindung des aktuellen Kontos einschließlich Einstellungen, Synchronisationszeitpunkt und Gesundheitsstatus.
Operation-ID get_v2_accounting_connections_connectionId
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
connectionIderforderlichVerbindungs-ID aus connections, im aktuellen Konto.
string
Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^accountingconnection_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"accountingconnection_012345abcdef_123456"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^accountingconnection_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"accountingconnection_012345abcdef_123456"
]
}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
Objekt mit connection.
application/json
object
success boolean error boolean | string error_code string data object connection object id string Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.
- pattern
"^accountingconnection_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"accountingconnection_012345abcdef_123456"provider string status string company object id string name string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
scopes array Array-Elemente
string
settings object automatic_invoice boolean | string | number | null PHP-Bool-Normalisierung; Standard false.
document_mode string Getrimmt und kleingeschrieben; draft, issue oder send.
payment_sync_inbound boolean | string | number | null PHP-Bool-Normalisierung; Standard false.
payment_sync_outbound boolean | string | number | null PHP-Bool-Normalisierung; Standard false.
position_strategy string Getrimmt und kleingeschrieben; custom oder article.
contact_field_mapping object salutation string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"first_name string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"last_name string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"street string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"house_number string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"address_addition string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"postal_code string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"city string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"country string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"email string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"phone string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"mobile string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"remarks string Erlaubte Werte
"""gender""first_name""last_name""street""postcode""location""country""email""phone_number""company""data_1""data_2""data_3""data_4""data_5""data_6""data_7""data_8""data_9""data_10""data_11""data_12""data_13""data_14""data_15""data_16""data_17""data_18""data_19""data_20""data_21""data_22""data_23""data_24""data_25""data_26""data_27""data_28""data_29""data_30"Zusätzliche Felder sind in diesem Teilschema ausgeschlossen.
send object subject string - maxLength
255
message string - maxLength
20000
mark_as_open boolean | string | number | null PHP-Bool-Normalisierung; Standard true.
attach_pdf boolean | string | number | null PHP-Bool-Normalisierung; Standard true.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
connected_at Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 null token_expires_at Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 null last_sync_at Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 null health object last_check_at Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 string Variante 2 null last_error string last_error_code string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
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": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^accountingconnection_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"accountingconnection_012345abcdef_123456"
]
},
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": true
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"settings": {
"type": "object",
"properties": {
"automatic_invoice": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"document_mode": {
"type": "string",
"description": "Getrimmt und kleingeschrieben; draft, issue oder send."
},
"payment_sync_inbound": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"payment_sync_outbound": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"position_strategy": {
"type": "string",
"description": "Getrimmt und kleingeschrieben; custom oder article."
},
"contact_field_mapping": {
"type": "object",
"properties": {
"salutation": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"first_name": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"last_name": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"street": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"house_number": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"address_addition": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"postal_code": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"city": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"country": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"email": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"phone": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"mobile": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"remarks": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
}
},
"additionalProperties": false
},
"send": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 20000
},
"mark_as_open": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard true."
},
"attach_pdf": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard true."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"connected_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"token_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_sync_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"health": {
"type": "object",
"properties": {
"last_check_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_error": {
"type": "string"
},
"last_error_code": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": {
"connection": {
"id": "accountingconnection_012345abcdef_123456",
"provider": "bexio",
"status": "active",
"company": {
"id": "example-company",
"name": "Beispielfirma"
},
"scopes": []
}
}
}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/Accounting.php:124getAccounting()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-01.json",
"pointer": "/operations/1",
"sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}x-edoobox-mutationReview
{
"source": {
"file": "application/models/v2/Accounting.php",
"line": 124,
"lineEnd": 146,
"sha256": "c25cea041fb9c7d25c4a7a3ce96dc4a52e63dc670656ac8217388333d31ff161",
"reason": "Feature rollout gates the connections dispatcher."
},
"reason": "Reads a saved connection scoped to the current account.",
"review": {
"file": "docs/openapi/reviews/vue-get-permission-01.json",
"pointer": "/operations/1",
"sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
"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/Accounting.php",
"method": "getAccounting",
"line": 124
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "accounting",
"short": "acco",
"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_accounting_connections_connectionId",
"summary": "Buchhaltungsverbindung prüfen",
"description": "Liefert eine Buchhaltungsverbindung des aktuellen Kontos einschließlich Einstellungen, Synchronisationszeitpunkt und Gesundheitsstatus.",
"tags": [
"accounting"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "connectionId",
"in": "path",
"required": true,
"description": "Verbindungs-ID aus connections, im aktuellen Konto.",
"schema": {
"type": "string",
"pattern": "^accountingconnection_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"accountingconnection_012345abcdef_123456"
]
}
},
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
}
],
"responses": {
"200": {
"description": "Objekt mit connection.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": {
"connection": {
"id": "accountingconnection_012345abcdef_123456",
"provider": "bexio",
"status": "active",
"company": {
"id": "example-company",
"name": "Beispielfirma"
},
"scopes": []
}
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^accountingconnection_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
"examples": [
"accountingconnection_012345abcdef_123456"
]
},
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": true
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"settings": {
"type": "object",
"properties": {
"automatic_invoice": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"document_mode": {
"type": "string",
"description": "Getrimmt und kleingeschrieben; draft, issue oder send."
},
"payment_sync_inbound": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"payment_sync_outbound": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard false."
},
"position_strategy": {
"type": "string",
"description": "Getrimmt und kleingeschrieben; custom oder article."
},
"contact_field_mapping": {
"type": "object",
"properties": {
"salutation": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"first_name": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"last_name": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"street": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"house_number": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"address_addition": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"postal_code": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"city": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"country": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"email": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"phone": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"mobile": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
},
"remarks": {
"type": "string",
"enum": [
"",
"gender",
"first_name",
"last_name",
"street",
"postcode",
"location",
"country",
"email",
"phone_number",
"company",
"data_1",
"data_2",
"data_3",
"data_4",
"data_5",
"data_6",
"data_7",
"data_8",
"data_9",
"data_10",
"data_11",
"data_12",
"data_13",
"data_14",
"data_15",
"data_16",
"data_17",
"data_18",
"data_19",
"data_20",
"data_21",
"data_22",
"data_23",
"data_24",
"data_25",
"data_26",
"data_27",
"data_28",
"data_29",
"data_30"
]
}
},
"additionalProperties": false
},
"send": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 20000
},
"mark_as_open": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard true."
},
"attach_pdf": {
"type": [
"boolean",
"string",
"number",
"null"
],
"description": "PHP-Bool-Normalisierung; Standard true."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"connected_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"token_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_sync_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"health": {
"type": "object",
"properties": {
"last_check_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_error": {
"type": "string"
},
"last_error_code": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"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-01.json",
"pointer": "/operations/1",
"sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
"scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
},
"x-edoobox-mutationReview": {
"source": {
"file": "application/models/v2/Accounting.php",
"line": 124,
"lineEnd": 146,
"sha256": "c25cea041fb9c7d25c4a7a3ce96dc4a52e63dc670656ac8217388333d31ff161",
"reason": "Feature rollout gates the connections dispatcher."
},
"reason": "Reads a saved connection scoped to the current account.",
"review": {
"file": "docs/openapi/reviews/vue-get-permission-01.json",
"pointer": "/operations/1",
"sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
"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/Accounting.php",
"method": "getAccounting",
"line": 124
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "accounting",
"short": "acco",
"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."
}
}