Version: 2026-11-07. Vollständige REST-Referenz von Summator. Die API liegt auf der Domain deiner Firma unter /api/v1. Zugang und erste Schritte stehen auf der Seite API-Referenz von summator.de.
POST /api/v1/partners — Personenkonto und damit Kontakt anlegen
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_partners",
"summary": "Personenkonto und damit Kontakt anlegen",
"tags": [
"partners"
],
"responses": {
"201": {
"description": "Personenkonto und damit Kontakt anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Partner"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültige Angaben oder Kontonummer",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"number": {
"anyOf": [
{
"type": "integer",
"minimum": 10000,
"maximum": 99999
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"kind"
],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "partner.create",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/partners — Personenkonten suchen
{
"operationId": "get_api_v1_partners",
"summary": "Personenkonten suchen",
"tags": [
"partners"
],
"responses": {
"200": {
"description": "Personenkonten suchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"personal_kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"type": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"number",
"name",
"personal_kind",
"type",
"is_active"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"default": 100
}
}
]
}GET /api/v1/contacts — Kontakte mit offenen Beträgen suchen
{
"operationId": "get_api_v1_contacts",
"summary": "Kontakte mit offenen Beträgen suchen",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Kontakte mit offenen Beträgen suchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"is_active": {
"type": "boolean"
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"vat_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buyer_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"country": {
"type": "string"
},
"intro_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"laut_rechnung_bezahlt_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"id",
"number",
"name",
"kind",
"is_active",
"street",
"postal_code",
"city",
"email",
"vat_id",
"buyer_reference",
"note",
"country",
"intro_text_id",
"closing_text_id",
"open_cents",
"laut_rechnung_bezahlt_cents"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
}
]
}PATCH /api/v1/contacts/{id} — Angegebene Kontaktfelder ändern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_contacts_id",
"summary": "Angegebene Kontaktfelder ändern",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Angegebene Kontaktfelder ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Contact"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Kein Personenkonto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder ungeeignete Textvorgabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"street": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string",
"maxLength": 16
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 2
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email",
"maxLength": 200
},
{
"type": "null"
}
]
},
"vat_id": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"buyer_reference": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"intro_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/contacts/{id} — Kontakt einschließlich Rechnungen, Buchungen und Preisverlauf lesen
{
"operationId": "get_api_v1_contacts_id",
"summary": "Kontakt einschließlich Rechnungen, Buchungen und Preisverlauf lesen",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Kontakt einschließlich Rechnungen, Buchungen und Preisverlauf lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"is_active": {
"type": "boolean"
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"vat_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buyer_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"country": {
"type": "string"
},
"intro_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"laut_rechnung_bezahlt_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"open_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OpenItem"
}
},
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"invoice_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"gross_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"id",
"number",
"status",
"invoice_date",
"gross_cents"
],
"additionalProperties": false
}
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"journal_entry_id": {
"type": "integer",
"minimum": 1
},
"entry_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"booking_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"debit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"credit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"journal_entry_id",
"entry_number",
"status",
"booking_date",
"description",
"debit_cents",
"credit_cents"
],
"additionalProperties": false
}
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"article_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string"
},
"current_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"valid_from": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"valid_from",
"amount_cents",
"note"
],
"additionalProperties": false
}
}
},
"required": [
"article_id",
"label",
"unit",
"current_cents",
"history"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"number",
"name",
"kind",
"is_active",
"street",
"postal_code",
"city",
"email",
"vat_id",
"buyer_reference",
"note",
"country",
"intro_text_id",
"closing_text_id",
"open_cents",
"laut_rechnung_bezahlt_cents",
"open_items",
"invoices",
"entries",
"prices"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Kein Personenkonto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/invoices — Rechnungen seitenweise lesen
{
"operationId": "get_api_v1_invoices",
"summary": "Rechnungen seitenweise lesen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Rechnungen seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceSummary"
}
},
"meta": {
"$ref": "#/components/schemas/PageMeta"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"default": 25
}
}
]
}POST /api/v1/invoices — Unnummerierten Rechnungsentwurf anlegen
Keine Nummer, kein Original und keine Journalbuchung. Für Kontakte zuerst POST /partners und PATCH /contacts/{id}. Kreditkorrekturen entstehen ausschließlich über reverse. Ein Entwurf darf unvollständig sein; missing vor Ausstellung lesen. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_invoices",
"summary": "Unnummerierten Rechnungsentwurf anlegen",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Unnummerierten Rechnungsentwurf anlegen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Keine Nummer, kein Original und keine Journalbuchung. Für Kontakte zuerst POST /partners und PATCH /contacts/{id}. Kreditkorrekturen entstehen ausschließlich über reverse. Ein Entwurf darf unvollständig sein; missing vor Ausstellung lesen. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceCreate"
}
}
}
},
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "invoice.create",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/invoices/{id} — Rechnung einschließlich Positionen und Hinweisen lesen
{
"operationId": "get_api_v1_invoices_id",
"summary": "Rechnung einschließlich Positionen und Hinweisen lesen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Rechnung einschließlich Positionen und Hinweisen lesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PUT /api/v1/invoices/{id} — Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "put_api_v1_invoices_id",
"summary": "Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ausgestellt, ungültige Angaben oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceUpdate"
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}PATCH /api/v1/invoices/{id} — Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_invoices_id",
"summary": "Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Angegebene Entwurfsfelder ändern; lines ersetzt alle Positionen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ausgestellt, ungültige Angaben oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceUpdate"
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}DELETE /api/v1/invoices/{id} — Nur Rechnungsentwurf bewusst verwerfen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_invoices_id",
"summary": "Nur Rechnungsentwurf bewusst verwerfen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Nur Rechnungsentwurf bewusst verwerfen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ausgestellte Rechnung bleibt erhalten",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}POST /api/v1/invoices/{id}/issue — Bewusst endgültig ausstellen: Nummer, Original und Buchung
Endgültige Wirkung. expected_draft_hash aus dem zuletzt geprüften GET senden. Abgelaufene Voranmeldungsperiode liefert 422 mit period; nur nach bewusster Zustimmung erneut confirm_past_period=true. Ein geschlossener Zeitraum wird dadurch nicht geöffnet. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_invoices_id_issue",
"summary": "Bewusst endgültig ausstellen: Nummer, Original und Buchung",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Bewusst endgültig ausstellen: Nummer, Original und Buchung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Pflichtangaben, veralteter Entwurf, geschlossener Zeitraum oder period-Bestätigung erforderlich",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Endgültige Wirkung. expected_draft_hash aus dem zuletzt geprüften GET senden. Abgelaufene Voranmeldungsperiode liefert 422 mit period; nur nach bewusster Zustimmung erneut confirm_past_period=true. Ein geschlossener Zeitraum wird dadurch nicht geöffnet. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirm_past_period": {
"type": "boolean"
},
"expected_draft_hash": {
"type": "string",
"minLength": 64,
"maxLength": 64
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "invoice.issue",
"key_required": false,
"contract": "summator-idempotency/1"
}
}POST /api/v1/invoices/{id}/reverse — Korrekturrechnung zur ausgestellten Rechnung erzeugen
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden. Die Korrektur mindert die Voranmeldung sofort. Wurde die Leistung gar nicht ausgeführt, kann die Steuer geschuldet bleiben, bis das Finanzamt dem schriftlichen Antrag zugestimmt hat (§ 14c Abs. 2 UStG).
{
"operationId": "post_api_v1_invoices_id_reverse",
"summary": "Korrekturrechnung zur ausgestellten Rechnung erzeugen",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Korrekturrechnung zur ausgestellten Rechnung erzeugen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Korrektur nicht zulässig",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden. Die Korrektur mindert die Voranmeldung sofort. Wurde die Leistung gar nicht ausgeführt, kann die Steuer geschuldet bleiben, bis das Finanzamt dem schriftlichen Antrag zugestimmt hat (§ 14c Abs. 2 UStG).",
"x-idempotency": {
"operation": "invoice.reverse",
"key_required": false,
"contract": "summator-idempotency/1"
}
}POST /api/v1/invoices/{id}/settle — Laut Rechnung bezahlte Forderung bewusst nachbuchen
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_invoices_id_settle",
"summary": "Laut Rechnung bezahlte Forderung bewusst nachbuchen",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Laut Rechnung bezahlte Forderung bewusst nachbuchen",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Invoice"
},
{
"type": "object",
"properties": {
"settlement": {
"type": "object",
"properties": {
"journal_entry_id": {
"type": "integer",
"minimum": 1
},
"entry_number": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"clearing_account_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"journal_entry_id",
"entry_number",
"booking_date",
"amount_cents",
"clearing_account_id"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"settlement"
]
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Periodenbestätigung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"clearing_account_id": {
"type": "integer",
"minimum": 1
},
"booking_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"confirm_past_period": {
"type": "boolean"
}
},
"required": [
"clearing_account_id"
],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"x-idempotency": {
"operation": "invoice.settle",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/invoices/{id}/file — Exakt gespeichertes Original oder eingebettetes CII herunterladen
{
"operationId": "get_api_v1_invoices_id_file",
"summary": "Exakt gespeichertes Original oder eingebettetes CII herunterladen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Exakt gespeichertes Original oder eingebettetes CII herunterladen",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Entwurf, Datei fehlt oder Prüfsumme falsch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"xml"
]
},
"description": "Ohne xml: gespeichertes PDF oder historisches XML; xml: exakter eingebetteter CII-Datensatz."
}
]
}GET /api/v1/accounts — Aktive Konten suchen; vollständige Seitenzahl beachten
{
"operationId": "get_api_v1_accounts",
"summary": "Aktive Konten suchen; vollständige Seitenzahl beachten",
"tags": [
"accounts"
],
"responses": {
"200": {
"description": "Aktive Konten suchen; vollständige Seitenzahl beachten",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"pages": {
"type": "integer"
}
},
"required": [
"page",
"per_page",
"total",
"pages"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "chart",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "common",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 500,
"default": 100
},
"description": "Für eine gültige Seite 1 bis 500 senden."
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
}
}
]
}POST /api/v1/accounts — Eigenes Sachkonto im Mandantenrahmen anlegen
10000–99999 für Kontakte reserviert. Template-Art muss passen, BANK-Konten über Bankablauf. Kennziffer: revenue 21/41/43/45/48, asset 62; nur meldepflichtig. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_accounts",
"summary": "Eigenes Sachkonto im Mandantenrahmen anlegen",
"tags": [
"accounts"
],
"responses": {
"201": {
"description": "Eigenes Sachkonto im Mandantenrahmen anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
}
},
"required": [
"id",
"number",
"name",
"type",
"chart"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "10000–99999 für Kontakte reserviert. Template-Art muss passen, BANK-Konten über Bankablauf. Kennziffer: revenue 21/41/43/45/48, asset 62; nur meldepflichtig. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "string",
"pattern": "^[0-9]+$",
"maxLength": 16
},
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"type": {
"type": "string",
"enum": [
"asset",
"liability",
"equity",
"revenue",
"expense"
]
},
"category": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
]
},
"vat_box": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{2,3}$"
},
{
"type": "null"
}
]
},
"vat_reportable": {
"type": "boolean"
},
"chart": {
"type": "string",
"enum": [
"SKR03",
"SKR04"
]
}
},
"required": [
"number",
"name",
"type"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/tax-keys — Aktive Steuerschlüssel lesen
{
"operationId": "get_api_v1_tax_keys",
"summary": "Aktive Steuerschlüssel lesen",
"tags": [
"tax-keys"
],
"responses": {
"200": {
"description": "Aktive Steuerschlüssel lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxKey"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}POST /api/v1/anmelden — Zentrale Passwortanmeldung und Mandantenwahl
{
"operationId": "post_api_v1_anmelden",
"summary": "Zentrale Passwortanmeldung und Mandantenwahl",
"tags": [
"anmelden"
],
"responses": {
"200": {
"description": "Zentrale Passwortanmeldung und Mandantenwahl",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"mandanten": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"mandanten"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mandant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"api": {
"type": "string",
"format": "uri"
},
"handoff": {
"type": "string"
},
"zwei_faktor": {
"type": "object",
"properties": {
"erforderlich": {
"const": true
},
"eingerichtet": {
"type": "boolean"
}
},
"required": [
"erforderlich",
"eingerichtet"
],
"additionalProperties": false
}
},
"required": [
"mandant",
"api",
"handoff",
"zwei_faktor"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "Zugangsdaten falsch oder zu viele Versuche",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string",
"writeOnly": true
},
"mandant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"email",
"password"
],
"additionalProperties": false
}
}
}
},
"servers": [
{
"url": "{centralOrigin}",
"variables": {
"centralOrigin": {
"default": "https://summator.example",
"description": "Konfigurierte zentrale Domain, keine Mandantenadresse"
}
}
}
]
}POST /api/v1/token — Einmaligen 60-Sekunden-Handoff plus TOTP gegen App-Token tauschen
{
"operationId": "post_api_v1_token",
"summary": "Einmaligen 60-Sekunden-Handoff plus TOTP gegen App-Token tauschen",
"tags": [
"token"
],
"responses": {
"201": {
"description": "Einmaligen 60-Sekunden-Handoff plus TOTP gegen App-Token tauschen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Handoff abgelaufen, Faktor fehlt oder Code falsch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "10 je Minute/IP",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"handoff": {
"type": "string",
"writeOnly": true
},
"geraet": {
"type": "string",
"maxLength": 100
},
"code": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"writeOnly": true
},
{
"type": "null"
}
]
}
},
"required": [
"handoff",
"geraet"
],
"additionalProperties": false
}
}
}
}
}DELETE /api/v1/token — Aktuell benutztes Token widerrufen
{
"operationId": "delete_api_v1_token",
"summary": "Aktuell benutztes Token widerrufen",
"tags": [
"token"
],
"responses": {
"204": {
"description": "Aktuell benutztes Token widerrufen"
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}GET /api/v1/api-keys — Sichtbare gültige eigene Schlüssel, mit admin als Inhaber alle lesen
{
"operationId": "get_api_v1_api_keys",
"summary": "Sichtbare gültige eigene Schlüssel, mit admin als Inhaber alle lesen",
"tags": [
"api-keys"
],
"responses": {
"200": {
"description": "Sichtbare gültige eigene Schlüssel, mit admin als Inhaber alle lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}DELETE /api/v1/api-keys/{id} — Sichtbaren Schlüssel widerrufen; eigenen auch mit read
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_api_keys_id",
"summary": "Sichtbaren Schlüssel widerrufen; eigenen auch mit read",
"tags": [
"api-keys"
],
"responses": {
"204": {
"description": "Sichtbaren Schlüssel widerrufen; eigenen auch mit read"
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Schlüssel nicht sichtbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/rates — Preishistorie lesen
{
"operationId": "get_api_v1_rates",
"summary": "Preishistorie lesen",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Preishistorie lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rate"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "account_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "article_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/rates — Neue datierte Preisvereinbarung anhängen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_rates",
"summary": "Neue datierte Preisvereinbarung anhängen",
"tags": [
"rates"
],
"responses": {
"201": {
"description": "Neue datierte Preisvereinbarung anhängen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rate"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"article_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"amount_cents": {
"type": "integer",
"minimum": 0
},
"valid_from": {
"type": "string",
"format": "date"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"amount_cents",
"valid_from"
],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/rates/current — Gültigen Preis an einem Tag lesen
{
"operationId": "get_api_v1_rates_current",
"summary": "Gültigen Preis an einem Tag lesen",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Gültigen Preis an einem Tag lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"rate": {
"anyOf": [
{
"$ref": "#/components/schemas/Rate"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"date",
"rate"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "account_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
{
"name": "article_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
{
"name": "label",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
{
"name": "unit",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 3,
"maxLength": 3
}
},
{
"name": "date",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
]
}DELETE /api/v1/rates/{id} — Noch nicht vergangene Preisvereinbarung entfernen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_rates_id",
"summary": "Noch nicht vergangene Preisvereinbarung entfernen",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Noch nicht vergangene Preisvereinbarung entfernen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Bereits gültig gewesener Preis bleibt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/articles — Artikel mit aktuellem Standardpreis suchen
{
"operationId": "get_api_v1_articles",
"summary": "Artikel mit aktuellem Standardpreis suchen",
"tags": [
"articles"
],
"responses": {
"200": {
"description": "Artikel mit aktuellem Standardpreis suchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string"
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"current_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"name",
"description",
"unit",
"tax_key_id",
"revenue_account_id",
"is_active",
"closing_text_id",
"current_cents"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"name": "active",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "true: aktive Artikel; ohne true auch deaktivierte."
}
]
}POST /api/v1/articles — Artikel anlegen
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_articles",
"summary": "Artikel anlegen",
"tags": [
"articles"
],
"responses": {
"201": {
"description": "Artikel anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Article"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 200
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "article.create",
"key_required": false,
"contract": "summator-idempotency/1"
}
}PATCH /api/v1/articles/{id} — Angegebene Artikelstammdaten ändern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_articles_id",
"summary": "Angegebene Artikelstammdaten ändern",
"tags": [
"articles"
],
"responses": {
"200": {
"description": "Angegebene Artikelstammdaten ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Article"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 200
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/articles/{id} — Artikel mit Preis- und Verwendungshistorie lesen
{
"operationId": "get_api_v1_articles_id",
"summary": "Artikel mit Preis- und Verwendungshistorie lesen",
"tags": [
"articles"
],
"responses": {
"200": {
"description": "Artikel mit Preis- und Verwendungshistorie lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string"
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"current_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"valid_from": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"valid_from",
"amount_cents",
"note"
],
"additionalProperties": false
}
},
"customer_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"account": {
"type": "string"
},
"current_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"valid_from": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"valid_from",
"amount_cents",
"note"
],
"additionalProperties": false
}
}
},
"required": [
"account_id",
"account",
"current_cents",
"history"
],
"additionalProperties": false
}
},
"invoice_lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"minimum": 1
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"quantity": {
"type": "number"
},
"unit_price_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"invoice_id",
"invoice_number",
"status",
"description",
"quantity",
"unit_price_cents"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"number",
"name",
"description",
"unit",
"tax_key_id",
"revenue_account_id",
"is_active",
"closing_text_id",
"current_cents",
"prices",
"customer_prices",
"invoice_lines"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/closing-texts — Aktive closing-Textvorlagen lesen
{
"operationId": "get_api_v1_closing_texts",
"summary": "Aktive closing-Textvorlagen lesen",
"tags": [
"closing-texts"
],
"responses": {
"200": {
"description": "Aktive closing-Textvorlagen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClosingText"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Nur active=all oder weglassen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "active",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"all"
]
}
}
]
}POST /api/v1/closing-texts — closing-Textvorlage speichern
Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_closing_texts",
"summary": "closing-Textvorlage speichern",
"tags": [
"closing-texts"
],
"responses": {
"201": {
"description": "closing-Textvorlage speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ClosingText"
},
"hints": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"hints"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Vorlage nicht in dieser Art",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben oder Text-/Zahlungsvorgabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80
},
"text": {
"type": "string",
"maxLength": 2000
},
"paid_means": {
"anyOf": [
{
"type": "string",
"enum": [
"online"
]
},
{
"type": "null"
}
]
},
"paid_via": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"clearing_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_default": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name",
"text"
],
"additionalProperties": false
}
}
}
}
}PATCH /api/v1/closing-texts/{id} — closing-Textvorlage speichern
Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_closing_texts_id",
"summary": "closing-Textvorlage speichern",
"tags": [
"closing-texts"
],
"responses": {
"200": {
"description": "closing-Textvorlage speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ClosingText"
},
"hints": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"hints"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Vorlage nicht in dieser Art",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben oder Text-/Zahlungsvorgabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80
},
"text": {
"type": "string",
"maxLength": 2000
},
"paid_means": {
"anyOf": [
{
"type": "string",
"enum": [
"online"
]
},
{
"type": "null"
}
]
},
"paid_via": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"clearing_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_default": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}GET /api/v1/intro-texts — Aktive intro-Textvorlagen lesen
{
"operationId": "get_api_v1_intro_texts",
"summary": "Aktive intro-Textvorlagen lesen",
"tags": [
"intro-texts"
],
"responses": {
"200": {
"description": "Aktive intro-Textvorlagen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntroText"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Nur active=all oder weglassen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "active",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"all"
]
}
}
]
}POST /api/v1/intro-texts — intro-Textvorlage speichern
Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_intro_texts",
"summary": "intro-Textvorlage speichern",
"tags": [
"intro-texts"
],
"responses": {
"201": {
"description": "intro-Textvorlage speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/IntroText"
},
"hints": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"hints"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Vorlage nicht in dieser Art",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben oder Text-/Zahlungsvorgabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80
},
"text": {
"type": "string",
"maxLength": 2000
},
"paid_means": {
"anyOf": [
{
"type": "string",
"enum": [
"online"
]
},
{
"type": "null"
}
]
},
"paid_via": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"clearing_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_default": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name",
"text"
],
"additionalProperties": false
}
}
}
}
}PATCH /api/v1/intro-texts/{id} — intro-Textvorlage speichern
Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_intro_texts_id",
"summary": "intro-Textvorlage speichern",
"tags": [
"intro-texts"
],
"responses": {
"200": {
"description": "intro-Textvorlage speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/IntroText"
},
"hints": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"hints"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Vorlage nicht in dieser Art",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben oder Text-/Zahlungsvorgabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Kein DELETE; is_active=false deaktiviert. kind kommt aus der Route. Einleitung erlaubt keine Zahlungsangaben; Zahlungsvorlage braucht geeignetes Gegenkonto und darf kein Standard sein. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80
},
"text": {
"type": "string",
"maxLength": 2000
},
"paid_means": {
"anyOf": [
{
"type": "string",
"enum": [
"online"
]
},
{
"type": "null"
}
]
},
"paid_via": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"clearing_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_default": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}GET /api/v1/entries — Buchungen seitenweise lesen
{
"operationId": "get_api_v1_entries",
"summary": "Buchungen seitenweise lesen",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Buchungen seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Entry"
}
},
"meta": {
"$ref": "#/components/schemas/PageMeta"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"default": 25
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]
}POST /api/v1/entries — Buchung erfassen; post=true schreibt unmittelbar fest
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_entries",
"summary": "Buchung erfassen; post=true schreibt unmittelbar fest",
"tags": [
"entries"
],
"responses": {
"201": {
"description": "Buchung erfassen; post=true schreibt unmittelbar fest",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültig, nicht eingerichtet oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"post": {
"type": "boolean"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"side": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"amount_cents": {
"type": "integer",
"minimum": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"side",
"amount_cents"
],
"additionalProperties": false,
"description": "Optional cost_center_id OR cost_splits on net revenue/expense only. Splits total calculated net cents; tax and contra remain unassigned."
},
"minItems": 1
},
"document_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [
"description",
"lines"
],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "entry.create",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/entries/{id} — Buchung mit Konten und Belegverweisen lesen
{
"operationId": "get_api_v1_entries_id",
"summary": "Buchung mit Konten und Belegverweisen lesen",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Buchung mit Konten und Belegverweisen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PUT /api/v1/entries/{id} — Angegebene Buchungsentwurfsfelder ändern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "put_api_v1_entries_id",
"summary": "Angegebene Buchungsentwurfsfelder ändern",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Angegebene Buchungsentwurfsfelder ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Buchung ist festgeschrieben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung/Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"side": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"amount_cents": {
"type": "integer",
"minimum": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"side",
"amount_cents"
],
"additionalProperties": false,
"description": "Optional cost_center_id OR cost_splits on net revenue/expense only. Splits total calculated net cents; tax and contra remain unassigned."
},
"minItems": 1
},
"document_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}PATCH /api/v1/entries/{id} — Angegebene Buchungsentwurfsfelder ändern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_entries_id",
"summary": "Angegebene Buchungsentwurfsfelder ändern",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Angegebene Buchungsentwurfsfelder ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Buchung ist festgeschrieben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung/Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"side": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"amount_cents": {
"type": "integer",
"minimum": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"side",
"amount_cents"
],
"additionalProperties": false,
"description": "Optional cost_center_id OR cost_splits on net revenue/expense only. Splits total calculated net cents; tax and contra remain unassigned."
},
"minItems": 1
},
"document_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}DELETE /api/v1/entries/{id} — Buchungsentwurf verwerfen; zugeordnete Belege bleiben
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_entries_id",
"summary": "Buchungsentwurf verwerfen; zugeordnete Belege bleiben",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Buchungsentwurf verwerfen; zugeordnete Belege bleiben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documents_released": {
"type": "integer"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"message",
"documents_released"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Festgeschrieben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}POST /api/v1/entries/{id}/post — Buchungsentwurf endgültig festschreiben
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_entries_id_post",
"summary": "Buchungsentwurf endgültig festschreiben",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Buchungsentwurf endgültig festschreiben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Fachregel, auch eine fehlende ID ergibt 422",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"x-idempotency": {
"operation": "entry.post",
"key_required": false,
"contract": "summator-idempotency/1"
}
}POST /api/v1/entries/{id}/reverse — Buchung durch neue Umkehrbuchung korrigieren
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_entries_id_reverse",
"summary": "Buchung durch neue Umkehrbuchung korrigieren",
"tags": [
"entries"
],
"responses": {
"201": {
"description": "Buchung durch neue Umkehrbuchung korrigieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung/Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"returned_on": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Nur bei einer zugeordneten Zahlung: Tag, an dem das Geld tatsächlich zurückgeflossen ist, bei einer Bankzahlung der Buchungstag des Rückgabe-Umsatzes. Der Storno liegt an diesem Tag."
},
"misallocated": {
"type": "boolean",
"description": "Nur bei einer zugeordneten Zahlung aus einem vergangenen Jahr: Das Geld kam an und wurde nur falsch zugeordnet."
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"description": " Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"x-idempotency": {
"operation": "entry.reverse",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/me — Identität, Mandant und aktuelle Rollenrechte lesen
{
"operationId": "get_api_v1_me",
"summary": "Identität, Mandant und aktuelle Rollenrechte lesen",
"tags": [
"me"
],
"responses": {
"200": {
"description": "Identität, Mandant und aktuelle Rollenrechte lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tenant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"chart": {
"anyOf": [
{
"type": "string",
"enum": [
"SKR03",
"SKR04"
]
},
{
"type": "null"
}
]
},
"leistungen": {
"type": "array",
"description": "Gebuchte Leistungen des Mandanten (buchhaltung, dms). Routen einer nicht gebuchten Leistung antworten 403 mit error=leistung_fehlt.",
"items": {
"type": "string",
"enum": [
"buchhaltung",
"dms"
]
}
}
},
"required": [
"id",
"name",
"chart",
"leistungen"
],
"additionalProperties": false
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"owner",
"accountant",
"viewer"
]
},
"can_post": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"role",
"can_post"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"tenant",
"user"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}GET /api/v1/mcp-connections — Eigene sichtbare MCP-Verbindungen lesen
{
"operationId": "get_api_v1_mcp_connections",
"summary": "Eigene sichtbare MCP-Verbindungen lesen",
"tags": [
"mcp-connections"
],
"responses": {
"200": {
"description": "Eigene sichtbare MCP-Verbindungen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/McpConnection"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}DELETE /api/v1/mcp-connections/{id} — MCP-Verbindung widerrufen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_mcp_connections_id",
"summary": "MCP-Verbindung widerrufen",
"tags": [
"mcp-connections"
],
"responses": {
"204": {
"description": "MCP-Verbindung widerrufen"
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Verbindung nicht sichtbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/users — Als Inhaber Benutzer lesen
{
"operationId": "get_api_v1_users",
"summary": "Als Inhaber Benutzer lesen",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Als Inhaber Benutzer lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}POST /api/v1/users — Als Inhaber mit admin-Schlüssel Benutzer einladen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_users",
"summary": "Als Inhaber mit admin-Schlüssel Benutzer einladen",
"tags": [
"users"
],
"responses": {
"201": {
"description": "Als Inhaber mit admin-Schlüssel Benutzer einladen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/User"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"email": {
"type": "string",
"maxLength": 255
},
"role": {
"type": "string",
"enum": [
"owner",
"accountant",
"viewer"
]
}
},
"required": [
"email",
"role"
],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}PATCH /api/v1/users/{id} — Als Inhaber mit admin-Schlüssel Benutzer ändern oder deaktivieren
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_users_id",
"summary": "Als Inhaber mit admin-Schlüssel Benutzer ändern oder deaktivieren",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Als Inhaber mit admin-Schlüssel Benutzer ändern oder deaktivieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/User"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Fachregel, etwa letzter Inhaber",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"role": {
"type": "string",
"enum": [
"owner",
"accountant",
"viewer"
]
},
"active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/assistant/improvement — Verfügbarkeit und Zustimmung zum Assistenten-Tracing lesen
{
"operationId": "get_api_v1_assistant_improvement",
"summary": "Verfügbarkeit und Zustimmung zum Assistenten-Tracing lesen",
"tags": [
"assistant"
],
"responses": {
"200": {
"description": "Verfügbarkeit und Zustimmung zum Assistenten-Tracing lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AssistantImprovement"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}DELETE /api/v1/assistant/improvement — Als Inhaber Tracing-Zustimmung widerrufen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_assistant_improvement",
"summary": "Als Inhaber Tracing-Zustimmung widerrufen",
"tags": [
"assistant"
],
"responses": {
"200": {
"description": "Als Inhaber Tracing-Zustimmung widerrufen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AssistantImprovement"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}POST /api/v1/assistant/improvement — API-Einschalten wird ausdrücklich verweigert
Allow: GET, DELETE. Einschalten nur mit gelesener Zustimmung in Einstellungen → Assistent. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_assistant_improvement",
"summary": "API-Einschalten wird ausdrücklich verweigert",
"tags": [
"assistant"
],
"responses": {
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"405": {
"description": "API-Einschalten wird ausdrücklich verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Allow: GET, DELETE. Einschalten nur mit gelesener Zustimmung in Einstellungen → Assistent. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/reports/month — Kennzahl des laufenden Monats lesen
{
"operationId": "get_api_v1_reports_month",
"summary": "Kennzahl des laufenden Monats lesen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Kennzahl des laufenden Monats lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"month": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
},
"revenue_cents": {
"type": "integer"
},
"receivable_cents": {
"type": "integer"
},
"payable_cents": {
"type": "integer"
},
"posted": {
"type": "integer"
},
"entries": {
"type": "integer"
},
"drafts": {
"type": "integer"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"month",
"revenue_cents",
"receivable_cents",
"payable_cents",
"posted",
"entries",
"drafts"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}GET /api/v1/tasks — Aufgaben, Gruppen und Fristen lesen
{
"operationId": "get_api_v1_tasks",
"summary": "Aufgaben, Gruppen und Fristen lesen",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Aufgaben, Gruppen und Fristen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"can_act": {
"type": "boolean"
},
"top": {
"anyOf": [
{
"$ref": "#/components/schemas/Task"
},
{
"type": "null"
}
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"document",
"transaction",
"entry",
"invoice",
"quote"
]
},
"count": {
"type": "integer"
},
"title": {
"type": "string"
},
"web_url": {
"type": "string"
}
},
"required": [
"kind",
"count",
"title",
"web_url"
],
"additionalProperties": false
}
},
"deadlines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"vat_return",
"overdue_invoices"
]
},
"title": {
"type": "string"
},
"date": {
"type": "string",
"format": "date"
},
"overdue": {
"type": "boolean"
},
"web_url": {
"type": "string"
}
},
"required": [
"kind",
"title",
"date",
"overdue",
"web_url"
],
"additionalProperties": false
}
},
"prepared_today": {
"type": "object",
"properties": {
"entries": {
"type": "integer"
},
"invoices": {
"type": "integer"
}
},
"required": [
"entries",
"invoices"
],
"additionalProperties": false
},
"as_of": {
"type": "string"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"count",
"can_act",
"top",
"items",
"groups",
"deadlines",
"prepared_today",
"as_of"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}GET /api/v1/uebersicht — Zahlen der Startseite lesen
Was du bekommst und was du zahlen musst, Rechnung für Rechnung nach Fälligkeit; der Kontostand der nächsten drei Monate als Spanne; Gewinn oder Verlust je Monat. Dieselben Zahlen wie auf der Startseite, für jede Rolle lesbar, nur für die eigene Firma. Die Summen gelten immer für alle offenen Posten, die Listen sind auf items_limit gekürzt (Standard 20).
{
"operationId": "get_api_v1_uebersicht",
"summary": "Zahlen der Startseite lesen",
"description": "Was du bekommst und was du zahlen musst, Rechnung für Rechnung nach Fälligkeit; der Kontostand der nächsten drei Monate als Spanne; Gewinn oder Verlust je Monat. Dieselben Zahlen wie auf der Startseite, für jede Rolle lesbar, nur für die eigene Firma. Die Summen gelten immer für alle offenen Posten, die Listen sind auf items_limit gekürzt (Standard 20).",
"tags": [
"reports"
],
"parameters": [
{
"name": "items_limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 5000,
"default": 20
}
}
],
"responses": {
"200": {
"description": "Zahlen der Startseite",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"as_of": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"receivables": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"none",
"open"
]
},
"total_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"invoices_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"unallocated_cents": {
"type": "integer",
"description": "Zahlungen ohne Zuordnung zu einer Rechnung (negativ); in total_cents enthalten, nicht in items."
},
"count": {
"type": "integer"
},
"overdue_count": {
"type": "integer"
},
"overdue_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"next_due_on": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"oldest_date": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer"
},
"entry_id": {
"type": "integer"
},
"invoice_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partner": {
"type": "string"
},
"account_id": {
"type": "integer"
},
"account_number": {
"type": "string"
},
"date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"due_on": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"due_assumed": {
"type": "boolean",
"description": "Keine Fälligkeit bekannt: Buchungsdatum plus 30 Tage."
},
"overdue": {
"type": "boolean"
},
"days_overdue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"line_id",
"entry_id",
"invoice_id",
"number",
"partner",
"account_id",
"account_number",
"date",
"due_on",
"due_assumed",
"overdue",
"days_overdue",
"open_cents"
],
"additionalProperties": false
},
"description": "Nach Fälligkeit, auf items_limit gekürzt."
}
},
"required": [
"state",
"total_cents",
"invoices_cents",
"unallocated_cents",
"count",
"overdue_count",
"overdue_cents",
"next_due_on",
"oldest_date",
"items"
],
"additionalProperties": false
},
"payables": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"none",
"open"
]
},
"total_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"invoices_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"unallocated_cents": {
"type": "integer",
"description": "Zahlungen ohne Zuordnung zu einer Rechnung (negativ); in total_cents enthalten, nicht in items."
},
"count": {
"type": "integer"
},
"overdue_count": {
"type": "integer"
},
"overdue_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"next_due_on": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"oldest_date": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer"
},
"entry_id": {
"type": "integer"
},
"invoice_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partner": {
"type": "string"
},
"account_id": {
"type": "integer"
},
"account_number": {
"type": "string"
},
"date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"due_on": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"due_assumed": {
"type": "boolean",
"description": "Keine Fälligkeit bekannt: Buchungsdatum plus 30 Tage."
},
"overdue": {
"type": "boolean"
},
"days_overdue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"line_id",
"entry_id",
"invoice_id",
"number",
"partner",
"account_id",
"account_number",
"date",
"due_on",
"due_assumed",
"overdue",
"days_overdue",
"open_cents"
],
"additionalProperties": false
},
"description": "Nach Fälligkeit, auf items_limit gekürzt."
}
},
"required": [
"state",
"total_cents",
"invoices_cents",
"unallocated_cents",
"count",
"overdue_count",
"overdue_cents",
"next_due_on",
"oldest_date",
"items"
],
"additionalProperties": false
},
"cash_forecast": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"ready",
"no_bank_account",
"no_balance"
]
},
"balance_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"balance_date": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"accounts": {
"type": "integer"
},
"accounts_without_balance": {
"type": "integer"
},
"weeks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"low_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"high_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"from",
"until",
"low_cents",
"high_cents"
],
"additionalProperties": false
}
},
"in_three_months": {
"anyOf": [
{
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"low_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"high_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"from",
"until",
"low_cents",
"high_cents"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"not_counted_overdue_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"recurring_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
}
},
"required": [
"state",
"balance_cents",
"balance_date",
"accounts",
"accounts_without_balance",
"weeks",
"in_three_months",
"not_counted_overdue_cents",
"recurring_cents"
],
"additionalProperties": false,
"description": "Kontostand der nächsten 13 Wochen als Spanne. Start ist der letzte bekannte Schlusssaldo aller Euro-Konten. Rechnungen, die wir zahlen müssen, ziehen in beiden Werten in der Woche ihrer Fälligkeit ab, überfällige in der ersten Woche. Rechnungen an Kunden zählen in beiden Werten in der Woche ihrer Fälligkeit; sind sie höchstens 30 Tage überfällig, nur im oberen Wert in der ersten Woche; ältere zählen nicht mehr. Aktive Serienrechnungen zählen in beiden Werten zu Termin plus Zahlungsziel. Ohne Bankkonto oder bekannten Kontostand gibt es keine Vorschau, sondern einen Zustand."
},
"profit": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"euer",
"guv"
]
},
"state": {
"type": "string",
"enum": [
"ready",
"partial",
"no_entries"
]
},
"first_entry": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "null"
}
]
},
"open_cases": {
"type": "integer",
"description": "Vorgänge, die die EÜR noch klären lassen will und die deshalb nicht mitzählen."
},
"months": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
},
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"partial": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"booked",
"before_first_entry",
"not_supported"
]
},
"profit_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"month",
"from",
"until",
"partial",
"state",
"profit_cents"
],
"additionalProperties": false
}
},
"last_month": {
"type": "object",
"properties": {
"month": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
},
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"partial": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"booked",
"before_first_entry",
"not_supported"
]
},
"profit_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"month",
"from",
"until",
"partial",
"state",
"profit_cents"
],
"additionalProperties": false
},
"previous_month": {
"type": "object",
"properties": {
"month": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
},
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"partial": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"booked",
"before_first_entry",
"not_supported"
]
},
"profit_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"month",
"from",
"until",
"partial",
"state",
"profit_cents"
],
"additionalProperties": false
},
"spans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"months": {
"type": "integer",
"enum": [
1,
2,
3
]
},
"from": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"until": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"profit_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"months",
"from",
"until",
"profit_cents"
],
"additionalProperties": false
}
},
"twelve_months_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
}
},
"required": [
"method",
"state",
"first_entry",
"open_cases",
"months",
"last_month",
"previous_month",
"spans",
"twelve_months_cents"
],
"additionalProperties": false,
"description": "Gewinn oder Verlust je Monat, zwölf Monate bis heute (der laufende Monat ist angebrochen), dazu der letzte volle Monat, der davor und die letzten ein bis drei vollen Monate. Ein Einzelunternehmen rechnet wie seine EÜR, alle anderen wie die GuV. Null steht nur, wo es keine Zahl gibt: vor der ersten Buchung oder in einem Jahr, für das die EÜR nicht rechnet."
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"as_of",
"receivables",
"payables",
"cash_forecast",
"profit"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}GET /api/v1/bank/accounts — Bankkonten und Sachkontozuordnung lesen
{
"operationId": "get_api_v1_bank_accounts",
"summary": "Bankkonten und Sachkontozuordnung lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Bankkonten und Sachkontozuordnung lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"iban": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currency": {
"type": "string"
},
"transactions": {
"type": "integer"
},
"account": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountIdentity"
},
{
"type": "null"
}
]
},
"ready": {
"type": "boolean"
},
"data_status": {
"anyOf": [
{
"$ref": "#/components/schemas/BankDataStatus"
},
{
"type": "null"
}
],
"description": "null bei einem Zahlungsdienst"
}
},
"required": [
"id",
"iban",
"name",
"currency",
"transactions",
"account",
"ready",
"data_status"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}PATCH /api/v1/bank/accounts/{id} — Bankkonto benennen oder geeignetes Sachkonto zuordnen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_bank_accounts_id",
"summary": "Bankkonto benennen oder geeignetes Sachkonto zuordnen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Bankkonto benennen oder geeignetes Sachkonto zuordnen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"iban": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountIdentity"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"iban",
"name",
"account"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder ungeeignetes Konto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false,
"anyOf": [
{
"required": [
"account_id"
]
},
{
"required": [
"name"
]
}
]
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/bank/statements — Noch vollständig entfernbare Auszugsimporte lesen
{
"operationId": "get_api_v1_bank_statements",
"summary": "Noch vollständig entfernbare Auszugsimporte lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Noch vollständig entfernbare Auszugsimporte lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"document_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"received_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"transactions": {
"type": "integer"
}
},
"required": [
"document_id",
"name",
"received_at",
"transactions"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}POST /api/v1/bank/statements — CAMT/MT940-Auszug einlesen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_statements",
"summary": "CAMT/MT940-Auszug einlesen",
"tags": [
"bank"
],
"responses": {
"201": {
"description": "CAMT/MT940-Auszug einlesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatementImportResult"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "CAMT XML oder MT940, höchstens 16777216 Bytes"
}
},
"required": [
"file"
],
"additionalProperties": false
}
}
}
}
}DELETE /api/v1/bank/statements/{id} — Ungebuchten Auszugsimport bewusst entfernen
{id} ist die document_id des Imports, keine bank_statement_id. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_bank_statements_id",
"summary": "Ungebuchten Auszugsimport bewusst entfernen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Ungebuchten Auszugsimport bewusst entfernen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transactions": {
"type": "integer"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Bereits gebucht oder nicht entfernbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "{id} ist die document_id des Imports, keine bank_statement_id. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/bank/csv/accounts — Eigenes CSV-Bankkonto anlegen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_csv_accounts",
"summary": "Eigenes CSV-Bankkonto anlegen",
"tags": [
"bank"
],
"responses": {
"201": {
"description": "Eigenes CSV-Bankkonto anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"iban": {
"type": "string"
},
"name": {
"type": "string"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id",
"iban",
"name"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"iban": {
"type": "string",
"maxLength": 50
},
"name": {
"type": "string",
"maxLength": 100
}
},
"required": [
"iban",
"name"
],
"additionalProperties": false
}
}
}
},
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/bank/institutes — FinTS-Institute suchen
{
"operationId": "get_api_v1_bank_institutes",
"summary": "FinTS-Institute suchen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "FinTS-Institute suchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blz": {
"type": "string"
},
"name": {
"type": "string"
},
"city": {
"type": "string"
},
"bic": {
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"blz",
"name",
"city",
"bic",
"url",
"version"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 2,
"maxLength": 100
}
}
]
}GET /api/v1/webhooks — Neueste 100 eigene Webhook-Abonnements lesen
{
"operationId": "get_api_v1_webhooks",
"summary": "Neueste 100 eigene Webhook-Abonnements lesen",
"tags": [
"webhooks"
],
"responses": {
"200": {
"description": "Neueste 100 eigene Webhook-Abonnements lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookSubscription"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"subscriptions"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
]
}POST /api/v1/webhooks — Eigenes Webhook-Abonnement registrieren; Geheimnis einmal anzeigen
Cache-Control: no-store. Keine Zusage externer Zustellung; Empfänger muss Ereignis-IDs deduplizieren. Jede Zustellung trägt die Kopfzeilen Webhook-Id, Webhook-Timestamp (Unixsekunden), Webhook-Key-Id und Webhook-Signature (v1= und hexadezimal HMAC-SHA256). Signiert ist timestamp + "." + Webhook-Id + "." + unveränderter Inhalt, Schlüssel ist die hier angezeigte Zeichenfolge. Weise Zustellungen ab, deren Zeitstempel mehr als 300 Sekunden abweicht. Bestätige doppelte Ereignis-IDs mit 2xx, ohne sie erneut zu verarbeiten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_webhooks",
"summary": "Eigenes Webhook-Abonnement registrieren; Geheimnis einmal anzeigen",
"tags": [
"webhooks"
],
"responses": {
"201": {
"description": "Eigenes Webhook-Abonnement registrieren; Geheimnis einmal anzeigen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSecret"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültiges oder nicht öffentliches Ziel; höchstens 20 offene Abonnements",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Cache-Control: no-store. Keine Zusage externer Zustellung; Empfänger muss Ereignis-IDs deduplizieren. Jede Zustellung trägt die Kopfzeilen Webhook-Id, Webhook-Timestamp (Unixsekunden), Webhook-Key-Id und Webhook-Signature (v1= und hexadezimal HMAC-SHA256). Signiert ist timestamp + \".\" + Webhook-Id + \".\" + unveränderter Inhalt, Schlüssel ist die hier angezeigte Zeichenfolge. Weise Zustellungen ab, deren Zeitstempel mehr als 300 Sekunden abweicht. Bestätige doppelte Ereignis-IDs mit 2xx, ohne sie erneut zu verarbeiten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"description": "Öffentliches HTTPS auf Port 443; ohne Benutzerinfo, Query, Fragment, private/reservierte DNS-Ziele."
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"invoice.issued",
"invoice.corrected",
"journal.posted"
]
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true
},
"confirm_secret": {
"const": true
}
},
"required": [
"url",
"types",
"confirm_secret"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/webhooks/{id} — 100 eigene Zustellungen plus Versuche und Ergebnisse lesen
{
"operationId": "get_api_v1_webhooks_id",
"summary": "100 eigene Zustellungen plus Versuche und Ergebnisse lesen",
"tags": [
"webhooks"
],
"responses": {
"200": {
"description": "100 eigene Zustellungen plus Versuche und Ergebnisse lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deliveries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookDelivery"
}
},
"next_before_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string",
"enum": [
"invoice.issued",
"invoice.corrected",
"journal.posted"
]
},
"occurred_at": {
"type": "string",
"description": "Zeitstempel als Text mit Zeitzonenoffset, nicht ISO-normalisiert."
},
"invoice_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"journal_entry_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"occurred_at",
"invoice_id",
"journal_entry_id"
],
"additionalProperties": false
}
},
"attempts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"delivery_id": {
"type": "string",
"format": "uuid"
},
"number": {
"type": "integer"
},
"key_id": {
"type": "string",
"format": "uuid"
},
"started_at": {
"type": "string",
"description": "Zeitstempel als Text mit Zeitzonenoffset, nicht ISO-normalisiert."
}
},
"required": [
"id",
"delivery_id",
"number",
"key_id",
"started_at"
],
"additionalProperties": false
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"attempt_id": {
"type": "string",
"format": "uuid"
},
"http_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"outcome": {
"type": "string",
"enum": [
"canceled",
"response_unknown",
"key_changed",
"target_rejected",
"accepted",
"rate_limited",
"server_error",
"permanent_http_error"
]
},
"finished_at": {
"type": "string",
"description": "Zeitstempel als Text mit Zeitzonenoffset, nicht ISO-normalisiert."
}
},
"required": [
"id",
"attempt_id",
"http_status",
"outcome",
"finished_at"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"deliveries",
"next_before_id",
"events",
"attempts",
"results"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fremdes/unbekanntes Abonnement oder Cursor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige UUID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before_id",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/webhooks/{id}/events/{eventId} — Exakte gespeicherte Ereignis-JSON-Bytes lesen
Unveränderte raw_body-Bytes; ergänzt keine setup-/billing-Hinweise. Ressourcenverweis nennt aktuellen GET-Vertrag, keinen historischen Ressourcensnapshot.
{
"operationId": "get_api_v1_webhooks_id_events_eventId",
"summary": "Exakte gespeicherte Ereignis-JSON-Bytes lesen",
"tags": [
"webhooks"
],
"responses": {
"200": {
"description": "Exakte gespeicherte Ereignis-JSON-Bytes lesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEvent"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Kein eigenes Abonnement oder keine zugehörige Zustellung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige UUID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Unveränderte raw_body-Bytes; ergänzt keine setup-/billing-Hinweise. Ressourcenverweis nennt aktuellen GET-Vertrag, keinen historischen Ressourcensnapshot.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/webhooks/{id}/{operation} — Abonnement steuern oder vorhandene Zustellung bewusst nachsenden
pause/resume/revoke: kein Body. rotate: confirm_secret=true. replace: url, types und confirm_secret=true. replay: delivery_id und confirm_replay=true; höchstens zwei Nachsendungen innerhalb sieben Tagen. Rotation erlaubt Empfang des alten Schlüssels noch 300 Sekunden; kein erneuter Geheimnisabruf. Pause/replace/revoke stornieren offene Zustellungen. Kein neuer Rechnungsschreibvorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_webhooks_id_operation",
"summary": "Abonnement steuern oder vorhandene Zustellung bewusst nachsenden",
"tags": [
"webhooks"
],
"responses": {
"200": {
"description": "Abonnement steuern oder vorhandene Zustellung bewusst nachsenden",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"$ref": "#/components/schemas/WebhookSecret"
},
{
"type": "object",
"properties": {
"event_id": {
"type": "string",
"format": "uuid"
},
"delivery_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"event_id",
"delivery_id"
],
"additionalProperties": false
}
]
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fremde/unbekannte ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Widerrufen, falsche Generation, Frist oder Nachsendegrenze",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "pause/resume/revoke: kein Body. rotate: confirm_secret=true. replace: url, types und confirm_secret=true. replay: delivery_id und confirm_replay=true; höchstens zwei Nachsendungen innerhalb sieben Tagen. Rotation erlaubt Empfang des alten Schlüssels noch 300 Sekunden; kein erneuter Geheimnisabruf. Pause/replace/revoke stornieren offene Zustellungen. Kein neuer Rechnungsschreibvorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operation",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"pause",
"resume",
"revoke",
"rotate",
"replace",
"replay"
]
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"description": "Öffentliches HTTPS auf Port 443; ohne Benutzerinfo, Query, Fragment, private/reservierte DNS-Ziele."
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"invoice.issued",
"invoice.corrected",
"journal.posted"
]
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true
},
"confirm_secret": {
"const": true
},
"delivery_id": {
"type": "string",
"format": "uuid"
},
"confirm_replay": {
"const": true
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}GET /api/v1/document-mail-inbox — Mail-Eingang und neueste 25 Zustellungen lesen
{
"operationId": "get_api_v1_document_mail_inbox",
"summary": "Mail-Eingang und neueste 25 Zustellungen lesen",
"tags": [
"document-mail-inbox"
],
"responses": {
"200": {
"description": "Mail-Eingang und neueste 25 Zustellungen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MailInbox"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "before_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/document-mail-inbox — Mailadresse rotieren/deaktivieren oder Anhang gezielt erneut verarbeiten
rotate/disable verlangen zusätzlich das Recht zur Benutzerverwaltung (Inhaber und admin). rotate antwortet mit 422, solange available falsch ist. Dafür revision aus Inbox verwenden. retry verlangt attachment_id und retry_revision des Anhangs im Feld revision; maximal fünf Versuche, importierte/duplizierte Anhänge bleiben. rotate liefert Adresse einmal in created. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_document_mail_inbox",
"summary": "Mailadresse rotieren/deaktivieren oder Anhang gezielt erneut verarbeiten",
"tags": [
"document-mail-inbox"
],
"responses": {
"200": {
"description": "Mailadresse rotieren/deaktivieren oder Anhang gezielt erneut verarbeiten",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MailInbox"
},
"created": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"properties": {
"address": {
"type": "string"
},
"inbox_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"address",
"inbox_id"
],
"additionalProperties": false
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"created"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Anhang nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Veraltete Vorschau oder Zustand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "rotate/disable verlangen zusätzlich das Recht zur Benutzerverwaltung (Inhaber und admin). rotate antwortet mit 422, solange available falsch ist. Dafür revision aus Inbox verwenden. retry verlangt attachment_id und retry_revision des Anhangs im Feld revision; maximal fünf Versuche, importierte/duplizierte Anhänge bleiben. rotate liefert Adresse einmal in created. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"rotate",
"disable",
"retry"
]
},
"revision": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"attachment_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"action",
"revision"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/setup — Einrichtung und konkrete fehlende Schritte lesen
{
"operationId": "get_api_v1_setup",
"summary": "Einrichtung und konkrete fehlende Schritte lesen",
"tags": [
"setup"
],
"responses": {
"200": {
"description": "Einrichtung und konkrete fehlende Schritte lesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetupStatus"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}POST /api/v1/setup — Angegebene Unternehmenseinstellungen ändern
Teiländerung. Kontenrahmenwechsel nur separat per Konsole. Profil/Nummer atomar, danach Logo, Versteuerung und Rhythmus separat: Fehler kann vorherige Teilschritte erhalten. Ist verlangt basis. Logo: PNG/JPEG/WebP, 2 MiB; Basis64 streng. Das Nummernmuster wird geprüft. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_setup",
"summary": "Angegebene Unternehmenseinstellungen ändern",
"tags": [
"setup"
],
"responses": {
"200": {
"description": "Angegebene Unternehmenseinstellungen ändern",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetupStatus"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Teiländerung. Kontenrahmenwechsel nur separat per Konsole. Profil/Nummer atomar, danach Logo, Versteuerung und Rhythmus separat: Fehler kann vorherige Teilschritte erhalten. Ist verlangt basis. Logo: PNG/JPEG/WebP, 2 MiB; Basis64 streng. Das Nummernmuster wird geprüft. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"chart": {
"type": "string",
"enum": [
"SKR03",
"SKR04"
]
},
"taxation": {
"type": "string",
"enum": [
"soll",
"ist"
]
},
"basis": {
"anyOf": [
{
"type": "string",
"enum": [
"limit",
"no_bookkeeping",
"profession"
]
},
{
"type": "null"
}
]
},
"valid_from": {
"type": "string",
"format": "date"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"vat_filing": {
"type": "string",
"enum": [
"month",
"quarter"
]
},
"vat_filing_from": {
"type": "string",
"format": "date"
},
"tax_number": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"vat_id": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"register": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"represented_by": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"bank_name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"website": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string",
"maxLength": 16
},
{
"type": "null"
}
]
},
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"small_business": {
"type": "boolean"
},
"iban": {
"anyOf": [
{
"type": "string",
"maxLength": 34
},
{
"type": "null"
}
]
},
"bic": {
"anyOf": [
{
"type": "string",
"maxLength": 11
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
]
},
"receivables_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"invoice_number_format": {
"type": "string",
"maxLength": 40
},
"credit_note_number_format": {
"type": "string",
"maxLength": 40
},
"next_invoice_number": {
"type": "integer",
"minimum": 1,
"maximum": 999999
},
"next_invoice_number_year": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"logo_base64": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"invoice_layout": {
"type": "string",
"enum": [
"summator",
"klassisch"
]
},
"invoice_font": {
"type": "string",
"enum": [
"inter",
"arimo"
]
},
"invoice_prices": {
"type": "string",
"enum": [
"net",
"gross"
]
},
"legal_form": {
"anyOf": [
{
"type": "string",
"enum": [
"sole_proprietor",
"partnership",
"corporation"
]
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}POST /api/v1/setup/logo — Rechnungslogo speichern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_setup_logo",
"summary": "Rechnungslogo speichern",
"tags": [
"setup"
],
"responses": {
"200": {
"description": "Rechnungslogo speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"logo": {
"type": "boolean"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"logo"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"logo": {
"type": "string",
"format": "binary",
"description": "PNG/JPEG/WebP bis 2097152 Bytes; als PNG auf höchstens 1200×600 Pixel gespeichert."
}
},
"required": [
"logo"
],
"additionalProperties": false
}
}
}
}
}DELETE /api/v1/setup/logo — Rechnungslogo entfernen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_setup_logo",
"summary": "Rechnungslogo entfernen",
"tags": [
"setup"
],
"responses": {
"200": {
"description": "Rechnungslogo entfernen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"logo": {
"type": "boolean"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"logo"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/documents — Belege nach Empfangszeit seitenweise lesen
{
"operationId": "get_api_v1_documents",
"summary": "Belege nach Empfangszeit seitenweise lesen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Belege nach Empfangszeit seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer"
}
},
"required": [
"total",
"page"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "hidden",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "Zeigt statt der sichtbaren Belege die ausgeblendeten Fehlimporte."
},
{
"name": "unlinked",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Jeder truthy Querywert aktiviert Filter, auch String false."
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"default": 25
}
}
]
}POST /api/v1/documents — Original einreichen und Erkennung anstoßen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_documents",
"summary": "Original einreichen und Erkennung anstoßen",
"tags": [
"documents"
],
"responses": {
"201": {
"description": "Original einreichen und Erkennung anstoßen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Document"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "1 bis 33554432 Bytes. application/pdf, image/jpeg, image/png, image/heic, image/webp, image/tiff, text/xml, application/xml, text/csv, application/json. OCR hat eigene engere Grenzen."
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"file"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/documents/{id} — Beleg und Integritätsprüfung lesen
{
"operationId": "get_api_v1_documents_id",
"summary": "Beleg und Integritätsprüfung lesen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Beleg und Integritätsprüfung lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"recognition": {
"$ref": "#/components/schemas/Recognition"
},
"name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 0
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"received_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"locked": {
"type": "boolean"
},
"discardable": {
"type": "boolean"
},
"locked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
}
},
"required": [
"id",
"entry_number",
"description"
],
"additionalProperties": false
}
},
"duplicates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentDuplicate"
}
},
"integrity_ok": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/IncomingValidationState"
},
"hidden": {
"type": "boolean",
"description": "Ausgeblendeter Fehlimport. Original und Historie bleiben erhalten."
},
"visibility_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVisibilityEvent"
}
}
},
"required": [
"id",
"recognition",
"name",
"mime_type",
"size_bytes",
"sha256",
"document_date",
"note",
"received_at",
"locked",
"discardable",
"locked_at",
"entries",
"duplicates",
"integrity_ok",
"validation",
"hidden",
"visibility_history"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}DELETE /api/v1/documents/{id} — Nur verwerfbaren ungebuchten Beleg entfernen
discardable ist ein Hinweis, der Server prüft erneut. Original einer gebuchten Rechnung bleibt erhalten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "delete_api_v1_documents_id",
"summary": "Nur verwerfbaren ungebuchten Beleg entfernen",
"tags": [
"documents"
],
"responses": {
"204": {
"description": "Nur verwerfbaren ungebuchten Beleg entfernen"
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Gesperrt, gesiegelt oder geschützte E-Rechnung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "discardable ist ein Hinweis, der Server prüft erneut. Original einer gebuchten Rechnung bleibt erhalten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/documents/{id}/file — Hashgeprüfte unveränderte Originaldatei inline lesen
Content-Type ist der gespeicherte MIME-Typ; Content-Disposition inline, nosniff. Keine Neuerzeugung.
{
"operationId": "get_api_v1_documents_id_file",
"summary": "Hashgeprüfte unveränderte Originaldatei inline lesen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Hashgeprüfte unveränderte Originaldatei inline lesen",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt oder Integritätsfehler",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Content-Type ist der gespeicherte MIME-Typ; Content-Disposition inline, nosniff. Keine Neuerzeugung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/documents/{id}/recognition — Erkennungsstatus lesen
PNG/JPEG/PDF, OCR höchstens 16 MiB/16 Mio Pixel/2 Seiten/120 Sekunden. Höchstens 5 Versuche, mindestens eine Minute Abstand.
{
"operationId": "get_api_v1_documents_id_recognition",
"summary": "Erkennungsstatus lesen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Erkennungsstatus lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Recognition"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "PNG/JPEG/PDF, OCR höchstens 16 MiB/16 Mio Pixel/2 Seiten/120 Sekunden. Höchstens 5 Versuche, mindestens eine Minute Abstand.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/documents/{id}/recognition — Erkennung gezielt erneut anfordern
PNG/JPEG/PDF, OCR höchstens 16 MiB/16 Mio Pixel/2 Seiten/120 Sekunden. Höchstens 5 Versuche, mindestens eine Minute Abstand. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_documents_id_recognition",
"summary": "Erkennung gezielt erneut anfordern",
"tags": [
"documents"
],
"responses": {
"202": {
"description": "Erkennung gezielt erneut anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Recognition"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "PNG/JPEG/PDF, OCR höchstens 16 MiB/16 Mio Pixel/2 Seiten/120 Sekunden. Höchstens 5 Versuche, mindestens eine Minute Abstand. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/documents/{id}/review — Aktuellen Prüfstand und historische Lesungen lesen
{
"operationId": "get_api_v1_documents_id_review",
"summary": "Aktuellen Prüfstand und historische Lesungen lesen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Aktuellen Prüfstand und historische Lesungen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DocumentReview"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/documents/{id}/review — Korrektur als neuen Prüfentwurf anhängen
Netto+Steuer=Brutto, Vorzeichen und Gruppen müssen passen. Fehlende Werte bleiben null; Währung als ISO-Code. Keine Originaländerung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_documents_id_review",
"summary": "Korrektur als neuen Prüfentwurf anhängen",
"tags": [
"documents"
],
"responses": {
"201": {
"description": "Korrektur als neuen Prüfentwurf anhängen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DocumentReview"
},
"saved_extract_id": {
"type": "integer",
"minimum": 1
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"saved_extract_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Netto+Steuer=Brutto, Vorzeichen und Gruppen müssen passen. Fehlende Werte bleiben null; Währung als ISO-Code. Keine Originaländerung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"values": {
"$ref": "#/components/schemas/ReviewValues"
}
},
"required": [
"version",
"values"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/documents/{id}/review/preview — Übernahme ohne Festschreibung vorschauen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_documents_id_review_preview",
"summary": "Übernahme ohne Festschreibung vorschauen",
"tags": [
"documents"
],
"responses": {
"200": {
"description": "Übernahme ohne Festschreibung vorschauen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"document_id": {
"type": "integer",
"minimum": 1
},
"original_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"version": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"extract_id": {
"type": "integer",
"minimum": 1
},
"values": {
"$ref": "#/components/schemas/ReviewValues"
},
"booking": {
"anyOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"type": "integer",
"minimum": 1
},
"side": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"amount_cents": {
"type": "integer"
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"side",
"amount_cents"
],
"additionalProperties": false,
"description": "Optional cost_center_id OR cost_splits on net revenue/expense only. Splits total calculated net cents; tax and contra remain unassigned."
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"account": {
"type": "string"
},
"tax_key": {
"type": "string"
},
"category": {
"type": [
"string",
"null"
]
},
"scheme": {
"type": [
"string",
"null"
]
},
"net_cents": {
"type": "integer"
},
"tax_cents": {
"type": "integer"
},
"gross_cents": {
"type": "integer"
},
"tax_account_state": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"vat_box": {
"type": [
"string",
"null"
]
},
"category_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"type",
"chart",
"is_active",
"vat_box",
"category_code"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classification": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"rate_bp": {
"type": "integer"
},
"category": {
"type": [
"string",
"null"
]
},
"direction": {
"type": "string"
},
"account_id": {
"type": [
"integer",
"null"
]
},
"counter_account_id": {
"type": [
"integer",
"null"
]
},
"vat_box": {
"type": [
"string",
"null"
]
},
"chart": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"rate_bp",
"category",
"direction",
"account_id",
"counter_account_id",
"vat_box",
"chart",
"is_active"
],
"additionalProperties": false
},
"account_state": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"vat_box": {
"type": [
"string",
"null"
]
},
"category_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"type",
"chart",
"is_active",
"vat_box",
"category_code"
],
"additionalProperties": false
}
},
"required": [
"index",
"account",
"tax_key",
"category",
"scheme",
"net_cents",
"tax_cents",
"gross_cents",
"tax_account_state",
"classification",
"account_state"
],
"additionalProperties": false
}
},
"account": {
"type": "string"
},
"tax_key": {
"type": "string"
},
"counter_account": {
"type": "string"
},
"counter_state": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"vat_box": {
"type": [
"string",
"null"
]
},
"category_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"type",
"chart",
"is_active",
"vat_box",
"category_code"
],
"additionalProperties": false
}
},
"required": [
"description",
"lines",
"groups",
"account",
"tax_key",
"counter_account",
"counter_state"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"limitation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"duplicates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"beleg_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"aussteller": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"rechnungsnummer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"datum": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"brutto_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
},
"e_rechnung": {
"type": "boolean"
},
"stand": {
"type": "string"
},
"buchung": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"merkmale": {
"type": "array",
"items": {
"type": "string"
}
},
"gleich": {
"type": "boolean"
}
},
"required": [
"beleg_id",
"name",
"aussteller",
"rechnungsnummer",
"datum",
"brutto_cents",
"e_rechnung",
"stand",
"buchung",
"merkmale",
"gleich"
],
"additionalProperties": false
}
},
"actor_id": {
"type": "integer",
"minimum": 1
},
"token": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"document_id",
"original_sha256",
"version",
"extract_id",
"values",
"booking",
"limitation",
"duplicates",
"actor_id",
"token"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"booking": {
"type": "object",
"properties": {
"counter_account_id": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 255
},
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"type": "integer",
"minimum": 1
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"type": "integer",
"minimum": 1
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"tax_key_id"
],
"additionalProperties": false
},
"maxItems": 12
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
}
},
"required": [
"counter_account_id",
"description"
],
"additionalProperties": false
}
},
"required": [
"version"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/documents/{id}/review/confirm — Prüfstand bestätigen; gegebenenfalls Buchungsentwurf anlegen
Gesperrte/gesiegelte Belege, laufende Erkennung, alte Version oder Token werden 422. Dubletten ausdrücklich bestätigen. limitation kann Übernahme ohne Buchung erlauben. Niemals automatische Festschreibung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_documents_id_review_confirm",
"summary": "Prüfstand bestätigen; gegebenenfalls Buchungsentwurf anlegen",
"tags": [
"documents"
],
"responses": {
"201": {
"description": "Prüfstand bestätigen; gegebenenfalls Buchungsentwurf anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"extract": {
"$ref": "#/components/schemas/DocumentExtractRecord"
},
"entry": {
"anyOf": [
{
"$ref": "#/components/schemas/JournalEntryRecord"
},
{
"type": "null"
}
]
},
"limitation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"extract",
"entry",
"limitation"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Gesperrte/gesiegelte Belege, laufende Erkennung, alte Version oder Token werden 422. Dubletten ausdrücklich bestätigen. limitation kann Übernahme ohne Buchung erlauben. Niemals automatische Festschreibung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"booking": {
"type": "object",
"properties": {
"counter_account_id": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 255
},
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"type": "integer",
"minimum": 1
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"type": "integer",
"minimum": 1
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"tax_key_id"
],
"additionalProperties": false
},
"maxItems": 12
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
}
},
"required": [
"counter_account_id",
"description"
],
"additionalProperties": false
},
"preview_token": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"duplicate_acknowledged": {
"type": "boolean"
},
"confirm": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"version",
"preview_token",
"confirm"
],
"additionalProperties": false
}
}
}
}
}PATCH /api/v1/accounts/{id} — Begrenzt Sachkontenstammdaten pflegen
Keine fremden Felder. Nummer, Art und Rahmen bleiben fest; bebuchte Kategorie und vorhandene Kennziffer nicht umdeuten; Personenkonten und Bankkonten separat. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_accounts_id",
"summary": "Begrenzt Sachkontenstammdaten pflegen",
"tags": [
"accounts"
],
"responses": {
"200": {
"description": "Begrenzt Sachkontenstammdaten pflegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"vat_box": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"vat_reportable": {
"type": "boolean"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id",
"number",
"name",
"category",
"is_active",
"vat_box",
"vat_reportable"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Keine fremden Felder. Nummer, Art und Rahmen bleiben fest; bebuchte Kategorie und vorhandene Kennziffer nicht umdeuten; Personenkonten und Bankkonten separat. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"category": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
]
},
"vat_box": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{2,3}$"
},
{
"type": "null"
}
]
},
"vat_reportable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
}
}
}
}GET /api/v1/bank/connections — FinTS-Konfiguration und gespeicherte Zugänge lesen
{
"operationId": "get_api_v1_bank_connections",
"summary": "FinTS-Konfiguration und gespeicherte Zugänge lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "FinTS-Konfiguration und gespeicherte Zugänge lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BankConnection"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"enabled",
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}POST /api/v1/bank/connections — FinTS-Zugang konfigurieren
fetch_from höchstens heute. Kein PIN-Speichern; tatsächlicher Abruf erfordert installierte FinTS-Konfiguration und Bankfreigabe. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections",
"summary": "FinTS-Zugang konfigurieren",
"tags": [
"bank"
],
"responses": {
"201": {
"description": "FinTS-Zugang konfigurieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BankConnection"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "fetch_from höchstens heute. Kein PIN-Speichern; tatsächlicher Abruf erfordert installierte FinTS-Konfiguration und Bankfreigabe. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bank_code": {
"type": "string",
"maxLength": 12
},
"username": {
"type": "string",
"maxLength": 100
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"url": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"fetch_from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"bank_code",
"username"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/bank/connections/{id}/tan-modes — TAN-Verfahren bei der Bank lesen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections_id_tan_modes",
"summary": "TAN-Verfahren bei der Bank lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "TAN-Verfahren bei der Bank lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"decoupled": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"decoupled"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"maxLength": 100,
"writeOnly": true
}
},
"required": [
"pin"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/bank/connections/{id}/tan-mode — TAN-Verfahren und Medium auswählen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections_id_tan_mode",
"summary": "TAN-Verfahren und Medium auswählen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "TAN-Verfahren und Medium auswählen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BankConnection"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"maxLength": 100,
"writeOnly": true
},
"tan_mode": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"tan_medium": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"pin"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/bank/connections/{id}/fetch — FinTS fetch
PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections_id_fetch",
"summary": "FinTS fetch",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "FinTS fetch",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"done"
]
},
"statements": {
"type": "integer"
},
"transactions": {
"type": "integer"
},
"duplicates": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"accounts": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"statements",
"transactions",
"duplicates",
"warnings",
"accounts"
],
"additionalProperties": false
}
}
}
},
"202": {
"description": "TAN oder entkoppelte Freigabe erforderlich",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"tan"
]
},
"token": {
"type": "string",
"minLength": 40,
"maxLength": 40
},
"challenge": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"challenge_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decoupled": {
"type": "boolean"
},
"nachholen_ab": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"token",
"challenge",
"challenge_image",
"decoupled",
"nachholen_ab"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"maxLength": 100,
"writeOnly": true
}
},
"required": [
"pin"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/bank/connections/{id}/backfill — FinTS backfill
PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections_id_backfill",
"summary": "FinTS backfill",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "FinTS backfill",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"done"
]
},
"statements": {
"type": "integer"
},
"transactions": {
"type": "integer"
},
"duplicates": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"accounts": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"statements",
"transactions",
"duplicates",
"warnings",
"accounts"
],
"additionalProperties": false
}
}
}
},
"202": {
"description": "TAN oder entkoppelte Freigabe erforderlich",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"tan"
]
},
"token": {
"type": "string",
"minLength": 40,
"maxLength": 40
},
"challenge": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"challenge_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decoupled": {
"type": "boolean"
},
"nachholen_ab": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"token",
"challenge",
"challenge_image",
"decoupled",
"nachholen_ab"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"maxLength": 100,
"writeOnly": true
},
"from": {
"type": "string",
"format": "date"
}
},
"required": [
"pin",
"from"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/bank/connections/{id}/resume — FinTS resume
PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_connections_id_resume",
"summary": "FinTS resume",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "FinTS resume",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"done"
]
},
"statements": {
"type": "integer"
},
"transactions": {
"type": "integer"
},
"duplicates": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"accounts": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"statements",
"transactions",
"duplicates",
"warnings",
"accounts"
],
"additionalProperties": false
}
}
}
},
"202": {
"description": "TAN oder entkoppelte Freigabe erforderlich",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"tan"
]
},
"token": {
"type": "string",
"minLength": 40,
"maxLength": 40
},
"challenge": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"challenge_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decoupled": {
"type": "boolean"
},
"nachholen_ab": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"status",
"token",
"challenge",
"challenge_image",
"decoupled",
"nachholen_ab"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "PIN nur je Anfrage; bis 180 Sekunden. 202 verlangt ausdrückliche TAN/Freigabe über resume mit demselben from beim Nachholen. backfill.from vor heute. Fachliche Fehler einschließlich fehlender Verbindung: 422. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"maxLength": 100,
"writeOnly": true
},
"token": {
"type": "string",
"minLength": 40,
"maxLength": 40
},
"tan": {
"anyOf": [
{
"type": "string",
"maxLength": 20,
"writeOnly": true
},
{
"type": "null"
}
]
},
"from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"pin",
"token"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/bank/transactions — Bankumsätze mit unabhängiger Offen-Summe lesen
{
"operationId": "get_api_v1_bank_transactions",
"summary": "Bankumsätze mit unabhängiger Offen-Summe lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Bankumsätze mit unabhängiger Offen-Summe lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BankTransaction"
}
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"pages": {
"type": "integer"
}
},
"required": [
"page",
"per_page",
"total",
"pages"
],
"additionalProperties": false
},
"summary": {
"type": "object",
"properties": {
"open": {
"type": "integer"
},
"unmapped_accounts": {
"type": "integer"
},
"incoming_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"outgoing_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"oldest_on": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"open",
"unmapped_accounts",
"incoming_cents",
"outgoing_cents",
"oldest_on"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta",
"summary"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"open",
"settled",
"all"
]
}
},
{
"name": "bank_account_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "direction",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"in",
"out"
]
}
},
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"default": 100
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500
},
"description": "Älterer Alias für per_page; per_page hat Vorrang."
}
]
}POST /api/v1/bank/transactions/{id}/book — Umsatz ausdrücklich auf Sachkonto buchen
Kein offener Posten erforderlich; Beleg- und Periodensperren gelten. Warnungen sind nicht sperrend. Eine fehlende ID ergibt 422. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_bank_transactions_id_book",
"summary": "Umsatz ausdrücklich auf Sachkonto buchen",
"tags": [
"bank"
],
"responses": {
"201": {
"description": "Umsatz ausdrücklich auf Sachkonto buchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"debit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"credit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"cost_center_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"account",
"debit_cents",
"credit_cents"
],
"additionalProperties": false
}
}
},
"required": [
"entry_number",
"description",
"booking_date",
"lines"
],
"additionalProperties": false
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Kein offener Posten erforderlich; Beleg- und Periodensperren gelten. Warnungen sind nicht sperrend. Eine fehlende ID ergibt 422. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 250
},
{
"type": "null"
}
]
},
"document_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostSplit89"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"account_id"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "transaction.book",
"key_required": false,
"contract": "summator-idempotency/1"
}
}POST /api/v1/bank/transactions/{id}/settle — Umsatz mit offenen Posten ausgleichen
Mit Skonto ohne confirmation nur 200 Vorschau. Danach deren confirmation bewusst bestätigen; 15 Minuten gültig. Kein automatischer Zahlungsvorgang. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_bank_transactions_id_settle",
"summary": "Umsatz mit offenen Posten ausgleichen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Skonto-Vorschau ohne Buchung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"tenant_id": {
"type": "string"
},
"actor_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"transaction_id": {
"type": "integer",
"minimum": 1
},
"statement_id": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string"
},
"bank_account_id": {
"type": "integer",
"minimum": 1
},
"bank_ledger_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"currency": {
"type": "string"
},
"payment_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"minimum": 1
},
"amount_cents": {
"type": "integer",
"minimum": 1
}
},
"required": [
"line_id",
"amount_cents"
],
"additionalProperties": false
}
},
"skonto_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettlementSkontoGroup"
}
},
"remaining_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"confirmation": {
"type": "string"
}
},
"required": [
"rule",
"tenant_id",
"actor_id",
"transaction_id",
"statement_id",
"description",
"bank_account_id",
"bank_ledger_id",
"booking_date",
"currency",
"payment_cents",
"allocations",
"skonto_cents",
"groups",
"remaining_cents",
"confirmation"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"201": {
"description": "Umsatz mit offenen Posten ausgleichen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"skonto_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"group": {
"$ref": "#/components/schemas/SettlementSkontoGroup"
}
},
"required": [
"rule",
"group"
],
"additionalProperties": false
}
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"debit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"credit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"account",
"debit_cents",
"credit_cents"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"skonto_groups",
"entry_number",
"description",
"booking_date",
"lines"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Mit Skonto ohne confirmation nur 200 Vorschau. Danach deren confirmation bewusst bestätigen; 15 Minuten gültig. Kein automatischer Zahlungsvorgang. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"minimum": 1
},
"amount_cents": {
"type": "integer",
"minimum": 1
}
},
"required": [
"line_id",
"amount_cents"
],
"additionalProperties": false
},
"minItems": 1
},
"skonto_percent": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"exclusiveMaximum": 100
},
{
"type": "null"
}
]
},
"skonto_cents": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"confirmation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"allocations"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "transaction.settle",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/bank/transactions/{id}/suggestions — Ausgleichs- und Buchungsvorschläge lesen
{
"operationId": "get_api_v1_bank_transactions_id_suggestions",
"summary": "Ausgleichs- und Buchungsvorschläge lesen",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Ausgleichs- und Buchungsvorschläge lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"counterparty_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"purpose": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"end_to_end_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"booked_on": {
"type": "string",
"format": "date"
},
"purpose_text": {
"type": "string"
}
},
"required": [
"id",
"amount_cents",
"counterparty_name",
"purpose",
"end_to_end_id",
"booked_on",
"purpose_text"
],
"additionalProperties": false
},
"account": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"personal_kind": {
"type": "string"
}
},
"required": [
"id",
"number",
"name",
"personal_kind"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"minimum": 1
},
"account_id": {
"type": "integer",
"minimum": 1
},
"account": {
"type": "string"
},
"entry_number": {
"type": [
"integer",
"null"
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"open_cents": {
"type": "integer"
},
"suggested_cents": {
"type": "integer"
},
"score": {
"type": "integer"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"number_in_purpose": {
"type": "boolean"
},
"partner_recognized": {
"type": "boolean"
}
},
"required": [
"line_id",
"account_id",
"account",
"entry_number",
"booking_date",
"description",
"open_cents",
"suggested_cents",
"score",
"reasons",
"number_in_purpose",
"partner_recognized"
],
"additionalProperties": false
}
},
"booking": {
"anyOf": [
{
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"grund": {
"type": "string"
}
},
"required": [
"account_id",
"tax_key_id",
"grund"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"transaction",
"account",
"candidates",
"booking"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Umsatz fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Schon gebucht; journal_entry_id beigefügt",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"journal_entry_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"message",
"journal_entry_id"
],
"additionalProperties": false
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/bank/csv — CSV prüfen, vorschauen oder ausdrücklich importieren
multipart options[field]. inspect benötigt nur delimiter/encoding; preview/import benötigen CSVOptions vollständig und bank_account_id. import verlangt token aus Vorschau als confirmation bei bytegleicher Datei/Mapping/Entscheidungen. Nur explizite EUR-Umsätze und gebuchter Status; Konflikte bewusst als new oder duplicate:<id> entscheiden. Kein fester Finom-Spaltenplan. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_bank_csv",
"summary": "CSV prüfen, vorschauen oder ausdrücklich importieren",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "CSV prüfen, vorschauen oder ausdrücklich importieren",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
}
},
"profile": {
"type": "string",
"enum": [
"generic",
"finom"
]
},
"suggested_mapping": {
"type": "object",
"description": "Unverbindlicher Spaltenvorschlag: Feldname und nullbasierter Spaltenindex.",
"additionalProperties": {
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"line",
"values"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"headers",
"rows",
"profile",
"suggested_mapping"
],
"additionalProperties": false
},
{
"$ref": "#/components/schemas/CsvPreview"
}
]
}
}
}
},
"201": {
"description": "Original und Umsätze importiert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatementImportResult"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "multipart options[field]. inspect benötigt nur delimiter/encoding; preview/import benötigen CSVOptions vollständig und bank_account_id. import verlangt token aus Vorschau als confirmation bei bytegleicher Datei/Mapping/Entscheidungen. Nur explizite EUR-Umsätze und gebuchter Status; Konflikte bewusst als new oder duplicate:<id> entscheiden. Kein fester Finom-Spaltenplan. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "1 Byte bis 4194304 Bytes, höchstens 5000 Zeilen und 64 Spalten"
},
"mode": {
"type": "string",
"enum": [
"inspect",
"preview",
"import"
]
},
"bank_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"delimiter": {
"type": "string",
"enum": [
";",
","
]
},
"encoding": {
"type": "string",
"enum": [
"UTF-8",
"Windows-1252"
]
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/components/schemas/CsvOptions"
}
]
},
"confirmation": {
"anyOf": [
{
"type": "string",
"minLength": 64,
"maxLength": 64
},
{
"type": "null"
}
]
}
},
"required": [
"file",
"mode",
"options"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"mode": {
"enum": [
"preview",
"import"
]
}
}
},
"then": {
"required": [
"bank_account_id"
],
"properties": {
"bank_account_id": {
"type": "integer",
"minimum": 1
},
"options": {
"$ref": "#/components/schemas/CsvOptions"
}
}
}
},
{
"if": {
"properties": {
"mode": {
"const": "import"
}
}
},
"then": {
"required": [
"confirmation"
],
"properties": {
"confirmation": {
"type": "string",
"minLength": 64,
"maxLength": 64
}
}
}
}
]
}
}
}
}
}GET /api/v1/stripe/connections — Installationsstatus und Stripe-Verbindungen lesen
{
"operationId": "get_api_v1_stripe_connections",
"summary": "Installationsstatus und Stripe-Verbindungen lesen",
"tags": [
"stripe"
],
"responses": {
"200": {
"description": "Installationsstatus und Stripe-Verbindungen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StripeConnection"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"enabled",
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}POST /api/v1/stripe/connections — Browserlink zur bewussten Stripe-Verbindung anfordern
from höchstens heute; Browseranmeldung und Einwilligung erforderlich. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_stripe_connections",
"summary": "Browserlink zur bewussten Stripe-Verbindung anfordern",
"tags": [
"stripe"
],
"responses": {
"201": {
"description": "Browserlink zur bewussten Stripe-Verbindung anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"message": {
"type": "string"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"url",
"message"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "from höchstens heute; Browseranmeldung und Einwilligung erforderlich. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}POST /api/v1/stripe/connections/key — Eigenen eingeschränkten Stripe-Schlüssel verbinden
from höchstens heute. Externer API-Aufruf; kein Schlüssel in Antworten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_stripe_connections_key",
"summary": "Eigenen eingeschränkten Stripe-Schlüssel verbinden",
"tags": [
"stripe"
],
"responses": {
"201": {
"description": "Eigenen eingeschränkten Stripe-Schlüssel verbinden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StripeConnection"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "from höchstens heute. Externer API-Aufruf; kein Schlüssel in Antworten. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255,
"writeOnly": true
},
"from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"key"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/stripe/connections/{id}/fetch — Transaktionen einer Stripe-Verbindung abrufen
Bis 180 Sekunden; Überschneidungen werden per Fingerprint dedupliziert. Kein Zahlungsauftrag. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_stripe_connections_id_fetch",
"summary": "Transaktionen einer Stripe-Verbindung abrufen",
"tags": [
"stripe"
],
"responses": {
"200": {
"description": "Transaktionen einer Stripe-Verbindung abrufen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"statements": {
"type": "integer"
},
"transactions": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"statements",
"transactions",
"warnings"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Bis 180 Sekunden; Überschneidungen werden per Fingerprint dedupliziert. Kein Zahlungsauftrag. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/stripe/connections/{id}/disconnect — Stripe-Geheimnisse entfernen, Historie erhalten
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_stripe_connections_id_disconnect",
"summary": "Stripe-Geheimnisse entfernen, Historie erhalten",
"tags": [
"stripe"
],
"responses": {
"200": {
"description": "Stripe-Geheimnisse entfernen, Historie erhalten",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StripeConnection"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/quotes — Angebote seitenweise lesen
data enthält die Seite, data.data die Angebote. Fest 30 pro Seite; Liste ohne lines, Detail mit lines. Datumsfelder sind UTC-Mitternachtszeitstempel.
{
"operationId": "get_api_v1_quotes",
"summary": "Angebote seitenweise lesen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Angebote seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Quote"
}
},
"first_page_url": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
},
"page": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"label",
"active",
"page"
],
"additionalProperties": false
}
},
"next_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"path": {
"type": "string"
},
"per_page": {
"type": "integer"
},
"prev_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"total": {
"type": "integer"
}
},
"required": [
"current_page",
"data",
"first_page_url",
"from",
"last_page",
"last_page_url",
"links",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "data enthält die Seite, data.data die Angebote. Fest 30 pro Seite; Liste ohne lines, Detail mit lines. Datumsfelder sind UTC-Mitternachtszeitstempel.",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/quotes — Angebotsentwurf speichern; Positionen vollständig ersetzen
Auch PATCH verlangt quote_date und lines. valid_until ab quote_date. Maximal 100 Positionen, netto höchstens 1000000000000 Cent. Nur draft änderbar; keine Ausstellung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_quotes",
"summary": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"tags": [
"quotes"
],
"responses": {
"201": {
"description": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Auch PATCH verlangt quote_date und lines. valid_until ab quote_date. Maximal 100 Positionen, netto höchstens 1000000000000 Cent. Nur draft änderbar; keine Ausstellung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"quote_date": {
"type": "string",
"format": "date"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"intro_text": {
"anyOf": [
{
"type": "string",
"maxLength": 1800
},
{
"type": "null"
}
]
},
"closing_text": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currency": {
"type": "string",
"enum": [
"EUR"
]
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"article_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"unit": {
"anyOf": [
{
"type": "string",
"maxLength": 3
},
{
"type": "null"
}
]
},
"unit_price_cents": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"rate_label": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"quantity"
],
"additionalProperties": false
},
"maxItems": 100
},
"recipient_name": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_street": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_city": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"buyer_reference": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_country": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 2
},
{
"type": "null"
}
]
},
"recipient_postal_code": {
"anyOf": [
{
"type": "string",
"maxLength": 16
},
{
"type": "null"
}
]
},
"recipient_vat_id": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"recipient_email": {
"anyOf": [
{
"type": "string",
"format": "email",
"maxLength": 255
},
{
"type": "null"
}
]
}
},
"required": [
"quote_date",
"lines"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/quotes/{id} — Angebotsfassung mit Positionen lesen
{
"operationId": "get_api_v1_quotes_id",
"summary": "Angebotsfassung mit Positionen lesen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PATCH /api/v1/quotes/{id} — Angebotsentwurf speichern; Positionen vollständig ersetzen
Auch PATCH verlangt quote_date und lines. valid_until ab quote_date. Maximal 100 Positionen, netto höchstens 1000000000000 Cent. Nur draft änderbar; keine Ausstellung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "patch_api_v1_quotes_id",
"summary": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Auch PATCH verlangt quote_date und lines. valid_until ab quote_date. Maximal 100 Positionen, netto höchstens 1000000000000 Cent. Nur draft änderbar; keine Ausstellung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"quote_date": {
"type": "string",
"format": "date"
},
"valid_until": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"intro_text": {
"anyOf": [
{
"type": "string",
"maxLength": 1800
},
{
"type": "null"
}
]
},
"closing_text": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currency": {
"type": "string",
"enum": [
"EUR"
]
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"article_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"unit": {
"anyOf": [
{
"type": "string",
"maxLength": 3
},
{
"type": "null"
}
]
},
"unit_price_cents": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"rate_label": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"quantity"
],
"additionalProperties": false
},
"maxItems": 100
},
"recipient_name": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_street": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_city": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"buyer_reference": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"recipient_country": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 2
},
{
"type": "null"
}
]
},
"recipient_postal_code": {
"anyOf": [
{
"type": "string",
"maxLength": 16
},
{
"type": "null"
}
]
},
"recipient_vat_id": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"recipient_email": {
"anyOf": [
{
"type": "string",
"format": "email",
"maxLength": 255
},
{
"type": "null"
}
]
}
},
"required": [
"quote_date",
"lines"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/quotes/{id}/release — Angebotsfassung endgültig freigeben und Original speichern
Vollständige Absender-/Empfängeranschrift, gültige Frist, Positionen mit Preis, Steuer und Erlöskonto. Noch keine Rechnung/Buchung. Wiederholte Freigabe liefert bestehende Fassung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_quotes_id_release",
"summary": "Angebotsfassung endgültig freigeben und Original speichern",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Angebotsfassung endgültig freigeben und Original speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Vollständige Absender-/Empfängeranschrift, gültige Frist, Positionen mit Preis, Steuer und Erlöskonto. Noch keine Rechnung/Buchung. Wiederholte Freigabe liefert bestehende Fassung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/quotes/{id}/decision — Belegte Angebotsentscheidung erfassen
Nur released; Datum zwischen Freigabe und heute, Annahme nur innerhalb gültiger Frist. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_quotes_id_decision",
"summary": "Belegte Angebotsentscheidung erfassen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Belegte Angebotsentscheidung erfassen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Nur released; Datum zwischen Freigabe und heute, Annahme nur innerhalb gültiger Frist. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"decision": {
"type": "string",
"enum": [
"accepted",
"rejected"
]
},
"decision_on": {
"type": "string",
"format": "date"
},
"decision_source": {
"type": "string",
"maxLength": 500
}
},
"required": [
"decision",
"decision_on",
"decision_source"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/quotes/{id}/revision — Offenes freigegebenes Angebot durch neue Entwurfsfassung ersetzen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_quotes_id_revision",
"summary": "Offenes freigegebenes Angebot durch neue Entwurfsfassung ersetzen",
"tags": [
"quotes"
],
"responses": {
"201": {
"description": "Offenes freigegebenes Angebot durch neue Entwurfsfassung ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Quote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/quotes/{id}/convert — Angenommenes Angebot einmalig in Rechnungsentwurf überführen
Leistungstag oder vollständiger Zeitraum. Bereits konvertiert: dieselbe invoice_id. Keine automatische Ausstellung. Die Antwort hat eine andere Form als GET /invoices. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_quotes_id_convert",
"summary": "Angenommenes Angebot einmalig in Rechnungsentwurf überführen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Angenommenes Angebot einmalig in Rechnungsentwurf überführen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InvoiceRecord"
},
"quote_id": {
"type": "integer",
"minimum": 1
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"quote_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Leistungstag oder vollständiger Zeitraum. Bereits konvertiert: dieselbe invoice_id. Keine automatische Ausstellung. Die Antwort hat eine andere Form als GET /invoices. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "date"
},
"service_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"service_period_from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"service_period_to": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"invoice_date"
],
"additionalProperties": false,
"oneOf": [
{
"required": [
"service_date"
],
"not": {
"anyOf": [
{
"required": [
"service_period_from"
]
},
{
"required": [
"service_period_to"
]
}
]
}
},
{
"required": [
"service_period_from",
"service_period_to"
],
"not": {
"required": [
"service_date"
]
}
}
]
}
}
}
}
}GET /api/v1/quotes/{id}/file — Gespeichertes Angebots-PDF herunterladen
{
"operationId": "get_api_v1_quotes_id_file",
"summary": "Gespeichertes Angebots-PDF herunterladen",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Gespeichertes Angebots-PDF herunterladen",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Entwurf oder unbekannte Fassung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Originalprüfung fehlgeschlagen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/recurring-invoices — Serien seitenweise lesen
Fest 30 pro Seite. Kalenderanker Europe/Berlin; Monatsende bleibt Monatsende; höchstens 2400 Zyklen.
{
"operationId": "get_api_v1_recurring_invoices",
"summary": "Serien seitenweise lesen",
"tags": [
"recurring-invoices"
],
"responses": {
"200": {
"description": "Serien seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecurringInvoice"
}
},
"first_page_url": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
},
"page": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"label",
"active",
"page"
],
"additionalProperties": false
}
},
"next_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"path": {
"type": "string"
},
"per_page": {
"type": "integer"
},
"prev_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"total": {
"type": "integer"
}
},
"required": [
"current_page",
"data",
"first_page_url",
"from",
"last_page",
"last_page_url",
"links",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Fest 30 pro Seite. Kalenderanker Europe/Berlin; Monatsende bleibt Monatsende; höchstens 2400 Zyklen.",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/recurring-invoices — Entwurfserie aus eigenem Rechnungsentwurf anlegen
starts_on ab heute, ends_on ab starts_on. Quelle muss Entwurf mit Kundenkonto und Positionen sein, keine Abschlags-/Schlussrechnung. Nur mode=draft; Ausgabe noch inaktiv. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_recurring_invoices",
"summary": "Entwurfserie aus eigenem Rechnungsentwurf anlegen",
"tags": [
"recurring-invoices"
],
"responses": {
"201": {
"description": "Entwurfserie aus eigenem Rechnungsentwurf anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RecurringInvoice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "starts_on ab heute, ends_on ab starts_on. Quelle muss Entwurf mit Kundenkonto und Positionen sein, keine Abschlags-/Schlussrechnung. Nur mode=draft; Ausgabe noch inaktiv. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"source_invoice_id": {
"type": "integer",
"minimum": 1
},
"starts_on": {
"type": "string",
"format": "date"
},
"ends_on": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"interval_months": {
"type": "integer",
"enum": [
1,
3,
12
]
},
"billing_timing": {
"type": "string",
"enum": [
"advance",
"arrears"
]
},
"mode": {
"type": "string",
"enum": [
"draft"
]
}
},
"required": [
"name",
"source_invoice_id",
"starts_on",
"interval_months",
"billing_timing"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/recurring-invoices/{id} — Serie, Historie, Zustimmung und Vorschau lesen
{
"operationId": "get_api_v1_recurring_invoices_id",
"summary": "Serie, Historie, Zustimmung und Vorschau lesen",
"tags": [
"recurring-invoices"
],
"responses": {
"200": {
"description": "Serie, Historie, Zustimmung und Vorschau lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RecurringInvoice"
},
"automation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecurringAutomation"
}
},
"consent": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"recurring_invoice_id": {
"type": "integer",
"minimum": 1
},
"revision_id": {
"type": "integer",
"minimum": 1
},
"actor_id": {
"type": "integer",
"minimum": 1
},
"tenant_id": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"draft",
"issue",
"send"
]
},
"version": {
"type": "string"
},
"scope": {
"type": "string"
},
"valid_until": {
"type": "string"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"recurring_invoice_id",
"revision_id",
"actor_id",
"tenant_id",
"mode",
"version",
"scope",
"valid_until",
"created_at"
],
"additionalProperties": false
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceJson"
},
"maxItems": 0
}
]
},
"preview": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 2399
},
"due_on": {
"type": "string",
"format": "date"
},
"service_period_from": {
"type": "string",
"format": "date"
},
"service_period_to": {
"type": "string",
"format": "date"
},
"revision_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"gross_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"due_on",
"service_period_from",
"service_period_to",
"revision_id",
"gross_cents"
],
"additionalProperties": false
}
},
"missed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 2399
},
"due_on": {
"type": "string",
"format": "date"
},
"service_period_from": {
"type": "string",
"format": "date"
},
"service_period_to": {
"type": "string",
"format": "date"
},
"revision_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"gross_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"due_on",
"service_period_from",
"service_period_to",
"revision_id",
"gross_cents"
],
"additionalProperties": false
}
},
"supported_modes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"draft"
]
}
},
"interactive_modes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"issue",
"send"
]
}
},
"consent_channel": {
"type": "string",
"enum": [
"web"
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"automation",
"consent",
"preview",
"missed",
"supported_modes",
"interactive_modes",
"consent_channel"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Serie fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/recurring-invoices/{id}/revisions — Zukünftige Serie revisionieren
effective_on nach heute und exakt zukünftiger unverbrauchter Rechnungstermin, gleicher Kunde. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_recurring_invoices_id_revisions",
"summary": "Zukünftige Serie revisionieren",
"tags": [
"recurring-invoices"
],
"responses": {
"201": {
"description": "Zukünftige Serie revisionieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RecurringInvoice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "effective_on nach heute und exakt zukünftiger unverbrauchter Rechnungstermin, gleicher Kunde. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source_invoice_id": {
"type": "integer",
"minimum": 1
},
"effective_on": {
"type": "string",
"format": "date"
}
},
"required": [
"source_invoice_id",
"effective_on"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/recurring-invoices/{id}/{action} — Serie aktivieren, pausieren, fortsetzen oder beenden
activate: confirmed erforderlich. pause/end: kein Body. resume: confirmed und catch_up (auch leere Liste); verpasste nicht gewählte Zyklen werden skipped. Vergangenes activate wird wie resume behandelt. Kein REST-Zustimmungsweg für issue/send. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_recurring_invoices_id_action",
"summary": "Serie aktivieren, pausieren, fortsetzen oder beenden",
"tags": [
"recurring-invoices"
],
"responses": {
"200": {
"description": "Serie aktivieren, pausieren, fortsetzen oder beenden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RecurringInvoice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "activate: confirmed erforderlich. pause/end: kein Body. resume: confirmed und catch_up (auch leere Liste); verpasste nicht gewählte Zyklen werden skipped. Vergangenes activate wird wie resume behandelt. Kein REST-Zustimmungsweg für issue/send. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "action",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"activate",
"pause",
"resume",
"end"
]
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
},
"catch_up": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 2399
},
"maxItems": 2400,
"uniqueItems": true
}
},
"required": [],
"additionalProperties": false
}
}
}
}
}POST /api/v1/recurring-invoices/{id}/run — Einzelnen Zyklus ausdrücklich ausführen
Erzeugt höchstens einen Entwurf je Zyklus. Fehlgeschlagene Wiederholung nur bewusst retry. Automatische issue/send benötigt zuvor eigene Webzustimmung und unveränderten Vertrag; siehe automation/consent im Detail. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_recurring_invoices_id_run",
"summary": "Einzelnen Zyklus ausdrücklich ausführen",
"tags": [
"recurring-invoices"
],
"responses": {
"200": {
"description": "Einzelnen Zyklus ausdrücklich ausführen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/RecurringCycle"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Erzeugt höchstens einen Entwurf je Zyklus. Fehlgeschlagene Wiederholung nur bewusst retry. Automatische issue/send benötigt zuvor eigene Webzustimmung und unveränderten Vertrag; siehe automation/consent im Detail. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 2399
},
"retry": {
"type": "boolean"
}
},
"required": [
"index"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/billing — Abgeleiteten Abozugang und konfigurierte Nettopreise lesen
Erreichbar auch ohne laufendes Abo.
{
"operationId": "get_api_v1_billing",
"summary": "Abgeleiteten Abozugang und konfigurierte Nettopreise lesen",
"tags": [
"billing"
],
"responses": {
"200": {
"description": "Abgeleiteten Abozugang und konfigurierte Nettopreise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access": {
"type": "string",
"enum": [
"pending",
"trial",
"active",
"overdue",
"read_only",
"archived"
]
},
"label": {
"type": "string"
},
"can_write": {
"type": "boolean"
},
"exempt": {
"type": "boolean"
},
"plan": {
"anyOf": [
{
"type": "string",
"enum": [
"monthly",
"yearly"
]
},
{
"type": "null"
}
]
},
"payment_pending": {
"type": "boolean",
"description": "Die erste Zahlung des Abos ist noch nicht eingegangen, etwa eine Lastschrift. Das Abo gibt bis dahin keinen Zugang."
},
"payment_failing": {
"type": "boolean"
},
"payment_due_by": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"trial_ends_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"cancels_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"read_only_until": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"retain_until": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"intro_offer": {
"type": "boolean"
},
"prices": {
"type": "object",
"properties": {
"monthly": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"yearly": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"intro": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"monthly",
"yearly",
"intro"
],
"additionalProperties": false
},
"vat_percent": {
"type": "integer"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"access",
"label",
"can_write",
"exempt",
"plan",
"payment_pending",
"payment_failing",
"payment_due_by",
"trial_ends_at",
"cancels_at",
"read_only_until",
"retain_until",
"intro_offer",
"prices",
"vat_percent"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Erreichbar auch ohne laufendes Abo."
}POST /api/v1/billing/checkout — Abo-checkout-Link anfordern
Mensch öffnet URL; externer Stripe-Vorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_billing_checkout",
"summary": "Abo-checkout-Link anfordern",
"tags": [
"billing"
],
"responses": {
"200": {
"description": "Abo-checkout-Link anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"url"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Mensch öffnet URL; externer Stripe-Vorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"plan": {
"type": "string",
"enum": [
"monthly",
"yearly"
]
}
},
"required": [
"plan"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/billing/portal — Abo-portal-Link anfordern
Mensch öffnet URL; externer Stripe-Vorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_billing_portal",
"summary": "Abo-portal-Link anfordern",
"tags": [
"billing"
],
"responses": {
"200": {
"description": "Abo-portal-Link anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"url"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Mensch öffnet URL; externer Stripe-Vorgang. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz."
}GET /api/v1/reports/trial-balance — Historische Summen- und Saldenliste lesen
{
"operationId": "get_api_v1_reports_trial_balance",
"summary": "Historische Summen- und Saldenliste lesen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Historische Summen- und Saldenliste lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"as_of": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrialBalanceRow"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"as_of",
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "as_of",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
]
}GET /api/v1/reports/open-items — Offene Posten je Partner am Stichtag lesen
{
"operationId": "get_api_v1_reports_open_items",
"summary": "Offene Posten je Partner am Stichtag lesen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Offene Posten je Partner am Stichtag lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"as_of": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"laut_rechnung_bezahlt_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"oldest_date": {
"type": "string",
"format": "date"
},
"days_open": {
"type": "integer"
},
"items": {
"type": "integer"
}
},
"required": [
"account_id",
"number",
"name",
"kind",
"open_cents",
"laut_rechnung_bezahlt_cents",
"oldest_date",
"days_open",
"items"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"as_of",
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "as_of",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
}
}
]
}GET /api/v1/reports/ledger — Kontenblatt ohne Snapshot vorschauen
through ab from. Nur festgeschriebene Historie; Anfangssaldo aus gebundenem Jahresvortrag und folgenden Buchungen, sonst aus gespeicherter Historie. Ein Beginn vor dem letzten gültigen Vortrag ergibt 422 an from.
{
"operationId": "get_api_v1_reports_ledger",
"summary": "Kontenblatt ohne Snapshot vorschauen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Kontenblatt ohne Snapshot vorschauen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"summary": {
"$ref": "#/components/schemas/LedgerSummary"
},
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerRow"
}
},
"page": {
"type": "integer"
},
"per_page": {
"const": 50
},
"generated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"summary",
"rows",
"page",
"per_page",
"generated_at"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "through ab from. Nur festgeschriebene Historie; Anfangssaldo aus gebundenem Jahresvortrag und folgenden Buchungen, sonst aus gespeicherter Historie. Ein Beginn vor dem letzten gültigen Vortrag ergibt 422 an from.",
"parameters": [
{
"name": "account_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "through",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100000000
}
}
]
}POST /api/v1/reports/ledger-exports — Bewusst unveränderlichen Kontenexport speichern
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz. Bei einem Kontenblatt ergibt ein Beginn vor dem letzten gültigen Vortrag 422 an from.
{
"operationId": "post_api_v1_reports_ledger_exports",
"summary": "Bewusst unveränderlichen Kontenexport speichern",
"tags": [
"reports"
],
"responses": {
"201": {
"description": "Bewusst unveränderlichen Kontenexport speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"metadata": {
"$ref": "#/components/schemas/LedgerMetadata"
}
},
"required": [
"id",
"metadata"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz. Bei einem Kontenblatt ergibt ein Beginn vor dem letzten gültigen Vortrag 422 an from.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"from": {
"type": "string",
"format": "date"
},
"through": {
"type": "string",
"format": "date"
},
"kind": {
"type": "string",
"enum": [
"ledger",
"trial_balance"
]
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"kind",
"confirmed",
"through"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "ledger"
}
}
},
"then": {
"required": [
"account_id",
"from"
]
}
}
]
}
}
}
}
}GET /api/v1/reports/ledger-exports/{id} — Exportdaten in Seiten zu 50 lesen
{
"operationId": "get_api_v1_reports_ledger_exports_id",
"summary": "Exportdaten in Seiten zu 50 lesen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Exportdaten in Seiten zu 50 lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"metadata": {
"$ref": "#/components/schemas/LedgerMetadata"
},
"verification_scope": {
"type": "string",
"enum": [
"legacy-stored-sources; historical-visibility-unprovable",
"exact-captured-audit-membership"
]
},
"page": {
"type": "integer"
},
"per_page": {
"const": 50
},
"rows": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/LedgerRow"
},
{
"$ref": "#/components/schemas/TrialBalanceRow"
}
]
}
}
},
"required": [
"id",
"metadata",
"verification_scope",
"page",
"per_page",
"rows"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integritätsfehler",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100000000
}
}
]
}GET /api/v1/reports/ledger-exports/{id}/download — Gespeicherten geprüften Kontenexport herunterladen
{
"operationId": "get_api_v1_reports_ledger_exports_id_download",
"summary": "Gespeicherten geprüften Kontenexport herunterladen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Gespeicherten geprüften Kontenexport herunterladen",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integritäts-/Quellenprüfung gescheitert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültiges Format",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"csv",
"html"
]
},
"description": "Standard csv; beide als application/octet-stream."
}
]
}GET /api/v1/archives/preview — Eigenen vollständigen Archivumfang vorschauen
fiscal_year_id setzt Fokus; Archiv bleibt vollständiger klassifizierter Mandantenbestand, keine künstliche Teilarchivierung.
{
"operationId": "get_api_v1_archives_preview",
"summary": "Eigenen vollständigen Archivumfang vorschauen",
"tags": [
"archives"
],
"responses": {
"200": {
"description": "Eigenen vollständigen Archivumfang vorschauen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArchiveSummary"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "fiscal_year_id setzt Fokus; Archiv bleibt vollständiger klassifizierter Mandantenbestand, keine künstliche Teilarchivierung.",
"parameters": [
{
"name": "fiscal_year_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/archives — Archivkopie bewusst asynchron anfordern
request_key gehört zur identischen Vorschau und Person. Höchstens ein offener Auftrag; gleiche Anfrage liefert vorhandenen Auftrag. Originale werden nicht gelöscht oder neu versioniert. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_archives",
"summary": "Archivkopie bewusst asynchron anfordern",
"tags": [
"archives"
],
"responses": {
"202": {
"description": "Archivkopie bewusst asynchron anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArchivePackage"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "request_key gehört zur identischen Vorschau und Person. Höchstens ein offener Auftrag; gleiche Anfrage liefert vorhandenen Auftrag. Originale werden nicht gelöscht oder neu versioniert. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fiscal_year_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"fingerprint": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"request_key": {
"type": "string",
"format": "uuid"
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"fingerprint",
"request_key",
"confirmed"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/archives/{uuid} — Archivstatus einschließlich Ablauf lesen
{
"operationId": "get_api_v1_archives_uuid",
"summary": "Archivstatus einschließlich Ablauf lesen",
"tags": [
"archives"
],
"responses": {
"200": {
"description": "Archivstatus einschließlich Ablauf lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ArchivePackage"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte/ungültige UUID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/archives/{uuid}/download — Hashgeprüfte ZIP-Archivkopie herunterladen
{
"operationId": "get_api_v1_archives_uuid_download",
"summary": "Hashgeprüfte ZIP-Archivkopie herunterladen",
"tags": [
"archives"
],
"responses": {
"200": {
"description": "Hashgeprüfte ZIP-Archivkopie herunterladen",
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte UUID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Nicht bereit, Kopiensperre oder Integritätsfehler",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"410": {
"description": "Kopie abgelaufen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/euer/reports — Fachliche EÜR-Auswertung als Snapshot erstellen
Einzelunternehmen, angelegtes Kalenderjahr 2025 bis 2027; maximal 10000 Buchungen, 100000 Zeilen, 50000 Zuordnungen und 1000000000 Cent je Buchung. Kein ELSTER-/amtlicher Formularvertrag. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_euer_reports",
"summary": "Fachliche EÜR-Auswertung als Snapshot erstellen",
"tags": [
"euer"
],
"responses": {
"201": {
"description": "Fachliche EÜR-Auswertung als Snapshot erstellen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EuerReport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Nicht unabhängige Transaktion",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Fachprofil oder Berichtsgrenze",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Einzelunternehmen, angelegtes Kalenderjahr 2025 bis 2027; maximal 10000 Buchungen, 100000 Zeilen, 50000 Zuordnungen und 1000000000 Cent je Buchung. Kein ELSTER-/amtlicher Formularvertrag. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"enum": [
2025,
2026,
2027
]
}
},
"required": [
"year"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/euer/reports/{id} — Historischen EÜR-Snapshot mit stale-Hinweis lesen
{
"operationId": "get_api_v1_euer_reports_id",
"summary": "Historischen EÜR-Snapshot mit stale-Hinweis lesen",
"tags": [
"euer"
],
"responses": {
"200": {
"description": "Historischen EÜR-Snapshot mit stale-Hinweis lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EuerReport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Snapshot-Hash falsch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/euer/reports/{id}/revisions — Belegte EÜR-Klärung oder Ergänzung anhängen
case: vorhandener Ereignisschlüssel; withdrawal: Schlüssel einer Klärung, die dieser Bericht als orphaned_resolution, duplicate_resolution oder asset_resolution meldet; mapping: account:<id>; supplement: manual:<1–80 Buchstaben/Ziffern/_/->. Snapshot bleibt unverändert, neue Auswertung für neue Klärung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_euer_reports_id_revisions",
"summary": "Belegte EÜR-Klärung oder Ergänzung anhängen",
"tags": [
"euer"
],
"responses": {
"201": {
"description": "Belegte EÜR-Klärung oder Ergänzung anhängen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"revision_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"revision_id"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integrität/Transaktion",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Veralteter Quellenstand oder unzulässige Klärung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "case: vorhandener Ereignisschlüssel; withdrawal: Schlüssel einer Klärung, die dieser Bericht als orphaned_resolution, duplicate_resolution oder asset_resolution meldet; mapping: account:<id>; supplement: manual:<1–80 Buchstaben/Ziffern/_/->. Snapshot bleibt unverändert, neue Auswertung für neue Klärung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"case",
"supplement",
"mapping",
"withdrawal"
],
"description": "`withdrawal` hebt eine Klärung auf, die der Bericht als `orphaned_resolution`, `duplicate_resolution` oder `asset_resolution` meldet, und braucht weder `rows` noch `role`."
},
"report_year": {
"type": "integer",
"enum": [
2025,
2026,
2027
]
},
"source_key": {
"type": "string",
"maxLength": 120
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"origin": {
"type": "string",
"minLength": 5,
"maxLength": 2000
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"row": {
"type": "string",
"enum": [
"revenue",
"output_vat",
"vat_refund",
"goods",
"staff",
"rent",
"other",
"input_vat",
"vat_paid",
"depreciation",
"excluded"
]
},
"cents": {
"type": "integer",
"minimum": -1000000000,
"maximum": 1000000000
}
},
"required": [
"row",
"cents"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 12
},
"role": {
"type": "string",
"enum": [
"revenue",
"goods",
"staff",
"rent",
"other",
"excluded",
"cash"
]
}
},
"required": [
"kind",
"report_year",
"source_key",
"reason",
"origin"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "mapping"
}
}
},
"then": {
"required": [
"role"
]
}
},
{
"if": {
"properties": {
"kind": {
"enum": [
"case",
"supplement"
]
}
}
},
"then": {
"required": [
"rows"
]
}
}
]
}
}
}
}
}GET /api/v1/euer/reports/{id}/download — Historische EÜR als gespeichertes HTML oder JSON exportieren
{
"operationId": "get_api_v1_euer_reports_id_download",
"summary": "Historische EÜR als gespeichertes HTML oder JSON exportieren",
"tags": [
"euer"
],
"responses": {
"200": {
"description": "Historische EÜR als gespeichertes HTML oder JSON exportieren",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"snapshot_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"source_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"snapshot": {
"$ref": "#/components/schemas/EuerSnapshot"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id",
"snapshot_hash",
"source_hash",
"snapshot"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integrität",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Format",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"html",
"json"
]
},
"description": "Standard html"
}
]
}POST /api/v1/guv/reports — Laufende GuV als Snapshot erstellen
Einzelunternehmen, SKR03/04, Soll/Ist; jeder Zeitraum innerhalb eines angelegten Kalenderjahrs 2025 bis 2027. Gegenperiode muss existieren; keine Nullannahme. Kein Jahresabschluss. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_guv_reports",
"summary": "Laufende GuV als Snapshot erstellen",
"tags": [
"guv"
],
"responses": {
"201": {
"description": "Laufende GuV als Snapshot erstellen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GuvReport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Einzelunternehmen, SKR03/04, Soll/Ist; jeder Zeitraum innerhalb eines angelegten Kalenderjahrs 2025 bis 2027. Gegenperiode muss existieren; keine Nullannahme. Kein Jahresabschluss. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
},
"compare": {
"type": "string",
"enum": [
"none",
"previous_year",
"previous_period"
]
}
},
"required": [
"from",
"to",
"compare"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/guv/reports/{id} — GuV-Snapshot und Veraltungsstatus lesen
{
"operationId": "get_api_v1_guv_reports_id",
"summary": "GuV-Snapshot und Veraltungsstatus lesen",
"tags": [
"guv"
],
"responses": {
"200": {
"description": "GuV-Snapshot und Veraltungsstatus lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GuvReport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integrität",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/guv/reports/{id}/revisions — Belegte GuV-Kontenzuordnung anhängen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_guv_reports_id_revisions",
"summary": "Belegte GuV-Kontenzuordnung anhängen",
"tags": [
"guv"
],
"responses": {
"201": {
"description": "Belegte GuV-Kontenzuordnung anhängen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"revision_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"revision_id"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Integrität",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Veralteter/unzulässiger Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"row_key": {
"type": "string",
"enum": [
"sales",
"inventory",
"own_work",
"other_income",
"materials",
"services",
"wages",
"social",
"depreciation",
"current_depreciation",
"other_expense",
"participation_income",
"securities_income",
"interest_income",
"financial_depreciation",
"interest_expense",
"income_tax",
"other_tax"
]
},
"snapshot_hash": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"origin": {
"type": "string",
"minLength": 5,
"maxLength": 2000
}
},
"required": [
"account_id",
"row_key",
"snapshot_hash",
"reason",
"origin"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/guv/reports/{id}/download — Vertraulichen GuV-Download bewusst anfordern
Stale-Snapshot nur mit historical=true. confidential wird falls vorhanden als accepted geprüft. Hashheader X-Content-SHA256. Protokollierter Download. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_guv_reports_id_download",
"summary": "Vertraulichen GuV-Download bewusst anfordern",
"tags": [
"guv"
],
"responses": {
"200": {
"description": "Vertraulichen GuV-Download bewusst anfordern",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"source_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"snapshot_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"snapshot": {
"$ref": "#/components/schemas/GuvSnapshot"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id",
"source_hash",
"snapshot_hash",
"snapshot"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Hash falsch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Veraltet ohne historical oder Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Stale-Snapshot nur mit historical=true. confidential wird falls vorhanden als accepted geprüft. Hashheader X-Content-SHA256. Protokollierter Download. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"html",
"csv",
"json"
]
},
"confidential": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
},
"snapshot_hash": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"historical": {
"type": "boolean"
}
},
"required": [
"format",
"snapshot_hash"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/datev/preview — DATEV-Paketvorschau mit Hindernissen erstellen
to ab from und innerhalb Wirtschaftsjahr. Explizite Kontenautomatik je Konto. Keine externe DATEV-Annahme; nur festgeschriebene Buchungen, maximal 99999 Exportbuchungen. Unterschiedliche Beleg-/Buchungstage oder Mehrrechnungszahlung im Startprofil gesperrt. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_datev_preview",
"summary": "DATEV-Paketvorschau mit Hindernissen erstellen",
"tags": [
"datev"
],
"responses": {
"200": {
"description": "DATEV-Paketvorschau mit Hindernissen erstellen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DatevPreview"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "to ab from und innerhalb Wirtschaftsjahr. Explizite Kontenautomatik je Konto. Keine externe DATEV-Annahme; nur festgeschriebene Buchungen, maximal 99999 Exportbuchungen. Unterschiedliche Beleg-/Buchungstage oder Mehrrechnungszahlung im Startprofil gesperrt. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fiscal_year_id": {
"type": "integer",
"minimum": 1
},
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
},
"advisor": {
"type": "integer",
"minimum": 1001,
"maximum": 9999999
},
"client": {
"type": "integer",
"minimum": 1,
"maximum": 99999
},
"account_length": {
"type": "integer",
"minimum": 4,
"maximum": 8
},
"account_modes": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string",
"enum": [
"manual",
"automatic700",
"automatic1900"
]
},
{
"type": "null"
}
]
}
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"manual",
"automatic700",
"automatic1900"
]
},
{
"type": "null"
}
]
},
"maxItems": 0
}
]
}
},
"required": [
"fiscal_year_id",
"from",
"to",
"advisor",
"client",
"account_length",
"account_modes"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/datev/packages — DATEV-Paket an geprüfte Vorschau gebunden anfordern
Keine Hindernisse und identischer Fingerprint erforderlich. Paketkopie sieben Tage. Kein automatischer Upload zu DATEV. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_datev_packages",
"summary": "DATEV-Paket an geprüfte Vorschau gebunden anfordern",
"tags": [
"datev"
],
"responses": {
"202": {
"description": "DATEV-Paket an geprüfte Vorschau gebunden anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DatevPackageStatus"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Keine Hindernisse und identischer Fingerprint erforderlich. Paketkopie sieben Tage. Kein automatischer Upload zu DATEV. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fiscal_year_id": {
"type": "integer",
"minimum": 1
},
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
},
"advisor": {
"type": "integer",
"minimum": 1001,
"maximum": 9999999
},
"client": {
"type": "integer",
"minimum": 1,
"maximum": 99999
},
"account_length": {
"type": "integer",
"minimum": 4,
"maximum": 8
},
"account_modes": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string",
"enum": [
"manual",
"automatic700",
"automatic1900"
]
},
{
"type": "null"
}
]
}
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"manual",
"automatic700",
"automatic1900"
]
},
{
"type": "null"
}
]
},
"maxItems": 0
}
]
},
"fingerprint": {
"type": "string",
"minLength": 64,
"maxLength": 64
}
},
"required": [
"fiscal_year_id",
"from",
"to",
"advisor",
"client",
"account_length",
"account_modes",
"fingerprint"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/datev/packages/{id} — DATEV-Paketstatus lesen
{
"operationId": "get_api_v1_datev_packages_id",
"summary": "DATEV-Paketstatus lesen",
"tags": [
"datev"
],
"responses": {
"200": {
"description": "DATEV-Paketstatus lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DatevPackageStatus"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/datev/packages/{id}/download — Geprüftes DATEV-ZIP herunterladen
{
"operationId": "get_api_v1_datev_packages_id_download",
"summary": "Geprüftes DATEV-ZIP herunterladen",
"tags": [
"datev"
],
"responses": {
"200": {
"description": "Geprüftes DATEV-ZIP herunterladen",
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Noch nicht bereit oder Integritätsfehler",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"410": {
"description": "Sieben-Tage-Kopie abgelaufen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/assets — Anlagen und Kontenabgleich lesen
{
"operationId": "get_api_v1_assets",
"summary": "Anlagen und Kontenabgleich lesen",
"tags": [
"assets"
],
"responses": {
"200": {
"description": "Anlagen und Kontenabgleich lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FixedAsset"
}
},
"reconciliation": {
"$ref": "#/components/schemas/AssetReconciliation"
},
"limits": {
"type": "string"
}
},
"required": [
"assets",
"reconciliation",
"limits"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}GET /api/v1/assets/register — Anlagenverzeichnis und Abstimmung zum Stichtag lesen
{
"operationId": "get_api_v1_assets_register",
"summary": "Anlagenverzeichnis und Abstimmung zum Stichtag lesen",
"tags": [
"assets"
],
"responses": {
"200": {
"description": "Anlagenverzeichnis zum Stichtag",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AssetRegister"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "as_of",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"description": "Stichtag, ohne Angabe heute."
}
]
}GET /api/v1/assets/{id} — Anlagenkarte samt unveränderlicher Historie lesen
{
"operationId": "get_api_v1_assets_id",
"summary": "Anlagenkarte samt unveränderlicher Historie lesen",
"tags": [
"assets"
],
"responses": {
"200": {
"description": "Anlagenkarte samt unveränderlicher Historie lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AssetCard"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/assets/actions — Explizite Anlagenaktion ausführen
Nur bewegliche Sachanlagen linear/volle Jahre, gemeinsamer Wertansatz. 1900-01-01 bis vor 2200-01-01; Inbetriebnahme im Anschaffungsmonat. cost=prior+opening exakt nach Plan, Monatsbetrag mindestens 1 Cent. new: geeignetes Gegenkonto, keine bereits verknüpfte Anschaffung; linked/opening: vorhandene belegte Festschreibung. Vorschau/Fingerprint bestätigen. Keine GWG/Gebäude/Sonder-AfA; reverse/close/dispose sind endgültige Fachaktionen. dispose bucht den Restbuchwert gegen counter_account_id und schliesst die Anlage in einem Schritt. Eine Korrekturfassung mit origin=opening, supersedes_id und counter_account_id ohne acquisition_entry_id bucht ihre Eröffnung bei create selbst. register und reconcile lesen zum Stichtag as_of. Nichts läuft von selbst. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_assets_actions",
"summary": "Explizite Anlagenaktion ausführen",
"tags": [
"assets"
],
"responses": {
"200": {
"description": "Explizite Anlagenaktion ausführen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"origin": {
"type": "string",
"enum": [
"new",
"linked",
"opening"
]
},
"acquired_on": {
"type": "string",
"format": "date"
},
"commissioned_on": {
"type": "string",
"format": "date"
},
"opening_on": {
"type": "string",
"format": "date"
},
"cost_cents": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000000
},
"prior_depreciation_cents": {
"type": "integer",
"minimum": 0
},
"opening_book_cents": {
"type": "integer",
"minimum": 1
},
"useful_years": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"method": {
"type": "string",
"enum": [
"linear"
]
},
"profile": {
"type": "string",
"enum": [
"movable-common-basis"
]
},
"asset_account_id": {
"type": "integer",
"minimum": 1
},
"expense_account_id": {
"type": "integer",
"minimum": 1
},
"document_id": {
"type": "integer",
"minimum": 1
},
"acquisition_entry_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"counter_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"supersedes_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"basis_reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
}
},
"required": [
"name",
"origin",
"acquired_on",
"commissioned_on",
"opening_on",
"cost_cents",
"prior_depreciation_cents",
"opening_book_cents",
"useful_years",
"method",
"profile",
"asset_account_id",
"expense_account_id",
"document_id",
"acquisition_entry_id",
"counter_account_id",
"supersedes_id",
"basis_reason"
],
"additionalProperties": false
},
"rule": {
"type": "object",
"properties": {
"version": {
"type": "string"
},
"source": {
"type": "string"
},
"source_sha256": {
"type": "string"
},
"checked_on": {
"type": "string"
},
"rounding": {
"type": "string"
},
"limits": {
"type": "string"
}
},
"required": [
"version",
"source",
"source_sha256",
"checked_on",
"rounding",
"limits"
],
"additionalProperties": false
},
"periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetPeriod"
}
},
"sources": {
"type": "object",
"properties": {
"asset_account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"category_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"name",
"type",
"chart",
"category_code"
],
"additionalProperties": false
},
"expense_account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"category_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"name",
"type",
"chart",
"category_code"
],
"additionalProperties": false
},
"document": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"sha256"
],
"additionalProperties": false
},
"counter_account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"chart": {
"type": "string"
},
"category_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"name",
"type",
"chart",
"category_code"
],
"additionalProperties": false
},
"entry": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"account_id": {
"type": "integer"
},
"debit_cents": {
"type": "integer"
},
"credit_cents": {
"type": "integer"
},
"position": {
"type": "integer"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_center_source_line_id": {
"type": [
"integer",
"null"
],
"minimum": 1
}
},
"required": [
"id",
"account_id",
"debit_cents",
"credit_cents",
"position",
"description",
"tax_key_id"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"entry_number",
"booking_date",
"lines"
],
"additionalProperties": false
}
},
"required": [
"asset_account",
"expense_account",
"document"
],
"additionalProperties": false
},
"tenant_id": {
"type": "string"
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"parameters",
"rule",
"periods",
"sources",
"tenant_id",
"fingerprint"
],
"additionalProperties": false
},
{
"$ref": "#/components/schemas/FixedAsset"
},
{
"$ref": "#/components/schemas/AssetBatchPreview"
},
{
"type": "object",
"properties": {
"approval_id": {
"type": "integer",
"minimum": 1
},
"preview": {
"$ref": "#/components/schemas/AssetBatchPreview"
}
},
"required": [
"approval_id",
"preview"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"run_id": {
"type": "integer",
"minimum": 1
},
"repeated": {
"type": "boolean"
}
},
"required": [
"run_id",
"repeated"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reversal_id": {
"type": "integer",
"minimum": 1
},
"repeated": {
"type": "boolean"
}
},
"required": [
"reversal_id",
"repeated"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"closure_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"closure_id"
],
"additionalProperties": false
},
{
"$ref": "#/components/schemas/AssetCard"
},
{
"$ref": "#/components/schemas/AssetReconciliation"
},
{
"$ref": "#/components/schemas/AssetRegister"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Nur bewegliche Sachanlagen linear/volle Jahre, gemeinsamer Wertansatz. 1900-01-01 bis vor 2200-01-01; Inbetriebnahme im Anschaffungsmonat. cost=prior+opening exakt nach Plan, Monatsbetrag mindestens 1 Cent. new: geeignetes Gegenkonto, keine bereits verknüpfte Anschaffung; linked/opening: vorhandene belegte Festschreibung. Vorschau/Fingerprint bestätigen. Keine GWG/Gebäude/Sonder-AfA; reverse/close/dispose sind endgültige Fachaktionen. dispose bucht den Restbuchwert gegen counter_account_id und schliesst die Anlage in einem Schritt. Eine Korrekturfassung mit origin=opening, supersedes_id und counter_account_id ohne acquisition_entry_id bucht ihre Eröffnung bei create selbst. register und reconcile lesen zum Stichtag as_of. Nichts läuft von selbst. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"preview"
]
},
"name": {
"type": "string",
"maxLength": 200
},
"origin": {
"type": "string",
"enum": [
"new",
"linked",
"opening"
]
},
"acquired_on": {
"type": "string",
"format": "date"
},
"commissioned_on": {
"type": "string",
"format": "date"
},
"opening_on": {
"type": "string",
"format": "date"
},
"cost_cents": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000000
},
"prior_depreciation_cents": {
"type": "integer",
"minimum": 0
},
"opening_book_cents": {
"type": "integer",
"minimum": 1
},
"useful_years": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"method": {
"type": "string",
"enum": [
"linear"
]
},
"profile": {
"type": "string",
"enum": [
"movable-common-basis"
]
},
"asset_account_id": {
"type": "integer",
"minimum": 1
},
"expense_account_id": {
"type": "integer",
"minimum": 1
},
"document_id": {
"type": "integer",
"minimum": 1
},
"acquisition_entry_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"counter_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"supersedes_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"basis_reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
}
},
"required": [
"operation",
"name",
"origin",
"acquired_on",
"commissioned_on",
"opening_on",
"cost_cents",
"prior_depreciation_cents",
"opening_book_cents",
"useful_years",
"method",
"profile",
"asset_account_id",
"expense_account_id",
"document_id",
"basis_reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create"
]
},
"name": {
"type": "string",
"maxLength": 200
},
"origin": {
"type": "string",
"enum": [
"new",
"linked",
"opening"
]
},
"acquired_on": {
"type": "string",
"format": "date"
},
"commissioned_on": {
"type": "string",
"format": "date"
},
"opening_on": {
"type": "string",
"format": "date"
},
"cost_cents": {
"type": "integer",
"minimum": 1,
"maximum": 1000000000000
},
"prior_depreciation_cents": {
"type": "integer",
"minimum": 0
},
"opening_book_cents": {
"type": "integer",
"minimum": 1
},
"useful_years": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"method": {
"type": "string",
"enum": [
"linear"
]
},
"profile": {
"type": "string",
"enum": [
"movable-common-basis"
]
},
"asset_account_id": {
"type": "integer",
"minimum": 1
},
"expense_account_id": {
"type": "integer",
"minimum": 1
},
"document_id": {
"type": "integer",
"minimum": 1
},
"acquisition_entry_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"counter_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"supersedes_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"basis_reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"request_key": {
"type": "string",
"format": "uuid"
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmed": {
"const": true
}
},
"required": [
"operation",
"name",
"origin",
"acquired_on",
"commissioned_on",
"opening_on",
"cost_cents",
"prior_depreciation_cents",
"opening_book_cents",
"useful_years",
"method",
"profile",
"asset_account_id",
"expense_account_id",
"document_id",
"basis_reason",
"request_key",
"fingerprint",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"batch_preview"
]
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"minItems": 1,
"maxItems": 100,
"uniqueItems": true
},
"through": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
}
},
"required": [
"operation",
"ids",
"through"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"approve"
]
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"minItems": 1,
"maxItems": 100,
"uniqueItems": true
},
"through": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmed": {
"const": true
}
},
"required": [
"operation",
"ids",
"through",
"fingerprint",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"run"
]
},
"approval_id": {
"type": "integer",
"minimum": 1
},
"confirmed": {
"const": true
}
},
"required": [
"operation",
"approval_id",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"reverse"
]
},
"posting_id": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"confirmed": {
"const": true
}
},
"required": [
"operation",
"posting_id",
"reason",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"close"
]
},
"asset_id": {
"type": "integer",
"minimum": 1
},
"entry_id": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"confirmed": {
"const": true
}
},
"required": [
"operation",
"asset_id",
"entry_id",
"reason",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"card"
]
},
"asset_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"operation",
"asset_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"reconcile"
]
},
"as_of": {
"type": "string",
"format": "date",
"description": "Stichtag von 1900-01-01 bis vor 2200-01-01, ohne Angabe heute."
}
},
"required": [
"operation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"dispose"
]
},
"asset_id": {
"type": "integer",
"minimum": 1
},
"disposal_on": {
"type": "string",
"format": "date"
},
"counter_account_id": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"confirmed": {
"type": "boolean",
"const": true
}
},
"required": [
"operation",
"asset_id",
"disposal_on",
"counter_account_id",
"reason",
"confirmed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"register"
]
},
"as_of": {
"type": "string",
"format": "date",
"description": "Stichtag von 1900-01-01 bis vor 2200-01-01, ohne Angabe heute."
}
},
"required": [
"operation"
],
"additionalProperties": false
}
]
}
}
}
}
}GET /api/v1/assets/{id}/download — Anlagenkarte als HTML oder JSON herunterladen
{
"operationId": "get_api_v1_assets_id_download",
"summary": "Anlagenkarte als HTML oder JSON herunterladen",
"tags": [
"assets"
],
"responses": {
"200": {
"description": "Anlagenkarte als HTML oder JSON herunterladen",
"content": {
"text/html": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetCard"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"json"
]
},
"description": "json wählt JSON, jeder andere/fehlende Wert HTML."
}
]
}POST /api/v1/invoices/{id}/mail-preview — Rechnungsversand ausdrücklich vorschauen
Nur ausgestellte intakte Originale. XML-Altbeleg verlangt include_xml. Noch keine Mail. from/reply_to müssen gültig sein; ungeeignete Mailtransporte werden abgewiesen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_invoices_id_mail_preview",
"summary": "Rechnungsversand ausdrücklich vorschauen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Rechnungsversand ausdrücklich vorschauen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceMailPreview"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Nur ausgestellte intakte Originale. XML-Altbeleg verlangt include_xml. Noch keine Mail. from/reply_to müssen gültig sein; ungeeignete Mailtransporte werden abgewiesen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient": {
"type": "string",
"format": "email",
"maxLength": 200
},
"include_xml": {
"type": "boolean",
"description": "Ohne Angabe gilt der Standard des Ausgabeprofils: im strukturierten Profil mit XML, sonst ohne."
},
"resend": {
"type": "boolean"
}
},
"required": [
"recipient"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/invoices/{id}/mail — Geprüften Versand verbindlich beauftragen
15-Minuten-Token an Mandant/Person/Original/Empfänger gebunden. 202 bedeutet Auftrag, nicht Zustellung. Nach unklarer Übergabe nicht blind wiederholen; history prüfen. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path="/api/v1/idempotent". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.
{
"operationId": "post_api_v1_invoices_id_mail",
"summary": "Geprüften Versand verbindlich beauftragen",
"tags": [
"invoices"
],
"responses": {
"202": {
"description": "Geprüften Versand verbindlich beauftragen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"delivery_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"delivery_id"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "15-Minuten-Token an Mandant/Person/Original/Empfänger gebunden. 202 bedeutet Auftrag, nicht Zustellung. Nach unklarer Übergabe nicht blind wiederholen; history prüfen. Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Ohne Schlüssel bleibt dieser Legacypfad optional; Idempotency-Policy: legacy-optional; required-path=\"/api/v1/idempotent\". Quittungsheader sind nur nach erfolgreicher Reservierung vorhanden.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string"
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"confirmation",
"confirmed"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "invoice.mail",
"key_required": false,
"contract": "summator-idempotency/1"
}
}GET /api/v1/invoices/{id}/mail — Vollständige Versandhistorie lesen
{
"operationId": "get_api_v1_invoices_id_mail",
"summary": "Vollständige Versandhistorie lesen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Vollständige Versandhistorie lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deliveries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceMailHistory"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"deliveries"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Rechnung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/invoices/{id}/mail/{delivery}/resume — Bestehenden Versandauftrag kontrolliert fortsetzen
Vorhandener Auftrag, kein neues Original/keine neue Rechnung. Nur zulässiger Status und gleiche Person; unklare Übergabe zuerst prüfen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_invoices_id_mail_delivery_resume",
"summary": "Bestehenden Versandauftrag kontrolliert fortsetzen",
"tags": [
"invoices"
],
"responses": {
"202": {
"description": "Bestehenden Versandauftrag kontrolliert fortsetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"delivery_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"delivery_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Vorhandener Auftrag, kein neues Original/keine neue Rechnung. Nur zulässiger Status und gleiche Person; unklare Übergabe zuerst prüfen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "delivery",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/reminders — Überfällige eindeutige Forderungen und Prüfgruppe lesen
{
"operationId": "get_api_v1_reminders",
"summary": "Überfällige eindeutige Forderungen und Prüfgruppe lesen",
"tags": [
"reminders"
],
"responses": {
"200": {
"description": "Überfällige eindeutige Forderungen und Prüfgruppe lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"eligible": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReminderState"
}
},
"review": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"recipient_name": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"invoice_id",
"number",
"recipient_name",
"reason"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"eligible",
"review"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}GET /api/v1/invoices/{id}/reminders — Mahn- und Erinnerungshistorie einer Rechnung lesen
{
"operationId": "get_api_v1_invoices_id_reminders",
"summary": "Mahn- und Erinnerungshistorie einer Rechnung lesen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Mahn- und Erinnerungshistorie einer Rechnung lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"letters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReminderLetter"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"letters"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Rechnung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/invoices/{id}/reminders/preview — Zahlungserinnerung nach bewusster Forderungsprüfung entwerfen
deadline nach heute; disputed muss false sein. Nur überfällige intakte Rechnung mit eindeutigem positivem offenen Posten. Keine unzugeordneten Zahlungen oder Zahlungsstornos. Vorschau speichert kurzlebigen Entwurf, keine Freigabe/Mail. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_invoices_id_reminders_preview",
"summary": "Zahlungserinnerung nach bewusster Forderungsprüfung entwerfen",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Zahlungserinnerung nach bewusster Forderungsprüfung entwerfen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"created"
]
},
"content": {
"$ref": "#/components/schemas/ReminderContent"
},
"confirmation": {
"type": "string"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"id",
"status",
"content",
"confirmation"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "deadline nach heute; disputed muss false sein. Nur überfällige intakte Rechnung mit eindeutigem positivem offenen Posten. Keine unzugeordneten Zahlungen oder Zahlungsstornos. Vorschau speichert kurzlebigen Entwurf, keine Freigabe/Mail. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"stage": {
"type": "string",
"enum": [
"reminder",
"first",
"second"
]
},
"deadline": {
"type": "string",
"format": "date"
},
"checked": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
},
"disputed": {
"type": "boolean"
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 6000
},
{
"type": "null"
}
]
}
},
"required": [
"stage",
"deadline",
"checked",
"disputed"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/reminders/{letter}/release — Erinnerung verbindlich freigeben
Token 15 Minuten, gleiche Person/Stand/Tag. Empfänger, Frist, Forderung und Historie werden erneut geprüft. Eigene UUID, keine Rechnungsnummer oder Buchung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_reminders_letter_release",
"summary": "Erinnerung verbindlich freigeben",
"tags": [
"reminders"
],
"responses": {
"200": {
"description": "Erinnerung verbindlich freigeben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"letter_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"letter_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Token 15 Minuten, gleiche Person/Stand/Tag. Empfänger, Frist, Forderung und Historie werden erneut geprüft. Eigene UUID, keine Rechnungsnummer oder Buchung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "letter",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string"
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"confirmation",
"confirmed"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/reminders/{letter}/send — Erinnerung bewusst versenden
Token 15 Minuten, gleiche Person/Stand/Tag. Empfänger, Frist, Forderung und Historie werden erneut geprüft. Eigene UUID, keine Rechnungsnummer oder Buchung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_reminders_letter_send",
"summary": "Erinnerung bewusst versenden",
"tags": [
"reminders"
],
"responses": {
"202": {
"description": "Erinnerung bewusst versenden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"letter_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"letter_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Token 15 Minuten, gleiche Person/Stand/Tag. Empfänger, Frist, Forderung und Historie werden erneut geprüft. Eigene UUID, keine Rechnungsnummer oder Buchung. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "letter",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string"
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"confirmation",
"confirmed"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/reminders/{letter}/mail-preview — Versand eines freigegebenen Schreibens vorschauen
Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_reminders_letter_mail_preview",
"summary": "Versand eines freigegebenen Schreibens vorschauen",
"tags": [
"reminders"
],
"responses": {
"200": {
"description": "Versand eines freigegebenen Schreibens vorschauen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"letter_id": {
"type": "string",
"format": "uuid"
},
"recipient": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"street": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"name",
"street",
"postal_code",
"city",
"country",
"email"
],
"additionalProperties": false
},
"from": {
"type": "string"
},
"reply_to": {
"type": "string"
},
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"deadline": {
"type": "string",
"format": "date"
},
"pdf_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmation": {
"type": "string"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"letter_id",
"recipient",
"from",
"reply_to",
"subject",
"body",
"open_cents",
"deadline",
"pdf_hash",
"confirmation"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": " Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"parameters": [
{
"name": "letter",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/reminders/{letter}/file — Gespeichertes Erinnerungs-PDF herunterladen
{
"operationId": "get_api_v1_reminders_letter_file",
"summary": "Gespeichertes Erinnerungs-PDF herunterladen",
"tags": [
"reminders"
],
"responses": {
"200": {
"description": "Gespeichertes Erinnerungs-PDF herunterladen",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Schreiben fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Integritätsprüfung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "",
"parameters": [
{
"name": "letter",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/reconciliation — Vorschlagspaare und unverpaarte Ressourcen lesen
{
"operationId": "get_api_v1_reconciliation",
"summary": "Vorschlagspaare und unverpaarte Ressourcen lesen",
"tags": [
"reconciliation"
],
"responses": {
"200": {
"description": "Vorschlagspaare und unverpaarte Ressourcen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"posten",
"beleg"
]
},
"certain": {
"type": "boolean"
},
"manual": {
"type": "boolean"
},
"decision_revision": {
"type": "integer"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"left": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"posten"
]
},
"line_id": {
"type": "integer",
"minimum": 1
},
"account_id": {
"type": "integer",
"minimum": 1
},
"account": {
"type": "string"
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"type",
"line_id",
"account_id",
"account",
"entry_number",
"booking_date",
"description",
"open_cents"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"beleg"
]
},
"document_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"issuer_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tax_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"issued_on": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"gross_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
},
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"document_id",
"name",
"issuer_name",
"invoice_number",
"account",
"account_number",
"account_name",
"account_reason",
"tax_key",
"issued_on",
"gross_cents",
"account_id",
"tax_key_id"
],
"additionalProperties": false
}
]
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"booked_on": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"counterparty_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"counterparty_iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bank_account": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
}
},
"required": [
"id",
"booked_on",
"amount_cents",
"counterparty_name",
"counterparty_iban",
"bank_account",
"purpose"
],
"additionalProperties": false
}
},
"required": [
"key",
"kind",
"certain",
"manual",
"decision_revision",
"reasons",
"amount_cents",
"left",
"transaction"
],
"additionalProperties": false
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"posten"
]
},
"line_id": {
"type": "integer",
"minimum": 1
},
"account_id": {
"type": "integer",
"minimum": 1
},
"account": {
"type": "string"
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"type",
"line_id",
"account_id",
"account",
"entry_number",
"booking_date",
"description",
"open_cents"
],
"additionalProperties": false
}
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"beleg"
]
},
"document_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"issuer_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"account_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tax_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"issued_on": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"gross_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
},
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"document_id",
"name",
"issuer_name",
"invoice_number",
"account",
"account_number",
"account_name",
"account_reason",
"tax_key",
"issued_on",
"gross_cents",
"account_id",
"tax_key_id"
],
"additionalProperties": false
}
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"booked_on": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"counterparty_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"counterparty_iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bank_account": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string"
}
},
"required": [
"id",
"booked_on",
"amount_cents",
"counterparty_name",
"counterparty_iban",
"bank_account",
"purpose"
],
"additionalProperties": false
}
}
},
"required": [
"pairs",
"items",
"documents",
"transactions"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": ""
}POST /api/v1/reconciliation/commit — Ausgewählte Abgleichspaare bewusst festschreiben
Jedes Paar eigene Transaktion; Teilfortschritt möglich. 422 nur wenn committed leer und failed nicht leer, dann data-Hülle statt message. REST nimmt keinen zusätzlichen Vorschau-Fingerprint entgegen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_reconciliation_commit",
"summary": "Ausgewählte Abgleichspaare bewusst festschreiben",
"tags": [
"reconciliation"
],
"responses": {
"200": {
"description": "Ausgewählte Abgleichspaare bewusst festschreiben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"committed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"entry_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"key",
"entry_number",
"entry_id"
],
"additionalProperties": false
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"committed",
"failed"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"committed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"entry_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"key",
"entry_number",
"entry_id"
],
"additionalProperties": false
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"committed",
"failed"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Jedes Paar eigene Transaktion; Teilfortschritt möglich. 422 nur wenn committed leer und failed nicht leer, dann data-Hülle statt message. REST nimmt keinen zusätzlichen Vorschau-Fingerprint entgegen. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"minItems": 1,
"maxItems": 500
},
"certain_only": {
"type": "boolean"
}
},
"required": [
"keys"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/command — Freitext deuten, ohne etwas auszuführen
action/params beschreiben verstandene Absicht. Selbst action=Festschreiben stellt nichts aus und bucht nichts; separate explizite Endpunkte verwenden. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.
{
"operationId": "post_api_v1_command",
"summary": "Freitext deuten, ohne etwas auszuführen",
"tags": [
"command"
],
"responses": {
"200": {
"description": "Freitext deuten, ohne etwas auszuführen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"booking",
"question",
"unknown",
"action"
]
},
"say": {
"type": "string"
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent"
},
{
"type": "null"
}
]
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"account_options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"note": {
"type": "string"
}
},
"required": [
"id",
"key",
"name",
"note"
],
"additionalProperties": false
}
},
"counter_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"needs_account_choice": {
"type": "boolean"
},
"bookable": {
"type": "boolean"
},
"source": {
"type": "string",
"enum": [
"regeln",
"ki"
]
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"action": {
"type": "string",
"enum": [
"buchung",
"abgleich_festschreiben",
"entwuerfe_festschreiben",
"frage"
]
},
"params": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SourceJson"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"kind",
"say",
"amount_cents",
"tax_key_id",
"account_id",
"account_options",
"counter_account_id",
"direction",
"needs_account_choice",
"bookable",
"source",
"model",
"action",
"params"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "action/params beschreiben verstandene Absicht. Selbst action=Festschreiben stellt nichts aus und bucht nichts; separate explizite Endpunkte verwenden. Idempotency-Key wird auf dieser nicht unterstützten Schreibaktion mit 400 idempotency_unsupported abgewiesen; kein allgemeiner Replayschutz.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 500
}
},
"required": [
"text"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/reports/vat — Periodisierte Umsatzsteuer-Vorbereitung mit Vollständigkeitsgrenzen lesen
to ab from, gleicher Kalenderjahrgang. 2026-Formbezug; andere Jahre ungeprüft/keine amtlichen Kennziffern. filing_ready/export_allowed immer false; keine Meldung oder ELSTER-Übermittlung.
{
"operationId": "get_api_v1_reports_vat",
"summary": "Periodisierte Umsatzsteuer-Vorbereitung mit Vollständigkeitsgrenzen lesen",
"tags": [
"reports"
],
"responses": {
"200": {
"description": "Periodisierte Umsatzsteuer-Vorbereitung mit Vollständigkeitsgrenzen lesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VatReport"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "to ab from, gleicher Kalenderjahrgang. 2026-Formbezug; andere Jahre ungeprüft/keine amtlichen Kennziffern. filing_ready/export_allowed immer false; keine Meldung oder ELSTER-Übermittlung.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
]
}POST /api/v1/idempotent/articles — Artikel anlegen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Artikel anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_articles",
"summary": "Artikel anlegen (Pflichtschlüssel)",
"tags": [
"articles"
],
"responses": {
"201": {
"description": "Artikel anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Article"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 200
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"revenue_account_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"is_active": {
"type": "boolean"
},
"closing_text_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Artikel anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "article.create",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/bank/transactions/{id}/book — Umsatz ausdrücklich auf Sachkonto buchen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Umsatz ausdrücklich auf Sachkonto buchen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_bank_transactions_id_book",
"summary": "Umsatz ausdrücklich auf Sachkonto buchen (Pflichtschlüssel)",
"tags": [
"bank"
],
"responses": {
"201": {
"description": "Umsatz ausdrücklich auf Sachkonto buchen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"debit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"credit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"account",
"debit_cents",
"credit_cents"
],
"additionalProperties": false
}
}
},
"required": [
"entry_number",
"description",
"booking_date",
"lines"
],
"additionalProperties": false
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Umsatz ausdrücklich auf Sachkonto buchen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 250
},
{
"type": "null"
}
]
},
"document_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
{
"type": "null"
}
]
}
},
"required": [
"account_id"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "transaction.book",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/bank/transactions/{id}/settle — Umsatz mit offenen Posten ausgleichen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Umsatz mit offenen Posten ausgleichen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_bank_transactions_id_settle",
"summary": "Umsatz mit offenen Posten ausgleichen (Pflichtschlüssel)",
"tags": [
"bank"
],
"responses": {
"200": {
"description": "Skonto-Vorschau ohne Buchung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"tenant_id": {
"type": "string"
},
"actor_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"transaction_id": {
"type": "integer",
"minimum": 1
},
"statement_id": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string"
},
"bank_account_id": {
"type": "integer",
"minimum": 1
},
"bank_ledger_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"currency": {
"type": "string"
},
"payment_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"minimum": 1
},
"amount_cents": {
"type": "integer",
"minimum": 1
}
},
"required": [
"line_id",
"amount_cents"
],
"additionalProperties": false
}
},
"skonto_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettlementSkontoGroup"
}
},
"remaining_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"confirmation": {
"type": "string"
}
},
"required": [
"rule",
"tenant_id",
"actor_id",
"transaction_id",
"statement_id",
"description",
"bank_account_id",
"bank_ledger_id",
"booking_date",
"currency",
"payment_cents",
"allocations",
"skonto_cents",
"groups",
"remaining_cents",
"confirmation"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"201": {
"description": "Umsatz mit offenen Posten ausgleichen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"skonto_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"group": {
"$ref": "#/components/schemas/SettlementSkontoGroup"
}
},
"required": [
"rule",
"group"
],
"additionalProperties": false
}
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"debit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
},
"credit_cents": {
"type": "integer",
"description": "Ganzzahlige Cent"
}
},
"required": [
"account",
"debit_cents",
"credit_cents"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"skonto_groups",
"entry_number",
"description",
"booking_date",
"lines"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Umsatz mit offenen Posten ausgleichen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"minimum": 1
},
"amount_cents": {
"type": "integer",
"minimum": 1
}
},
"required": [
"line_id",
"amount_cents"
],
"additionalProperties": false
},
"minItems": 1
},
"skonto_percent": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"exclusiveMaximum": 100
},
{
"type": "null"
}
]
},
"skonto_cents": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"confirmation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"allocations"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "transaction.settle",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/entries — Buchung erfassen; post=true schreibt unmittelbar fest (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchung erfassen; post=true schreibt unmittelbar fest. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_entries",
"summary": "Buchung erfassen; post=true schreibt unmittelbar fest (Pflichtschlüssel)",
"tags": [
"entries"
],
"responses": {
"201": {
"description": "Buchung erfassen; post=true schreibt unmittelbar fest",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültig, nicht eingerichtet oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"booking_date": {
"type": "string",
"format": "date"
},
"post": {
"type": "boolean"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"minimum": 1
},
"tax_key_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"side": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"amount_cents": {
"type": "integer",
"minimum": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"cost_center_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"cost_splits": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/CostSplit89"
}
}
},
"required": [
"account_id",
"side",
"amount_cents"
],
"additionalProperties": false,
"description": "Optional cost_center_id OR cost_splits on net revenue/expense only. Splits total calculated net cents; tax and contra remain unassigned."
},
"minItems": 1
},
"document_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [
"description",
"lines"
],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchung erfassen; post=true schreibt unmittelbar fest. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "entry.create",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/entries/{id}/post — Buchungsentwurf endgültig festschreiben (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchungsentwurf endgültig festschreiben. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_entries_id_post",
"summary": "Buchungsentwurf endgültig festschreiben (Pflichtschlüssel)",
"tags": [
"entries"
],
"responses": {
"200": {
"description": "Buchungsentwurf endgültig festschreiben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Fachregel, auch eine fehlende ID ergibt 422",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchungsentwurf endgültig festschreiben. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"x-idempotency": {
"operation": "entry.post",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/entries/{id}/reverse — Buchung durch neue Umkehrbuchung korrigieren (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchung durch neue Umkehrbuchung korrigieren. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_entries_id_reverse",
"summary": "Buchung durch neue Umkehrbuchung korrigieren (Pflichtschlüssel)",
"tags": [
"entries"
],
"responses": {
"201": {
"description": "Buchung durch neue Umkehrbuchung korrigieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Entry"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung/Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"returned_on": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Nur bei einer zugeordneten Zahlung: Tag, an dem das Geld tatsächlich zurückgeflossen ist, bei einer Bankzahlung der Buchungstag des Rückgabe-Umsatzes. Der Storno liegt an diesem Tag."
},
"misallocated": {
"type": "boolean",
"description": "Nur bei einer zugeordneten Zahlung aus einem vergangenen Jahr: Das Geld kam an und wurde nur falsch zugeordnet."
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Buchung durch neue Umkehrbuchung korrigieren. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"x-idempotency": {
"operation": "entry.reverse",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/invoices — Unnummerierten Rechnungsentwurf anlegen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Unnummerierten Rechnungsentwurf anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_invoices",
"summary": "Unnummerierten Rechnungsentwurf anlegen (Pflichtschlüssel)",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Unnummerierten Rechnungsentwurf anlegen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Unnummerierten Rechnungsentwurf anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceCreate"
}
}
}
},
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "invoice.create",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/invoices/{id}/issue — Bewusst endgültig ausstellen: Nummer, Original und Buchung (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Bewusst endgültig ausstellen: Nummer, Original und Buchung. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_invoices_id_issue",
"summary": "Bewusst endgültig ausstellen: Nummer, Original und Buchung (Pflichtschlüssel)",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Bewusst endgültig ausstellen: Nummer, Original und Buchung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Pflichtangaben, veralteter Entwurf, geschlossener Zeitraum oder period-Bestätigung erforderlich",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Bewusst endgültig ausstellen: Nummer, Original und Buchung. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirm_past_period": {
"type": "boolean"
},
"expected_draft_hash": {
"type": "string",
"minLength": 64,
"maxLength": 64
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "invoice.issue",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/invoices/{id}/mail — Geprüften Versand verbindlich beauftragen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Geprüften Versand verbindlich beauftragen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_invoices_id_mail",
"summary": "Geprüften Versand verbindlich beauftragen (Pflichtschlüssel)",
"tags": [
"invoices"
],
"responses": {
"202": {
"description": "Geprüften Versand verbindlich beauftragen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"delivery_id": {
"type": "string",
"format": "uuid"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"delivery_id"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Geprüften Versand verbindlich beauftragen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string"
},
"confirmed": {
"enum": [
true,
1,
"1",
"yes",
"on",
"true"
]
}
},
"required": [
"confirmation",
"confirmed"
],
"additionalProperties": false
}
}
}
},
"x-idempotency": {
"operation": "invoice.mail",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/invoices/{id}/reverse — Korrekturrechnung zur ausgestellten Rechnung erzeugen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Korrekturrechnung zur ausgestellten Rechnung erzeugen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad. Die Korrektur mindert die Voranmeldung sofort. Wurde die Leistung gar nicht ausgeführt, kann die Steuer geschuldet bleiben, bis das Finanzamt dem schriftlichen Antrag zugestimmt hat (§ 14c Abs. 2 UStG).
{
"operationId": "post_api_v1_idempotent_invoices_id_reverse",
"summary": "Korrekturrechnung zur ausgestellten Rechnung erzeugen (Pflichtschlüssel)",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Korrekturrechnung zur ausgestellten Rechnung erzeugen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Korrektur nicht zulässig",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Korrekturrechnung zur ausgestellten Rechnung erzeugen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad. Die Korrektur mindert die Voranmeldung sofort. Wurde die Leistung gar nicht ausgeführt, kann die Steuer geschuldet bleiben, bis das Finanzamt dem schriftlichen Antrag zugestimmt hat (§ 14c Abs. 2 UStG).",
"x-idempotency": {
"operation": "invoice.reverse",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/invoices/{id}/settle — Laut Rechnung bezahlte Forderung bewusst nachbuchen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Laut Rechnung bezahlte Forderung bewusst nachbuchen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_invoices_id_settle",
"summary": "Laut Rechnung bezahlte Forderung bewusst nachbuchen (Pflichtschlüssel)",
"tags": [
"invoices"
],
"responses": {
"201": {
"description": "Laut Rechnung bezahlte Forderung bewusst nachbuchen",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Invoice"
},
{
"type": "object",
"properties": {
"settlement": {
"type": "object",
"properties": {
"journal_entry_id": {
"type": "integer",
"minimum": 1
},
"entry_number": {
"type": "string"
},
"booking_date": {
"type": "string",
"format": "date"
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"clearing_account_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"journal_entry_id",
"entry_number",
"booking_date",
"amount_cents",
"clearing_account_id"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"settlement"
]
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Periodenbestätigung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"clearing_account_id": {
"type": "integer",
"minimum": 1
},
"booking_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"confirm_past_period": {
"type": "boolean"
}
},
"required": [
"clearing_account_id"
],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Laut Rechnung bezahlte Forderung bewusst nachbuchen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"x-idempotency": {
"operation": "invoice.settle",
"key_required": true,
"contract": "summator-idempotency/1"
}
}POST /api/v1/idempotent/partners — Personenkonto und damit Kontakt anlegen (Pflichtschlüssel)
Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Personenkonto und damit Kontakt anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.
{
"operationId": "post_api_v1_idempotent_partners",
"summary": "Personenkonto und damit Kontakt anlegen (Pflichtschlüssel)",
"tags": [
"partners"
],
"responses": {
"201": {
"description": "Personenkonto und damit Kontakt anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Partner"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
},
"Idempotency-Policy": {
"schema": {
"type": "string"
},
"description": "Nur bei schlüssellosem Legacyaufruf."
}
}
},
"400": {
"description": "Ungültiges JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"409": {
"description": "Schlüssel-/Transportkonflikt oder ungeklärter processing-Zustand; keine neue Wirkung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyConflict"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"415": {
"description": "Content-Type application/json mit Schlüssel erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyMediaError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"422": {
"description": "Ungültige Angaben oder Kontonummer",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
]
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"428": {
"description": "Auftragsschlüssel fehlt; keine Wirkung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyRequired"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
},
"503": {
"description": "Sicher zurückgerollte Ausnahme; identischen Auftrag wiederholen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyExecutionError"
}
}
},
"headers": {
"Idempotency-Receipt": {
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unveränderliche Quittung, auch bei Konflikt dieselbe reservierte Quittung."
},
"Idempotency-Replayed": {
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"description": "true bei terminalem Replay; Konflikte false."
},
"Idempotency-State": {
"schema": {
"type": "string",
"enum": [
"processing",
"succeeded",
"rejected",
"rolled_back",
"operational_error"
]
}
},
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "Nach reserviertem Auftrag: private, no-store. Vorgeschaltete Auth-/Schlüssel-/Medienfehler besitzen keine Quittung und behalten die jeweilige HTTP-Cacheantwort."
}
}
}
},
"security": [
{
"sanctum": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"kind": {
"type": "string",
"enum": [
"debtor",
"creditor"
]
},
"number": {
"anyOf": [
{
"type": "integer",
"minimum": 10000,
"maximum": 99999
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"kind"
],
"additionalProperties": false
}
}
}
},
"description": "Identität: Mandant + unveränderliche Benutzer-ID + Operation + Schlüsselhash, unabhängig von Tokenrotation und Pflicht-/Legacypfad. Body, Pfadparameter und Query sind typgetreu kanonisiert (Objektschlüssel sortiert, Arrayreihenfolge erhalten). Mit Schlüssel gehören Wirkung, Nummern, Ereignisse und Quittung zusammen, eine Wiederholung löst nichts erneut aus. Erfolg und terminale 4xx wiederholen ursprünglichen Status/Fach-Body; äußere Setup-/Billinghinweise bleiben aktuell. Historische Antwort, kein aktueller Ressourcenstand. Anderer Payload: 409 idempotency_conflict; anderer REST/MCP-Kanal: 409 idempotency_transport_conflict. Ungeklärtes processing: 409 ohne TTL-Neuausführung. rolled_back/operational_error erlauben identischen Wiederholungsauftrag. Keine automatische Retentionlöschung, kein Ablauf reservierter Schlüssel. Aktive Anmeldung, Mandantenzugang, write und Owner/Accountant werden vor jedem Replay geprüft. MCP nutzt optional idempotency_key und result._meta.idempotency; kein Transportwechsel für eine reservierte Operation. Pflichtpfad: ohne Idempotency-Key 428 vor Wirkung. Personenkonto und damit Kontakt anlegen. Fachfelder und Erfolgsantwort entsprechen dem Legacypfad.",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,200}$"
},
"description": "Zufälliger Auftragsschlüssel; gleicher Benutzer/Operation/Mandant. Keine TTL und keine automatische Löschung. Identischen Auftrag nach Transportunsicherheit mit demselben Schlüssel wiederholen."
}
],
"x-idempotency": {
"operation": "partner.create",
"key_required": true,
"contract": "summator-idempotency/1"
}
}GET /api/v1/sync — Eingefrorenes Bootstrap-/Deltafenster lesen
Ohne Cursor konsistenter Bootstrap der sieben öffentlichen Projektionen; resources[] beschränkt den gesamten Folgevertrag. limit 1–500, Standard 100. Cursor bindet Tenant/Benutzer/Rolle/read, Ressourcen, Vertrag, Grenzen, Seitengröße und Frist. Bei Fortsetzung bestimmt der Cursor die Größe; zusätzliches gültiges limit wird ignoriert. Gleiches Eingangscheckpoint findet dasselbe Fenster; ein cursorloser neuer Bootstrap erstellt ein neues Fenster. Alle Seiten eines Fensters werden zusammen eingefroren, es gilt die Reihenfolge, in der Änderungen wirksam wurden, nicht die Zeitstempel. Sperrwartezeit 10s, bei Konflikt 503, später bewusster Abruf mit demselben Cursor. Offene Seiten 86400 Sekunden, abgeschlossener Checkpoint 30×86400 Sekunden ab Fenstererstellung; bei Ablauf >= Frist 410, keine Verlängerung durch Wiederholung. Kein physischer Cleanup. hasMore/windowComplete und leere Fenster atomar mit nextCursor übernehmen; bei Bootstrap erst vollständigen lokalen Bestand ersetzen. Mehrere Events können denselben letzten eingefrorenen Stand abbilden. Deaktiviert bleibt Datensatz mit is_active=false; rechtmäßiges Verwerfen liefert Tombstone. Storno ist Gegenbuchung/reverses-ID, keine Löschung. Historische Zuordnung kann effective=false sein. Kein Original/PDF/XML/Auditdump, keine neue Archivierungsaktion. Bei 401/403/409/410 lokalen Bestand verbergen, nach erneut autorisiertem Bootstrap vollständig ersetzen; keine Fernlöschung fremder Geräte. MCP delta-sync nutzt dieselben Cursor; action=page/resolve, MCP-Fehlerhülle bleibt eigenes Protokoll. Projekte und Projektzeiten ergänzen die bisherigen sieben Ressourcen. Projektmitgliedschaft/Verantwortung ist in Cursorautorisation gebunden; Änderung erfordert 409/Resync. Neue Projektionen und Kommentare werden nach Projektverantwortung/eigener Zeit gefiltert, auch im eingefrorenen Fenster. Keine personenbezogenen Kommentare anderer Mitarbeitender für reine Mitglieder.
{
"operationId": "get_api_v1_sync",
"summary": "Eingefrorenes Bootstrap-/Deltafenster lesen",
"tags": [
"sync"
],
"description": "Ohne Cursor konsistenter Bootstrap der sieben öffentlichen Projektionen; resources[] beschränkt den gesamten Folgevertrag. limit 1–500, Standard 100. Cursor bindet Tenant/Benutzer/Rolle/read, Ressourcen, Vertrag, Grenzen, Seitengröße und Frist. Bei Fortsetzung bestimmt der Cursor die Größe; zusätzliches gültiges limit wird ignoriert. Gleiches Eingangscheckpoint findet dasselbe Fenster; ein cursorloser neuer Bootstrap erstellt ein neues Fenster. Alle Seiten eines Fensters werden zusammen eingefroren, es gilt die Reihenfolge, in der Änderungen wirksam wurden, nicht die Zeitstempel. Sperrwartezeit 10s, bei Konflikt 503, später bewusster Abruf mit demselben Cursor. Offene Seiten 86400 Sekunden, abgeschlossener Checkpoint 30×86400 Sekunden ab Fenstererstellung; bei Ablauf >= Frist 410, keine Verlängerung durch Wiederholung. Kein physischer Cleanup. hasMore/windowComplete und leere Fenster atomar mit nextCursor übernehmen; bei Bootstrap erst vollständigen lokalen Bestand ersetzen. Mehrere Events können denselben letzten eingefrorenen Stand abbilden. Deaktiviert bleibt Datensatz mit is_active=false; rechtmäßiges Verwerfen liefert Tombstone. Storno ist Gegenbuchung/reverses-ID, keine Löschung. Historische Zuordnung kann effective=false sein. Kein Original/PDF/XML/Auditdump, keine neue Archivierungsaktion. Bei 401/403/409/410 lokalen Bestand verbergen, nach erneut autorisiertem Bootstrap vollständig ersetzen; keine Fernlöschung fremder Geräte. MCP delta-sync nutzt dieselben Cursor; action=page/resolve, MCP-Fehlerhülle bleibt eigenes Protokoll. Projekte und Projektzeiten ergänzen die bisherigen sieben Ressourcen. Projektmitgliedschaft/Verantwortung ist in Cursorautorisation gebunden; Änderung erfordert 409/Resync. Neue Projektionen und Kommentare werden nach Projektverantwortung/eigener Zeit gefiltert, auch im eingefrorenen Fenster. Keine personenbezogenen Kommentare anderer Mitarbeitender für reine Mitglieder.",
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Definierte Projektion; Cache-Control private, no-store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeltaPage"
}
}
},
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "private, no-store (Transport darf Reihenfolge normalisieren)"
}
}
},
"400": {
"description": "delta_invalid_cursor (Manipulation oder falscher Mandant)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Ungültiger Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang/Benutzer/read entzogen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "delta_contract_resync_required, delta_authorization_changed_resync_required, delta_scope_changed_resync_required, delta_window_mismatch, delta_history_changed_resync_required oder delta_requires_independent_transaction",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"410": {
"description": "delta_expired_resync_required oder delta_window_missing_resync_required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Eingabe oder delta_invalid_resources/delta_invalid_limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120/min je Tenant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "delta_busy_retry_same_cursor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "cursor",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"maxLength": 8192
}
},
{
"name": "resources",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"allocations",
"articles",
"contacts",
"documents",
"entries",
"invoices",
"payments",
"projects",
"project-time-entries",
"cost-centers"
]
},
"minItems": 1
},
"description": "Schreibweise resources[]=invoices. Sortiert/dedupliziert; bei Folgeseite weglassen oder exakt denselben Scope verwenden."
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"default": 100
}
}
]
}GET /api/v1/sync/resources/{resource}/{id} — Aktuelle autorisierte Ressourcenprojektion auflösen
Aktueller Stand der definierten Projektion, kein historischer Fensterabruf. Unbekannte Ressource oder verschwundene Quelle: 404. Ohne Cursor konsistenter Bootstrap der sieben öffentlichen Projektionen; resources[] beschränkt den gesamten Folgevertrag. limit 1–500, Standard 100. Cursor bindet Tenant/Benutzer/Rolle/read, Ressourcen, Vertrag, Grenzen, Seitengröße und Frist. Bei Fortsetzung bestimmt der Cursor die Größe; zusätzliches gültiges limit wird ignoriert. Gleiches Eingangscheckpoint findet dasselbe Fenster; ein cursorloser neuer Bootstrap erstellt ein neues Fenster. Alle Seiten eines Fensters werden zusammen eingefroren, es gilt die Reihenfolge, in der Änderungen wirksam wurden, nicht die Zeitstempel. Sperrwartezeit 10s, bei Konflikt 503, später bewusster Abruf mit demselben Cursor. Offene Seiten 86400 Sekunden, abgeschlossener Checkpoint 30×86400 Sekunden ab Fenstererstellung; bei Ablauf >= Frist 410, keine Verlängerung durch Wiederholung. Kein physischer Cleanup. hasMore/windowComplete und leere Fenster atomar mit nextCursor übernehmen; bei Bootstrap erst vollständigen lokalen Bestand ersetzen. Mehrere Events können denselben letzten eingefrorenen Stand abbilden. Deaktiviert bleibt Datensatz mit is_active=false; rechtmäßiges Verwerfen liefert Tombstone. Storno ist Gegenbuchung/reverses-ID, keine Löschung. Historische Zuordnung kann effective=false sein. Kein Original/PDF/XML/Auditdump, keine neue Archivierungsaktion. Bei 401/403/409/410 lokalen Bestand verbergen, nach erneut autorisiertem Bootstrap vollständig ersetzen; keine Fernlöschung fremder Geräte. MCP delta-sync nutzt dieselben Cursor; action=page/resolve, MCP-Fehlerhülle bleibt eigenes Protokoll. Projekte und Projektzeiten ergänzen die bisherigen sieben Ressourcen. Projektmitgliedschaft/Verantwortung ist in Cursorautorisation gebunden; Änderung erfordert 409/Resync. Neue Projektionen und Kommentare werden nach Projektverantwortung/eigener Zeit gefiltert, auch im eingefrorenen Fenster. Keine personenbezogenen Kommentare anderer Mitarbeitender für reine Mitglieder.
{
"operationId": "get_api_v1_sync_resources_resource_id",
"summary": "Aktuelle autorisierte Ressourcenprojektion auflösen",
"tags": [
"sync"
],
"description": "Aktueller Stand der definierten Projektion, kein historischer Fensterabruf. Unbekannte Ressource oder verschwundene Quelle: 404. Ohne Cursor konsistenter Bootstrap der sieben öffentlichen Projektionen; resources[] beschränkt den gesamten Folgevertrag. limit 1–500, Standard 100. Cursor bindet Tenant/Benutzer/Rolle/read, Ressourcen, Vertrag, Grenzen, Seitengröße und Frist. Bei Fortsetzung bestimmt der Cursor die Größe; zusätzliches gültiges limit wird ignoriert. Gleiches Eingangscheckpoint findet dasselbe Fenster; ein cursorloser neuer Bootstrap erstellt ein neues Fenster. Alle Seiten eines Fensters werden zusammen eingefroren, es gilt die Reihenfolge, in der Änderungen wirksam wurden, nicht die Zeitstempel. Sperrwartezeit 10s, bei Konflikt 503, später bewusster Abruf mit demselben Cursor. Offene Seiten 86400 Sekunden, abgeschlossener Checkpoint 30×86400 Sekunden ab Fenstererstellung; bei Ablauf >= Frist 410, keine Verlängerung durch Wiederholung. Kein physischer Cleanup. hasMore/windowComplete und leere Fenster atomar mit nextCursor übernehmen; bei Bootstrap erst vollständigen lokalen Bestand ersetzen. Mehrere Events können denselben letzten eingefrorenen Stand abbilden. Deaktiviert bleibt Datensatz mit is_active=false; rechtmäßiges Verwerfen liefert Tombstone. Storno ist Gegenbuchung/reverses-ID, keine Löschung. Historische Zuordnung kann effective=false sein. Kein Original/PDF/XML/Auditdump, keine neue Archivierungsaktion. Bei 401/403/409/410 lokalen Bestand verbergen, nach erneut autorisiertem Bootstrap vollständig ersetzen; keine Fernlöschung fremder Geräte. MCP delta-sync nutzt dieselben Cursor; action=page/resolve, MCP-Fehlerhülle bleibt eigenes Protokoll. Projekte und Projektzeiten ergänzen die bisherigen sieben Ressourcen. Projektmitgliedschaft/Verantwortung ist in Cursorautorisation gebunden; Änderung erfordert 409/Resync. Neue Projektionen und Kommentare werden nach Projektverantwortung/eigener Zeit gefiltert, auch im eingefrorenen Fenster. Keine personenbezogenen Kommentare anderer Mitarbeitender für reine Mitglieder.",
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Definierte Projektion; Cache-Control private, no-store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeltaResolved"
}
}
},
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "private, no-store (Transport darf Reihenfolge normalisieren)"
}
}
},
"401": {
"description": "Ungültiger Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang/Benutzer/read entzogen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Ressource oder Quelle nicht vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120/min je Tenant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "resource",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"allocations",
"articles",
"contacts",
"documents",
"entries",
"invoices",
"payments",
"projects",
"project-time-entries",
"cost-centers"
]
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
},
"description": "Numerischer Pfad; unbekannte/0-ID ergibt 404. Projektionen haben positive Quell-IDs."
}
]
}GET /api/v1/sales-orders — Auftragsbestätigungen · index
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "get_api_v1_sales_orders",
"summary": "Auftragsbestätigungen · index",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Angebote seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesOrder"
}
},
"first_page_url": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
},
"page": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"label",
"active",
"page"
],
"additionalProperties": false
}
},
"next_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"path": {
"type": "string"
},
"per_page": {
"type": "integer"
},
"prev_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"total": {
"type": "integer"
}
},
"required": [
"current_page",
"data",
"first_page_url",
"from",
"last_page",
"last_page_url",
"links",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/sales-orders — Auftragsbestätigungen · store
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "post_api_v1_sales_orders",
"summary": "Auftragsbestätigungen · store",
"tags": [
"sales-orders"
],
"responses": {
"201": {
"description": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quote_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"quote_id"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/sales-orders/{id} — Auftragsbestätigungen · show
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "get_api_v1_sales_orders_id",
"summary": "Auftragsbestätigungen · show",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PATCH /api/v1/sales-orders/{id} — Auftragsbestätigungen · update
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "patch_api_v1_sales_orders_id",
"summary": "Auftragsbestätigungen · update",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Angebotsentwurf speichern; Positionen vollständig ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expected_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"order_reference": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"service_date": {
"type": [
"string",
"null"
]
},
"agreed_schedule": {
"type": [
"string",
"null"
]
},
"conditions": {
"type": [
"string",
"null"
]
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"source_position": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string"
},
"detail": {
"type": [
"string",
"null"
]
},
"quantity": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
{
"type": "string",
"pattern": "^\\d+(\\.\\d{1,6})?$"
}
]
},
"unit": {
"type": "string",
"maxLength": 3
},
"unit_price_cents": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000
}
},
"required": [
"source_position",
"description",
"quantity",
"unit",
"unit_price_cents"
],
"additionalProperties": false
}
}
},
"required": [
"expected_hash",
"order_reference",
"conditions",
"lines"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/sales-orders/{id}/release — Auftragsbestätigungen · release
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "post_api_v1_sales_orders_id_release",
"summary": "Auftragsbestätigungen · release",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Angebotsfassung endgültig freigeben und Original speichern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expected_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmed": {
"const": true
},
"accept_differences": {
"type": "boolean"
}
},
"required": [
"expected_hash",
"confirmed"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/sales-orders/{id}/cancel — Auftragsbestätigungen · cancel
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "post_api_v1_sales_orders_id_cancel",
"summary": "Auftragsbestätigungen · cancel",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Belegte Angebotsentscheidung erfassen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"confirmed",
"reason"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/sales-orders/{id}/revision — Auftragsbestätigungen · revise
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "post_api_v1_sales_orders_id_revision",
"summary": "Auftragsbestätigungen · revise",
"tags": [
"sales-orders"
],
"responses": {
"201": {
"description": "Offenes freigegebenes Angebot durch neue Entwurfsfassung ersetzen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SalesOrder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"confirmed",
"reason"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/sales-orders/{id}/convert — Auftragsbestätigungen · convert
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "post_api_v1_sales_orders_id_convert",
"summary": "Auftragsbestätigungen · convert",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Angenommenes Angebot einmalig in Rechnungsentwurf überführen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InvoiceRecord"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
},
"sales_order_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"data",
"sales_order_id"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expected_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"confirmed": {
"const": true
},
"invoice_date": {
"type": "string",
"format": "date"
},
"service_date": {
"type": "string",
"format": "date"
},
"due_date": {
"type": [
"string",
"null"
],
"format": "date"
}
},
"required": [
"expected_hash",
"confirmed",
"invoice_date",
"service_date"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/sales-orders/{id}/file — Auftragsbestätigungen · file
Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.
{
"operationId": "get_api_v1_sales_orders_id_file",
"summary": "Auftragsbestätigungen · file",
"tags": [
"sales-orders"
],
"responses": {
"200": {
"description": "Gespeichertes Angebots-PDF herunterladen",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Entwurf oder unbekannte Fassung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Originalprüfung fehlgeschlagen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Genau eine aktive Auftragsbestätigung aus einer angenommenen Angebotsfassung. Freigabe dokumentiert die bewusste Nutzerentscheidung. Keine Zahlungsaufforderung, Forderung oder Buchung. convert bereitet genau einen vollständigen gebundenen Rechnungsentwurf vor; identische Wiederholung liefert denselben Beleg. Preise, Anschrift und Leistungsdaten bleiben gebunden; Ausstellung ist separat. Änderungen zuerst speichern und expected_hash aus show prüfen. Abweichungen ausdrücklich bestätigen. Keine Teilabrechnung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/delivery-notes — Lieferscheine · index
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "get_api_deliveries_index",
"summary": "Lieferscheine · index",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebote seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryNote"
}
},
"first_page_url": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
},
"page": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"label",
"active",
"page"
],
"additionalProperties": false
}
},
"next_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"path": {
"type": "string"
},
"per_page": {
"type": "integer"
},
"prev_page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"total": {
"type": "integer"
}
},
"required": [
"current_page",
"data",
"first_page_url",
"from",
"last_page",
"last_page_url",
"links",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt."
}POST /api/v1/delivery-notes — Lieferscheine · store
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "post_api_deliveries_store",
"summary": "Lieferscheine · store",
"tags": [
"delivery-notes"
],
"responses": {
"201": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliveryNote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
},
"request_key": {
"type": "string",
"format": "uuid"
},
"account_id": {
"type": "integer"
},
"delivery_date": {
"type": "string",
"format": "date"
},
"handover_note": {
"type": [
"string",
"null"
]
},
"source_invoice_id": {
"type": [
"integer",
"null"
]
},
"source_sales_order_id": {
"type": [
"integer",
"null"
]
},
"source_quote_id": {
"type": [
"integer",
"null"
]
},
"source_hash": {
"type": [
"string",
"null"
]
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"article_id": {
"type": [
"integer",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"detail": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": "string",
"pattern": "^\\d+(\\.\\d{1,6})?$"
},
"unit": {
"type": [
"string",
"null"
]
},
"source_line_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"quantity"
],
"additionalProperties": false
}
},
"recipient_name": {
"type": [
"string",
"null"
]
},
"recipient_street": {
"type": [
"string",
"null"
]
},
"recipient_postal_code": {
"type": [
"string",
"null"
]
},
"recipient_city": {
"type": [
"string",
"null"
]
},
"recipient_country": {
"type": [
"string",
"null"
]
}
},
"required": [
"request_key",
"account_id",
"delivery_date",
"lines"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/delivery-notes/convert — Lieferscheine · convert
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt. Lieferungen aus Angebot oder Auftrag brauchen keine Preise. Sie nehmen die Preise der Quelle, oder sie werden mit dem vorhandenen Rechnungsentwurf der Quelle verknüpft.
{
"operationId": "post_api_deliveries_convert",
"summary": "Lieferscheine · convert",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InvoiceRecord"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt. Lieferungen aus Angebot oder Auftrag brauchen keine Preise. Sie nehmen die Preise der Quelle, oder sie werden mit dem vorhandenen Rechnungsentwurf der Quelle verknüpft.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
},
"delivery_ids": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "integer"
}
},
"invoice_date": {
"type": "string",
"format": "date"
},
"service_date": {
"type": "string",
"format": "date"
},
"due_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Nur für Lieferungen aus Angebot oder Auftrag."
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"delivery_note_line_id": {
"type": "integer"
},
"unit_price_cents": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"tax_key_id": {
"type": "integer"
},
"revenue_account_id": {
"type": "integer"
}
},
"required": [
"delivery_note_line_id",
"unit_price_cents",
"tax_key_id",
"revenue_account_id"
],
"additionalProperties": false
}
}
},
"required": [
"confirmed",
"delivery_ids",
"invoice_date",
"service_date"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/delivery-notes/sources/{id} — Lieferscheine · source
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "get_api_deliveries_source",
"summary": "Lieferscheine · source",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Quellpositionen mit belegter und restlicher Menge. Stornierte Lieferungen ohne Rechnungsbezug belegen nichts.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliverySource"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "type",
"in": "query",
"required": false,
"description": "Art der Quelle. id ist die Kennung dieser Quelle.",
"schema": {
"type": "string",
"enum": [
"invoice",
"sales_order",
"quote"
],
"default": "invoice"
}
}
]
}GET /api/v1/delivery-notes/{id} — Lieferscheine · show
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "get_api_deliveries_show",
"summary": "Lieferscheine · show",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliveryNote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PATCH /api/v1/delivery-notes/{id} — Lieferscheine · update
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "patch_api_deliveries_update",
"summary": "Lieferscheine · update",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliveryNote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
},
"request_key": {
"type": "string",
"format": "uuid"
},
"account_id": {
"type": "integer"
},
"delivery_date": {
"type": "string",
"format": "date"
},
"handover_note": {
"type": [
"string",
"null"
]
},
"source_invoice_id": {
"type": [
"integer",
"null"
]
},
"source_sales_order_id": {
"type": [
"integer",
"null"
]
},
"source_quote_id": {
"type": [
"integer",
"null"
]
},
"source_hash": {
"type": [
"string",
"null"
]
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"article_id": {
"type": [
"integer",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"detail": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": "string",
"pattern": "^\\d+(\\.\\d{1,6})?$"
},
"unit": {
"type": [
"string",
"null"
]
},
"source_line_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"quantity"
],
"additionalProperties": false
}
},
"recipient_name": {
"type": [
"string",
"null"
]
},
"recipient_street": {
"type": [
"string",
"null"
]
},
"recipient_postal_code": {
"type": [
"string",
"null"
]
},
"recipient_city": {
"type": [
"string",
"null"
]
},
"recipient_country": {
"type": [
"string",
"null"
]
}
},
"required": [
"request_key",
"account_id",
"delivery_date",
"lines"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/delivery-notes/{id}/cancel — Lieferscheine · cancel
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "post_api_deliveries_cancel",
"summary": "Lieferscheine · cancel",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliveryNote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": [
"confirmed",
"reason"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/delivery-notes/{id}/file — Lieferscheine · file
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "get_api_deliveries_file",
"summary": "Lieferscheine · file",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Unverändertes gespeichertes preisloses PDF",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/delivery-notes/{id}/release — Lieferscheine · release
Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.
{
"operationId": "post_api_deliveries_release",
"summary": "Lieferscheine · release",
"tags": [
"delivery-notes"
],
"responses": {
"200": {
"description": "Angebotsfassung mit Positionen lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeliveryNote"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fassung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Eigenständige preislose Lieferungen oder Teilmengen aus genau einer Quelle: normaler Rechnungsentwurf, Auftragsbestätigung oder angenommenes Angebot. Freigabe hält eigene Originalmengen fest, ein Storno ohne Rechnungsbezug gibt sie frei. convert bindet vollständig und einmalig an den vorhandenen Entwurf, bereitet aus Lieferungen von Angebot oder Auftrag einen Entwurf zu den Preisen der Quelle vor oder aus ungebundenen Standalone-Lieferungen nach bewusster Preisprüfung einen gemeinsamen Entwurf. Ausstellung und Versand bleiben separat. Keine Delta-Cursor-/Resolver-Unterstützung für Order/Delivery zugesagt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
},
"reason": {
"type": "string"
}
},
"required": [
"confirmed"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/bwa — Summator Basis-BWA v1: Monat/Quartal, Jahreskumulation und expliziter Vergleich
Reine Auswertung ohne persistente BWA-Tabelle und ohne Finanzmutation/Delta. Alle Summen in EUR-Cent aus festgeschriebenen Journalen nach booking_date; fiscal_years Von/Bis bestimmt die Jahreskumulation. Eigene reportbezogene Zuordnung benötigt zusätzlich das Buchungsrecht (Inhaber oder Buchhaltung, schreibender Zugang), verändert keine Konten oder GuV-Zuordnungen. Nicht zugeordnete Ergebnisanteile bleiben abstimmbar; fehlende/Nullvergleichsbasis hat null percent mit reason. binding trägt den authentifizierten Mandanten-Snapshot samt eingefrorenen HTML/CSV/JSON-Bytes zum Aufrufer, nicht in eine Serverhistorie. Downloads gesondert aufbewahren; ein neuer GET erzeugt einen neuen Datenstand. Keine DATEV-/Steuerberaterkompatibilität, keine Vollständigkeitsfreigabe. Details zu Aussagegrenzen stehen im normalen BWA-Bildschirm und den Downloads.
{
"operationId": "get_api_v1_bwa",
"summary": "Summator Basis-BWA v1: Monat/Quartal, Jahreskumulation und expliziter Vergleich",
"tags": [
"BWA"
],
"responses": {
"200": {
"description": "Snapshot und mandantengebundene Standbindung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BwaResult"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültiger Monat/Zeitraum, kein eindeutiges angelegtes Geschäftsjahr oder unpassende eigene Zuordnung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Reine Auswertung ohne persistente BWA-Tabelle und ohne Finanzmutation/Delta. Alle Summen in EUR-Cent aus festgeschriebenen Journalen nach booking_date; fiscal_years Von/Bis bestimmt die Jahreskumulation. Eigene reportbezogene Zuordnung benötigt zusätzlich das Buchungsrecht (Inhaber oder Buchhaltung, schreibender Zugang), verändert keine Konten oder GuV-Zuordnungen. Nicht zugeordnete Ergebnisanteile bleiben abstimmbar; fehlende/Nullvergleichsbasis hat null percent mit reason. binding trägt den authentifizierten Mandanten-Snapshot samt eingefrorenen HTML/CSV/JSON-Bytes zum Aufrufer, nicht in eine Serverhistorie. Downloads gesondert aufbewahren; ein neuer GET erzeugt einen neuen Datenstand. Keine DATEV-/Steuerberaterkompatibilität, keine Vollständigkeitsfreigabe. Details zu Aussagegrenzen stehen im normalen BWA-Bildschirm und den Downloads.",
"parameters": [
{
"name": "month",
"in": "query",
"required": true,
"schema": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}$"
}
},
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"enum": [
"month",
"quarter"
]
}
},
{
"name": "compare",
"in": "query",
"required": true,
"schema": {
"enum": [
"previous_period",
"previous_year"
]
}
},
{
"name": "mappings",
"in": "query",
"required": false,
"description": "Klammerschreibweise mappings[0][account_id], mappings[0][row], mappings[0][reason]. Maximal 100, nur eigene passende Konten. Nur dieser Snapshot; gespeicherte geprüfte GuV-Zuordnungen werden bei unverändertem Konto wiederverwendet.",
"schema": {
"type": "object",
"maxProperties": 100,
"additionalProperties": {
"$ref": "#/components/schemas/BwaMappingInput"
}
},
"style": "deepObject",
"explode": true
}
]
}POST /api/v1/bwa/download — Eingefrorenen BWA-Stand vertraulich herunterladen
Owner/Accountant + write. Mandantenbindung aus binding wird vor Rückgabe geprüft (fremder Stand: 404); veränderte Bindung: 422. Keine Neuberechnung, kein Journal-/Nummern-/Deltaeffekt und keine neue Downloadtabelle. Identischer binding/format-Aufruf liefert identische Bytes, auch nach neuen Journalen. Natürliche Wiederholbarkeit, keine Idempotenzquittung: Idempotency-Key ist für diese reine Leseaktion nicht unterstützt (400 idempotency_unsupported). Der Umschlag benötigt den ursprünglichen Anwendungsschlüssel; heruntergeladene Formate sind davon unabhängig. Kein Ressourcen-ID-Verweis außerhalb des vorhandenen Mandanten/Journal/Original-Vertrags.
{
"operationId": "post_api_v1_bwa_download",
"summary": "Eingefrorenen BWA-Stand vertraulich herunterladen",
"tags": [
"BWA"
],
"responses": {
"200": {
"description": "Exakte Snapshot-Datei mit Content-Disposition, X-Content-SHA256 und private/no-store",
"headers": {
"X-Content-SHA256": {
"schema": {
"type": "string"
}
},
"Content-Disposition": {
"schema": {
"type": "string"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwaSnapshot"
}
},
"text/csv": {
"schema": {
"type": "string"
}
},
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Idempotency-Key gehört nicht zum Vertrag dieser Leseaktion",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Veraltet ohne historical oder Validierung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"sanctum": []
}
],
"description": "Owner/Accountant + write. Mandantenbindung aus binding wird vor Rückgabe geprüft (fremder Stand: 404); veränderte Bindung: 422. Keine Neuberechnung, kein Journal-/Nummern-/Deltaeffekt und keine neue Downloadtabelle. Identischer binding/format-Aufruf liefert identische Bytes, auch nach neuen Journalen. Natürliche Wiederholbarkeit, keine Idempotenzquittung: Idempotency-Key ist für diese reine Leseaktion nicht unterstützt (400 idempotency_unsupported). Der Umschlag benötigt den ursprünglichen Anwendungsschlüssel; heruntergeladene Formate sind davon unabhängig. Kein Ressourcen-ID-Verweis außerhalb des vorhandenen Mandanten/Journal/Original-Vertrags.",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwaDownloadRequest"
}
}
}
}
}GET /api/v1/year-end — Geschäftsjahre und Abschlussprotokolle
Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe.
{
"operationId": "get_api_v1_year_end_index",
"summary": "Geschäftsjahre und Abschlussprotokolle",
"tags": [
"Jahresabschluss"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Year-end result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YearEndEnvelope"
}
}
}
},
"400": {
"description": "Unsupported Idempotency-Key on this route; use the bound preview for replay",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Missing/invalid/cross-tenant bearer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Insufficient role, scope, access or preview ownership",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Tenant-local review or closure not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validation, stale source, invalid binding or blocking findings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe."
}POST /api/v1/year-end/actions — Prüfen, gebunden bestätigen und kontrolliert früh korrigieren
Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe.
{
"operationId": "post_api_v1_year_end_actions",
"summary": "Prüfen, gebunden bestätigen und kontrolliert früh korrigieren",
"tags": [
"Jahresabschluss"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Year-end result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YearEndEnvelope"
}
}
}
},
"400": {
"description": "Unsupported Idempotency-Key on this route; use the bound preview for replay",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Missing/invalid/cross-tenant bearer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Insufficient role, scope, access or preview ownership",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Tenant-local review or closure not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validation, stale source, invalid binding or blocking findings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YearEndRequest"
}
}
}
}
}GET /api/v1/year-end/{uuid} — Unveränderliches Abschlussprotokoll
Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe.
{
"operationId": "get_api_v1_year_end_show",
"summary": "Unveränderliches Abschlussprotokoll",
"tags": [
"Jahresabschluss"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Year-end result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YearEndEnvelope"
}
}
}
},
"400": {
"description": "Unsupported Idempotency-Key on this route; use the bound preview for replay",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Missing/invalid/cross-tenant bearer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Insufficient role, scope, access or preview ownership",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Tenant-local review or closure not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validation, stale source, invalid binding or blocking findings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Interner Kalenderjahreswechsel EUR SKR03/04. Keine steuerliche oder externe Freigabe. Vorschau enthält konkrete Blocker/Abhilfe und vollständigen Quellenstand; close/reopen verlangt persönliche bewusste Bestätigung genau dieses Standes. Replay desselben Prüfstands ist wiederholsicher, nicht eine neue Freigabe.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/project-time-entries/{id}/{transition} — timer · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_timer",
"summary": "timer · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTime99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "transition",
"in": "path",
"required": true,
"schema": {
"enum": [
"pause",
"resume",
"stop"
]
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ended_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}GET /api/v1/projects — index · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "get_api_v1_api_projects_index",
"summary": "index · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project99"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects — store · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_store",
"summary": "store · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Project99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCreate99"
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}GET /api/v1/projects/{id} — show · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "get_api_v1_api_projects_show",
"summary": "show · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectWorkspace99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/approve — approve · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_approve",
"summary": "approve · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"project_id": {
"type": "integer"
},
"approved": {
"const": true
}
},
"required": [
"project_id",
"approved"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [
"entries"
],
"additionalProperties": false
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/archive — archive · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_archive",
"summary": "archive · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"project_id": {
"type": "integer"
},
"archived": {
"const": true
}
},
"required": [
"project_id",
"archived"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/invoice-draft — prepare · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_prepare",
"summary": "prepare · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectBoundInvoice99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "Idempotency-Key",
"in": "header",
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
},
"description": "Vorhandener optionaler Idempotenzvertrag; gleiche Auswahl/Vorschau ist zusätzlich fachlich einmalig gebunden. 200 auch bei identischem Replay. Neue Freigabe erst nach beendeter Bindung und bewusstem release/approve."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectInvoiceConfirm99"
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/invoice-preview — preview · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_preview",
"summary": "preview · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectInvoicePreview99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectInvoiceInput99"
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/members — member · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab. Deaktivierung verlangt, dass das Teammitglied seinen laufenden oder pausierten Timer in diesem Projekt zuerst beendet. Die Prüfung und der Timerstart sind durch dieselbe Transaktionssperre serialisiert. Bei offenem Timer: 422, errors["member.is_active"], Mitgliedschaft und Rohzeiten unverändert. Nach eigenem Stop erneut deaktivieren; anschließend entfällt die Projektsichtbarkeit.
{
"operationId": "post_api_v1_api_projects_member",
"summary": "member · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"project_id": {
"type": "integer"
},
"saved": {
"const": true
}
},
"required": [
"project_id",
"saved"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe; offener eigener Timer vor Mitgliedschaftsdeaktivierung zu beenden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"user_id",
"is_active"
],
"additionalProperties": false
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab. Deaktivierung verlangt, dass das Teammitglied seinen laufenden oder pausierten Timer in diesem Projekt zuerst beendet. Die Prüfung und der Timerstart sind durch dieselbe Transaktionssperre serialisiert. Bei offenem Timer: 422, errors[\"member.is_active\"], Mitgliedschaft und Rohzeiten unverändert. Nach eigenem Stop erneut deaktivieren; anschließend entfällt die Projektsichtbarkeit."
}POST /api/v1/projects/{id}/release — release · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_release",
"summary": "release · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"project_id": {
"type": "integer"
},
"released": {
"const": true
},
"approval_required": {
"const": true
}
},
"required": [
"project_id",
"released",
"approval_required"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "integer",
"minimum": 1
}
}
},
"required": [
"entries"
],
"additionalProperties": false
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/tasks — task · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_task",
"summary": "task · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTask99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"article_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/projects/{id}/time-entries — record · Projekte, Zeiten und gebundene Entwürfe
Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab.
{
"operationId": "post_api_v1_api_projects_record",
"summary": "record · Projekte, Zeiten und gebundene Entwürfe",
"tags": [
"projects"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Ergebnis der Aktion, keine Buchung/Nummer/Mail bei Vorbereitung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTime99"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder nicht sichtbare mandanten-/mitgliedschaftsgebundene Quelle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Archiviert, Bindung bereits aktiv, Vorschau geändert oder Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Dauer/Zeitzone/Überlappung/Freigabe/Preisquelle/Status oder Eingabe",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeInput99"
}
}
}
},
"description": "Dauer sekundengenau; HALF_UP Stunden auf sechs Stellen. Eine Position pro Eintrag/Leistungstag. Echter gültiger HUR-Artikelpreis des Kunden am expliziten Leistungstag. Aktive/interne/unfreigegebene Zeiten nicht abrechenbar. prepare friert Preisentscheidung ein und erzeugt nur einen normalen Entwurf. discard/issued/reversed bleiben historisch gebunden; release nur nach verworfenem Draft oder ausgestellter Korrektur, danach neue approve. Archivierung erhält Historie. Nur prepare unterstützt Idempotency-Key; andere neue Schreibaktionen lehnen einen Schlüssel als unsupported ab."
}POST /api/v1/balance-sheet — Interne Bilanz erstellen oder gebunden lesen
Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.
{
"operationId": "post_api_v1_balance_show",
"summary": "Interne Bilanz erstellen oder gebunden lesen",
"tags": [
"Interne Bilanz"
],
"security": [
{
"sanctum": []
}
],
"description": "Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceReadRequest"
}
}
}
},
"responses": {
"200": {
"description": "Gebundener interner Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceEnvelope"
}
}
}
},
"401": {
"description": "Nicht angemeldet oder deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"403": {
"description": "Rolle/Zugang/Export verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"404": {
"description": "Fremder Mandant/Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"409": {
"description": "Manipulierte Standhashbindung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"422": {
"description": "Profil, Eingabe, Bestätigung oder Quellstand ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
}
}
}POST /api/v1/balance-sheet/mappings — Begründete neue Reportzuordnung
Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.
{
"operationId": "post_api_v1_balance_mapping",
"summary": "Begründete neue Reportzuordnung",
"tags": [
"Interne Bilanz"
],
"security": [
{
"sanctum": []
}
],
"description": "Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceMapRequest"
}
}
}
},
"responses": {
"200": {
"description": "Gebundener interner Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceEnvelope"
}
}
}
},
"401": {
"description": "Nicht angemeldet oder deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"403": {
"description": "Rolle/Zugang/Export verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"404": {
"description": "Fremder Mandant/Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"409": {
"description": "Manipulierte Standhashbindung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"422": {
"description": "Profil, Eingabe, Bestätigung oder Quellstand ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
}
}
}POST /api/v1/balance-sheet/download — Bewusster reproduzierbarer interner Download
Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.
{
"operationId": "post_api_v1_balance_download",
"summary": "Bewusster reproduzierbarer interner Download",
"tags": [
"Interne Bilanz"
],
"security": [
{
"sanctum": []
}
],
"description": "Internes Summator-Bilanzschema/2, EUR, UG/GmbH, SKR03/04, Kalenderjahr. Vergleich ist vorheriger Jahresstichtag. Kein Testat, E-Bilanz- oder Abgabeschein. Quellbindung enthält Rohjournale, Abschlussrevisionen und Reportzuordnungen. Historische Downloads nur bewusst; fremde oder manipulierte Bindungen werden abgewiesen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceDownloadRequest"
}
}
}
},
"responses": {
"200": {
"description": "Exakte eingefrorene Bytes; keine externe Übermittlung.",
"headers": {
"X-Content-SHA256": {
"schema": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceSnapshot"
}
},
"text/csv": {
"schema": {
"type": "string"
}
},
"application/octet-stream": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Nicht angemeldet oder deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"403": {
"description": "Rolle/Zugang/Export verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"404": {
"description": "Fremder Mandant/Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"409": {
"description": "Manipulierte Standhashbindung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"422": {
"description": "Profil, Eingabe, Bestätigung oder Quellstand ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
},
"429": {
"description": "Rate limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceError"
}
}
}
}
}
}GET /api/v1/cost-centers — Kostenstellen · GET /api/v1/cost-centers
{
"operationId": "get_api_v1_cost_centers",
"summary": "Kostenstellen · GET /api/v1/cost-centers",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchungsänderung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostCenter89"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/cost-centers — Kostenstellen · POST /api/v1/cost-centers
{
"operationId": "post_api_v1_cost_centers",
"summary": "Kostenstellen · POST /api/v1/cost-centers",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Ergebnis der Aktion, keine Buchungsänderung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CostCenter89"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCenterInput89"
}
}
}
}
}PATCH /api/v1/cost-centers/{id} — Kostenstellen · PATCH /api/v1/cost-centers/{id}
{
"operationId": "patch_api_v1_cost_centers_id",
"summary": "Kostenstellen · PATCH /api/v1/cost-centers/{id}",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Ergebnis der Aktion, keine Buchungsänderung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CostCenter89"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name",
"is_active"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/cost-center-reports — Kostenstellen · POST /api/v1/cost-center-reports
{
"operationId": "post_api_v1_cost_center_reports",
"summary": "Kostenstellen · POST /api/v1/cost-center-reports",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Gespeicherter Bericht, vorläufig und reproduzierbar, keine Buchungsänderung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CostCenterReport89"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/cost-center-reports/{id} — Kostenstellen · GET /api/v1/cost-center-reports/{id}
{
"operationId": "get_api_v1_cost_center_reports_id",
"summary": "Kostenstellen · GET /api/v1/cost-center-reports/{id}",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeicherter Bericht, vorläufig und reproduzierbar, keine Buchungsänderung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CostCenterReport89"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/cost-center-reports/{id}/download — Kostenstellen · GET /api/v1/cost-center-reports/{id}/download
{
"operationId": "get_api_v1_cost_center_reports_id_download",
"summary": "Kostenstellen · GET /api/v1/cost-center-reports/{id}/download",
"tags": [
"cost-centers"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Unveränderte eingefrorene Quelle, SHA256 in X-Content-SHA256; gleicher Snapshot liefert gleiche Bytes.",
"headers": {
"X-Content-SHA256": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCenterReport89"
}
},
"text/csv": {
"schema": {
"type": "string"
}
},
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Werte, unbekannte/inaktive Kostenstelle oder unzulässiger Split",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"csv",
"html"
],
"default": "json"
}
}
]
}GET /api/v1/quotes/{id}/portal — Freigabe- und Entscheidungshistorie einer Angebotsfassung
Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.
{
"operationId": "portal76_history",
"summary": "Freigabe- und Entscheidungshistorie einer Angebotsfassung",
"tags": [
"quotes"
],
"description": "Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Freigabe- und Entscheidungshistorie einer Angebotsfassung",
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "private, no-store, max-age=0"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePortalHistory"
}
}
}
},
"400": {
"description": "Idempotency-Key auf diesem Pfad nicht unterstützt"
},
"403": {
"description": "Rolle oder Zugang verweigert"
},
"404": {
"description": "Unbekannte oder fremde Referenz"
},
"409": {
"description": "Fassung ist nicht aktuell freigegeben"
}
}
}POST /api/v1/quotes/{id}/portal — Bewusst neuen fassungsgebundenen Freigabelink erzeugen; ersetzt vorherigen Link
Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.
{
"operationId": "portal76_issue",
"summary": "Bewusst neuen fassungsgebundenen Freigabelink erzeugen; ersetzt vorherigen Link",
"tags": [
"quotes"
],
"description": "Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"201": {
"description": "Bewusst neuen fassungsgebundenen Freigabelink erzeugen; ersetzt vorherigen Link",
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "private, no-store, max-age=0"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePortalIssued"
}
}
}
},
"400": {
"description": "Idempotency-Key auf diesem Pfad nicht unterstützt"
},
"403": {
"description": "Rolle oder Zugang verweigert"
},
"404": {
"description": "Unbekannte oder fremde Referenz"
},
"409": {
"description": "Fassung ist nicht aktuell freigegeben"
}
}
}POST /api/v1/quotes/{id}/portal/{uuid}/revoke — Portalzugang widerrufen, Historie unverändert erhalten
Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.
{
"operationId": "portal76_revoke",
"summary": "Portalzugang widerrufen, Historie unverändert erhalten",
"tags": [
"quotes"
],
"description": "Aktive Mandantenbenutzer; Schreiben nur mit Buchungsrecht und schreibendem Zugang. Fremde oder unbekannte Referenz: 404. Keine Rechnung/Buchung/Mail. Idempotency-Key ist auf diesem Pfad ausdrücklich nicht unterstützt (400); Ausgabe des neuen Roh-Links wird niemals persistiert. Widerruf ohne Schlüssel ist fachlich idempotent.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Portalzugang widerrufen, Historie unverändert erhalten",
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"description": "private, no-store, max-age=0"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePortalHistory"
}
}
}
},
"400": {
"description": "Idempotency-Key auf diesem Pfad nicht unterstützt"
},
"403": {
"description": "Rolle oder Zugang verweigert"
},
"404": {
"description": "Unbekannte oder fremde Referenz"
},
"409": {
"description": "Fassung ist nicht aktuell freigegeben"
}
}
}GET /api/v1/self-billing-agreements — Selbstabrechnung: agreements
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_agreements",
"summary": "Selbstabrechnung: agreements",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SelfBillingAgreement"
}
}
},
"required": [
"data"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage."
}POST /api/v1/self-billing-agreements — Selbstabrechnung: agreement
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_agreement",
"summary": "Selbstabrechnung: agreement",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBillingAgreement"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingAgreementInput"
}
}
}
}
}GET /api/v1/self-billings — Selbstabrechnung: index
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_index",
"summary": "Selbstabrechnung: index",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SelfBilling"
}
}
},
"required": [
"data"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage."
}POST /api/v1/self-billings — Selbstabrechnung: store
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_store",
"summary": "Selbstabrechnung: store",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingInput"
}
}
}
}
}GET /api/v1/self-billings/{id} — Selbstabrechnung: show
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_show",
"summary": "Selbstabrechnung: show",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}PATCH /api/v1/self-billings/{id} — Selbstabrechnung: update
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_update",
"summary": "Selbstabrechnung: update",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingInput"
}
}
}
}
}POST /api/v1/self-billings/{id}/preview — Selbstabrechnung: preview
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_preview",
"summary": "Selbstabrechnung: preview",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"facts": {
"type": "object"
},
"confirmation": {
"type": "string"
},
"scope": {
"type": "string"
}
},
"required": [
"facts",
"confirmation",
"scope"
]
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {}
}
}
}
}POST /api/v1/self-billings/{id}/issue — Selbstabrechnung: issue
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_issue",
"summary": "Selbstabrechnung: issue",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string"
},
"output_profile": {
"const": "pdf"
}
},
"required": [
"confirmation"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/self-billings/{id}/correct — Selbstabrechnung: correct
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_correct",
"summary": "Selbstabrechnung: correct",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"201": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
}
}POST /api/v1/self-billings/{id}/objection — Selbstabrechnung: objection
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_objection",
"summary": "Selbstabrechnung: objection",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes Fachresultat",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SelfBilling"
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"400": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"409": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"415": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"503": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 200
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"occurred_on": {
"type": "string",
"format": "date"
},
"document_id": {
"type": "integer"
}
},
"required": [
"reason",
"occurred_on",
"document_id"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/self-billings/{id}/file — Selbstabrechnung: file
Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.
{
"operationId": "self_billing_file",
"summary": "Selbstabrechnung: file",
"description": "Getrennter Lieferantenweg. Im Betrieb noch nicht verfügbar, neue Vereinbarungen werden abgewiesen. Keine Zahlung/Mail/XML. Bezahlte, beanstandete oder jahresübergreifende Korrektur gesperrt. Kein neues Deltaresource; list/show verwenden. Ganzzahlige Cent; Ausstellaktion nur nach signierter Vorschau.",
"tags": [
"self-billing"
],
"security": [
{
"sanctum": []
}
],
"responses": {
"200": {
"description": "Gespeichertes geprüftes Original PDF; no-store/nosniff",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"403": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"404": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"422": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
},
"429": {
"description": "Anmeldung/Recht/Mandant/Referenz/Validierung/Limit/Idempotenzkonflikt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfBillingError"
}
}
}
}
},
"x-idempotency": "Optional Idempotency-Key mit gesamtem Payload; Konflikt 409. Intrinsisch issue replay, unique Vollkorrektur und Widerspruch. Keine globale exactly-once Zusage.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/fx-settlements — USD-Original gegen belegten EUR-Bankeingang prüfen und bewusst ausgleichen
Profil summator-fx/1, dieselbe Wirkung wie in Oberfläche und MCP. Nur EUR-Bankdatei, deutsches Soll-/Kalenderjahrprofil und USD-Teilbetrag. Datierter Kurs, Quellhash und UUID binden Vorschau/Bestätigung/Replay. Gebühren, Überzahlung, Skonto und Jahresgrenzen werden vor Mutation abgewiesen.
{
"operationId": "post_api_v1_fx_settlements",
"summary": "USD-Original gegen belegten EUR-Bankeingang prüfen und bewusst ausgleichen",
"tags": [
"fx"
],
"description": "Profil summator-fx/1, dieselbe Wirkung wie in Oberfläche und MCP. Nur EUR-Bankdatei, deutsches Soll-/Kalenderjahrprofil und USD-Teilbetrag. Datierter Kurs, Quellhash und UUID binden Vorschau/Bestätigung/Replay. Gebühren, Überzahlung, Skonto und Jahresgrenzen werden vor Mutation abgewiesen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxSettlementRequest"
}
}
}
},
"responses": {
"200": {
"description": "Aktuelle gebundene Vorschau oder derselbe bestätigte Ausgleich; keine zweite Finanzwirkung beim Replay.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxSettlementResponse"
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"committed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entry_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"entry_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"key",
"entry_number",
"entry_id"
],
"additionalProperties": false
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"committed",
"failed"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/documents/{id}/validation — Versionierten Normprüfstand lesen
{
"operationId": "get_api_v1_documents_validation_show",
"summary": "Versionierten Normprüfstand lesen",
"tags": [
"documents"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Tatsächlicher aktueller Prüfstand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncomingValidationResponse"
}
}
}
},
"401": {
"description": "Anmeldung erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Berechtigung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg/Bericht im Mandanten nicht vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Eingabe oder Buchungsentscheidung abgewiesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Anfragelimit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/documents/{id}/validation — Neuen Normprüfbericht anhängen
{
"operationId": "post_api_v1_documents_validation_store",
"summary": "Neuen Normprüfbericht anhängen",
"tags": [
"documents"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"201": {
"description": "Tatsächlicher aktueller Prüfstand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncomingValidationResponse"
}
}
}
},
"401": {
"description": "Anmeldung erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Berechtigung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg/Bericht im Mandanten nicht vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Eingabe oder Buchungsentscheidung abgewiesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Anfragelimit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ruleset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": true
}
}
}
}
}POST /api/v1/documents/{id}/validation/acknowledgements — Aktuellen Prüfstand begründet bestätigen
{
"operationId": "post_api_v1_documents_validation_acknowledge",
"summary": "Aktuellen Prüfstand begründet bestätigen",
"tags": [
"documents"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"201": {
"description": "Tatsächlicher aktueller Prüfstand",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"acknowledgement_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"acknowledgement_id"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"401": {
"description": "Anmeldung erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Berechtigung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg/Bericht im Mandanten nicht vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Eingabe oder Buchungsentscheidung abgewiesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Anfragelimit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"report_id": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
}
},
"required": [
"report_id",
"reason"
],
"additionalProperties": true
}
}
}
}
}GET /api/v1/documents/{id}/validation/{report} — Unveränderten Prüfbericht herunterladen
{
"operationId": "get_api_v1_documents_validation_report",
"summary": "Unveränderten Prüfbericht herunterladen",
"tags": [
"documents"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "report",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "format",
"in": "query",
"schema": {
"enum": [
"json",
"xml",
"embedded"
],
"default": "json"
}
}
],
"responses": {
"200": {
"description": "Tatsächlicher aktueller Prüfstand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncomingValidationRawReport"
}
},
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Anmeldung erforderlich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Berechtigung fehlt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg/Bericht im Mandanten nicht vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Eingabe oder Buchungsentscheidung abgewiesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Anfragelimit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/documents/{id}/visibility — Fehlimport aus- oder einblenden
Nur ungebuchte, ungesperrte Fehlimporte mit Prüfbericht. Das Original bleibt erhalten, jede Änderung steht in der Historie. Schreibrecht und Rolle mit Buchungsrecht erforderlich.
{
"operationId": "post_api_v1_documents_id_visibility",
"summary": "Fehlimport aus- oder einblenden",
"tags": [
"documents"
],
"security": [
{
"sanctum": []
}
],
"description": "Nur ungebuchte, ungesperrte Fehlimporte mit Prüfbericht. Das Original bleibt erhalten, jede Änderung steht in der Historie. Schreibrecht und Rolle mit Buchungsrecht erforderlich.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean"
},
"reason": {
"type": "string",
"minLength": 10,
"maxLength": 2000
}
},
"required": [
"hidden",
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Neuer Stand mit Historie",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean"
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVisibilityEvent"
}
}
},
"required": [
"hidden",
"history"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Beleg gibt es nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Begründung ungültig oder Beleg nicht ausblendbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/reports/vat/xml/preview — UStVA-XML vorprüfen
Vorschau für den manuellen Import in Mein ELSTER. Liefert Werte, Sperren und den Fingerabdruck für die Bestätigung, aber keine XML-Bytes. Summator übermittelt nichts an ELSTER.
{
"operationId": "post_api_v1_reports_vat_xml_preview",
"summary": "UStVA-XML vorprüfen",
"tags": [
"reports"
],
"security": [
{
"sanctum": []
}
],
"description": "Vorschau für den manuellen Import in Mein ELSTER. Liefert Werte, Sperren und den Fingerabdruck für die Bestätigung, aber keine XML-Bytes. Summator übermittelt nichts an ELSTER.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"period": {
"type": "string",
"maxLength": 7,
"description": "Abgeschlossener Monat oder Quartal 2026 gemäß den Einstellungen."
},
"corrected": {
"type": "boolean"
}
},
"required": [
"period",
"corrected"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Vorschau",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VatXmlPreview"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Zeitraum nicht abgeschlossen oder nicht unterstützt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/reports/vat/xml/exports — Gespeicherte UStVA-XML-Dateien auflisten
Neueste zuerst, aus dem unveränderlichen Stand gelesen. „created“ ist der einzige Zustand.
{
"operationId": "get_api_v1_reports_vat_xml_exports",
"summary": "Gespeicherte UStVA-XML-Dateien auflisten",
"tags": [
"reports"
],
"security": [
{
"sanctum": []
}
],
"description": "Neueste zuerst, aus dem unveränderlichen Stand gelesen. „created“ ist der einzige Zustand.",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100000000
}
}
],
"responses": {
"200": {
"description": "Eine Seite",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VatXmlExport"
}
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"page",
"per_page",
"total"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Seite",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/reports/vat/xml/exports — UStVA-XML erzeugen
Bindet den Fingerabdruck der Vorschau. Derselbe Stand liefert dieselbe Datei mit 200, neu entsteht sie mit 201.
{
"operationId": "post_api_v1_reports_vat_xml_exports",
"summary": "UStVA-XML erzeugen",
"tags": [
"reports"
],
"security": [
{
"sanctum": []
}
],
"description": "Bindet den Fingerabdruck der Vorschau. Derselbe Stand liefert dieselbe Datei mit 200, neu entsteht sie mit 201.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"period": {
"type": "string",
"maxLength": 7,
"description": "Abgeschlossener Monat oder Quartal 2026 gemäß den Einstellungen."
},
"corrected": {
"type": "boolean"
},
"fingerprint": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"confirmed": {
"type": "boolean"
}
},
"required": [
"period",
"corrected",
"fingerprint",
"confirmed"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Dieselbe Datei bestand schon",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VatXmlExport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"201": {
"description": "Datei erzeugt",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VatXmlExport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Nicht bestätigt, Sperre oder geänderter Stand",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/reports/vat/xml/exports/{id} — Stand einer UStVA-XML-Datei
Ohne XML-Bytes.
{
"operationId": "get_api_v1_reports_vat_xml_exports_id",
"summary": "Stand einer UStVA-XML-Datei",
"tags": [
"reports"
],
"security": [
{
"sanctum": []
}
],
"description": "Ohne XML-Bytes.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Stand",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VatXmlExport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Datei gibt es nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/reports/vat/xml/exports/{id}/download — UStVA-XML herunterladen
Liefert die gespeicherten Bytes in ISO-8859-15.
{
"operationId": "get_api_v1_reports_vat_xml_exports_id_download",
"summary": "UStVA-XML herunterladen",
"tags": [
"reports"
],
"security": [
{
"sanctum": []
}
],
"description": "Liefert die gespeicherten Bytes in ISO-8859-15.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "XML-Datei",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Datei gibt es nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Die gespeicherte Datei passt nicht mehr zu ihrer Prüfsumme",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/notification-devices — Eigene Geräte auflisten
Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Geräte des angemeldeten Benutzers für Mitteilungen.
{
"operationId": "get_api_v1_notification_devices",
"summary": "Eigene Geräte auflisten",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"description": "Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Geräte des angemeldeten Benutzers für Mitteilungen.",
"responses": {
"200": {
"description": "Geräte",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationDevice"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein App-Token, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/notification-devices/{id}/preferences — Einstellungen eines Geräts lesen
Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens.
{
"operationId": "get_api_v1_notification_devices_id_preferences",
"summary": "Einstellungen eines Geräts lesen",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Gerät",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/NotificationDevice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein App-Token, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Gerät gibt es nicht oder gehört einem anderen Benutzer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens."
}PATCH /api/v1/notification-devices/{id}/preferences — Einstellungen eines Geräts ändern
Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Mit `version` des zuletzt gelesenen Stands.
{
"operationId": "patch_api_v1_notification_devices_id_preferences",
"summary": "Einstellungen eines Geräts ändern",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"description": "Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Mit `version` des zuletzt gelesenen Stands.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1
},
"preferences": {
"type": "object",
"properties": {
"document-review": {
"type": "boolean"
},
"bank-work": {
"type": "boolean"
}
},
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"version",
"preferences"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Gerät",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/NotificationDevice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein App-Token, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Gerät gibt es nicht oder gehört einem anderen Benutzer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Versionskonflikt oder Gerät entzogen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/notification-devices/{id} — Gerät abmelden
Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Danach geht an dieses Gerät nichts mehr.
{
"operationId": "delete_api_v1_notification_devices_id",
"summary": "Gerät abmelden",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"description": "Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. Danach geht an dieses Gerät nichts mehr.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "Abgemeldet"
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein App-Token, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Gerät gibt es nicht oder gehört einem anderen Benutzer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/notification-devices/{id} — Gerät anmelden oder aktualisieren
Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. `version` ist 0 bei der ersten Anmeldung, danach der zuletzt gelesene Stand. Dieselbe `request_id` wiederholt die Anfrage ohne neue Wirkung.
{
"operationId": "put_api_v1_notification_devices_id",
"summary": "Gerät anmelden oder aktualisieren",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"description": "Nur mit dem App-Token der Summator-App, ein API-Schlüssel ergibt 403. Betrifft nur die Geräte dieses Tokens. `version` ist 0 bei der ersten Anmeldung, danach der zuletzt gelesene Stand. Dieselbe `request_id` wiederholt die Anfrage ohne neue Wirkung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Zufällige Installationskennung der App (UUID v4). Die Antwort nennt die Kennung des Geräts für die anderen Aufrufe.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"ios",
"android"
]
},
"provider": {
"type": "string",
"enum": [
"apns",
"fcm"
],
"description": "ios gehört zu apns, android zu fcm."
},
"token": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"description": "Pflicht, wenn permission granted ist."
},
"app_version": {
"type": "string",
"maxLength": 40
},
"permission": {
"type": "string",
"enum": [
"granted",
"denied",
"undetermined"
]
},
"preferences": {
"type": "object",
"properties": {
"document-review": {
"type": "boolean"
},
"bank-work": {
"type": "boolean"
}
},
"additionalProperties": false
},
"version": {
"type": "integer",
"minimum": 0
},
"request_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"platform",
"provider",
"app_version",
"permission",
"version",
"request_id"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Gerät",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/NotificationDevice"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein App-Token, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Gerät gehört einem anderen Benutzer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Versionskonflikt, Gerät entzogen oder Token anderweitig belegt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/notifications/resolve — Ziel einer Mitteilung auflösen
Liefert nur Zieltyp, Kennung und Zustand. Die Inhalte lädt die App danach mit ihrem Zugang. Eine Mitteilung gilt sieben Tage.
{
"operationId": "post_api_v1_notifications_resolve",
"summary": "Ziel einer Mitteilung auflösen",
"tags": [
"notifications"
],
"security": [
{
"sanctum": []
}
],
"description": "Liefert nur Zieltyp, Kennung und Zustand. Die Inhalte lädt die App danach mit ihrem Zugang. Eine Mitteilung gilt sieben Tage.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
}
},
"required": [
"reference"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Ziel",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/NotificationTarget"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Token fehlt, abgelaufen, widerrufen, falscher Mandant oder Benutzer deaktiviert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Zugang, Rolle oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte, abgelaufene oder fremde Mitteilung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 Anfragen je Minute, Mandant und Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/payment-orders — Zahlungsaufträge lesen
Die letzten 100 Zahlungsaufträge mit Zeilen und Zustand. Nur wo Zahlungen freigeschaltet sind, sonst 404.
{
"operationId": "get_api_v1_payment_orders",
"summary": "Zahlungsaufträge lesen",
"tags": [
"bank"
],
"security": [
{
"sanctum": []
}
],
"description": "Die letzten 100 Zahlungsaufträge mit Zeilen und Zustand. Nur wo Zahlungen freigeschaltet sind, sonst 404.",
"responses": {
"200": {
"description": "Zahlungsaufträge lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentOrder"
}
}
},
"required": [
"data"
],
"additionalProperties": true
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Zahlungen sind für dieses Unternehmen nicht freigeschaltet oder der Auftrag existiert nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/payment-orders — Zahlungsauftrag vorbereiten
Bereitet eine Einzel- oder Sammelüberweisung offener Eingangsrechnungen in Euro vor. Empfänger, IBAN, Betrag und Zweck kommen aus dem Beleg, wenn sie fehlen. Mit instant=true wird die Einzelüberweisung als Sofortüberweisung (SCT Inst) vorbereitet; das geht nur mit genau einer Rechnung und nur von einem Konto, dessen Bankzugang über ein gekoppeltes Gerät läuft, sonst 422. Gesendet wird über die API nie. Was in der Oberfläche folgt, hängt vom Bankzugang des Kontos ab: Der Kunde gibt den Auftrag mit Passwort und Code für sein gekoppeltes Gerät frei und sendet ihn dort mit PIN und TAN, er reicht ihn über EBICS mit Passwort und Code ein und gibt ihn in der App seiner Bank frei, oder er sendet ihn (Installation beim Kunden) mit Passwort, Code, PIN und TAN. Eine Sofortüberweisung sendet nur die Summator-App.
{
"operationId": "post_api_v1_payment_orders",
"summary": "Zahlungsauftrag vorbereiten",
"tags": [
"bank"
],
"security": [
{
"sanctum": []
}
],
"description": "Bereitet eine Einzel- oder Sammelüberweisung offener Eingangsrechnungen in Euro vor. Empfänger, IBAN, Betrag und Zweck kommen aus dem Beleg, wenn sie fehlen. Mit instant=true wird die Einzelüberweisung als Sofortüberweisung (SCT Inst) vorbereitet; das geht nur mit genau einer Rechnung und nur von einem Konto, dessen Bankzugang über ein gekoppeltes Gerät läuft, sonst 422. Gesendet wird über die API nie. Was in der Oberfläche folgt, hängt vom Bankzugang des Kontos ab: Der Kunde gibt den Auftrag mit Passwort und Code für sein gekoppeltes Gerät frei und sendet ihn dort mit PIN und TAN, er reicht ihn über EBICS mit Passwort und Code ein und gibt ihn in der App seiner Bank frei, oder er sendet ihn (Installation beim Kunden) mit Passwort, Code, PIN und TAN. Eine Sofortüberweisung sendet nur die Summator-App.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bank_account_id": {
"type": "integer"
},
"instant": {
"type": "boolean",
"description": "true: Sofortüberweisung (SCT Inst). Ohne Angabe eine Standardüberweisung. Nur mit genau einer Rechnung und nur von einem Konto, dessen Bankzugang über ein gekoppeltes Gerät läuft."
},
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"description": "Buchungszeile einer Eingangsrechnung der Buchhaltung (open-items). Genau eines von line_id oder dms_document_id."
},
"dms_document_id": {
"type": "integer",
"description": "Rechnungsdokument im Summator DMS (Eingangsrechnung mit bestätigten Rechnungsangaben, zahlbar nach der letzten Freigabestufe). Genau eines von line_id oder dms_document_id."
},
"recipient_name": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
},
"amount_cents": {
"type": "integer",
"minimum": 1
},
"purpose": {
"type": "string"
}
},
"minProperties": 1
}
}
},
"required": [
"bank_account_id",
"items"
]
}
}
}
},
"responses": {
"201": {
"description": "Vorbereitet",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentOrder"
}
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/payment-orders/{id} — Einen Zahlungsauftrag lesen
Ein Zahlungsauftrag mit Zeilen, Antwort der Bank und Empfängerprüfung.
{
"operationId": "get_api_v1_payment_orders_id",
"summary": "Einen Zahlungsauftrag lesen",
"tags": [
"bank"
],
"security": [
{
"sanctum": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"description": "Ein Zahlungsauftrag mit Zeilen, Antwort der Bank und Empfängerprüfung.",
"responses": {
"200": {
"description": "Einen Zahlungsauftrag lesen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentOrder"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Zahlungen sind für dieses Unternehmen nicht freigeschaltet oder der Auftrag existiert nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/geraet/koppeln — Gerät mit Kopplungscode koppeln
Die App oder die Browser-Erweiterung löst den Kopplungscode aus Summator (Bank → Verbindungen, 15 Minuten gültig) genau einmal gegen einen Geräteschlüssel ein. Der Schlüssel steht nur in dieser Antwort.
{
"operationId": "post_api_geraet_koppeln",
"summary": "Gerät mit Kopplungscode koppeln",
"description": "Die App oder die Browser-Erweiterung löst den Kopplungscode aus Summator (Bank → Verbindungen, 15 Minuten gültig) genau einmal gegen einen Geräteschlüssel ein. Der Schlüssel steht nur in dieser Antwort.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"201": {
"description": "Geräteschlüssel, Gerät und Bankverbindung",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"422": {
"description": "Code unbekannt, abgelaufen oder schon eingelöst; oder Zugangsdaten im Körper",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "10 je Minute",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Acht Zeichen, mit oder ohne Bindestrich"
}
},
"required": [
"code"
],
"additionalProperties": false
}
}
}
}
}GET /api/v1/geraet — Gerät, Bankverbindung und Abrufstand
Bankverbindung, ihre Konten mit dem Tag, bis zu dem abgerufen ist, letzter Kontostand und wie viele freigegebene Zahlungen warten. Daraus berechnet das Gerät, ab wann es bei der Bank abruft.
{
"operationId": "get_api_geraet_show",
"summary": "Gerät, Bankverbindung und Abrufstand",
"description": "Bankverbindung, ihre Konten mit dem Tag, bis zu dem abgerufen ist, letzter Kontostand und wie viele freigegebene Zahlungen warten. Daraus berechnet das Gerät, ab wann es bei der Bank abruft.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Gerät und Bankverbindung",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/geraet — Gerät abmelden
Widerruft den eigenen Geräteschlüssel endgültig.
{
"operationId": "delete_api_geraet_abmelden",
"summary": "Gerät abmelden",
"description": "Widerruft den eigenen Geräteschlüssel endgültig.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Widerrufen",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/geraet/umsaetze — Abgerufene Umsätze und Kontostand abliefern
Auszüge so, wie die Bank sie liefert (MT940 oder CAMT.053), und je Konto der abgerufene Tag und der Kontostand in Cent. Sie laufen durch denselben Import wie jede Auszugsdatei: Beleg, Prüfung auf Dubletten, Saldenkette, Abgleich der Zahlungsaufträge. Nur Konten der eigenen Bankverbindung. PIN, TAN und Anmeldename nimmt die Schnittstelle nicht an.
{
"operationId": "post_api_geraet_umsaetze",
"summary": "Abgerufene Umsätze und Kontostand abliefern",
"description": "Auszüge so, wie die Bank sie liefert (MT940 oder CAMT.053), und je Konto der abgerufene Tag und der Kontostand in Cent. Sie laufen durch denselben Import wie jede Auszugsdatei: Beleg, Prüfung auf Dubletten, Saldenkette, Abgleich der Zahlungsaufträge. Nur Konten der eigenen Bankverbindung. PIN, TAN und Anmeldename nimmt die Schnittstelle nicht an.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Eingelesen: Auszüge, neue Umsätze, Dubletten, Hinweise",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Kein Schreibzugang (Abo)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ein Feld heißt wie Zugangsdaten (PIN, TAN, Passwort, Anmeldename) oder ist unbekannt — nichts wird angenommen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"auszuege": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"format",
"inhalt"
],
"properties": {
"format": {
"type": "string",
"enum": [
"mt940",
"camt053"
]
},
"inhalt": {
"type": "string",
"description": "Der Auszug unverändert, wie von der Bank geliefert"
}
}
}
},
"konten": {
"type": "array",
"maxItems": 50,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"iban"
],
"properties": {
"iban": {
"type": "string"
},
"abgerufen_bis": {
"type": [
"string",
"null"
],
"format": "date"
},
"kontostand_cents": {
"type": [
"integer",
"null"
],
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"kontostand_am": {
"type": [
"string",
"null"
],
"format": "date"
}
}
}
}
}
}
}
}
}
}GET /api/v1/geraet/institute — Bankenverzeichnis für die Einrichtung auf dem Gerät
Suche nach Name, Ort, Bankleitzahl oder BIC (Parameter suche, mindestens zwei Zeichen). Geliefert werden nur Banken mit FinTS-Adresse: blz, name, city, bic, url. Vom Gerät kommt nur der Suchtext.
{
"operationId": "get_api_geraet_institute",
"summary": "Bankenverzeichnis für die Einrichtung auf dem Gerät",
"description": "Suche nach Name, Ort, Bankleitzahl oder BIC (Parameter suche, mindestens zwei Zeichen). Geliefert werden nur Banken mit FinTS-Adresse: blz, name, city, bic, url. Vom Gerät kommt nur der Suchtext.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Höchstens 20 Banken mit FinTS-Adresse",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Suchtext fehlt, ist zu kurz oder ein Feld ist unbekannt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "suche",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 2,
"maxLength": 100
}
}
]
}POST /api/v1/geraet/hinweis — Hinweis zum Bankzugang melden
Das Gerät meldet, dass die Bank eine neue Freigabe verlangt (freigabe_noetig) oder die gespeicherte PIN abgelehnt hat (pin_abgelehnt); null hebt den Hinweis auf. Summator zeigt ihn unter Bank → Verbindungen. Nur diese festen Werte, kein Text.
{
"operationId": "post_api_geraet_hinweis",
"summary": "Hinweis zum Bankzugang melden",
"description": "Das Gerät meldet, dass die Bank eine neue Freigabe verlangt (freigabe_noetig) oder die gespeicherte PIN abgelehnt hat (pin_abgelehnt); null hebt den Hinweis auf. Summator zeigt ihn unter Bank → Verbindungen. Nur diese festen Werte, kein Text.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Gespeichert",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Unbekannter Wert oder unbekanntes Feld.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"hinweis"
],
"properties": {
"hinweis": {
"type": [
"string",
"null"
],
"enum": [
"freigabe_noetig",
"pin_abgelehnt",
null
]
}
}
}
}
}
}
}GET /api/v1/geraet/zahlungen — Freigegebene Zahlungsaufträge
Aufträge der eigenen Bankverbindung, die in Summator vorbereitet und mit Passwort und Code freigegeben, aber noch nicht abgeholt sind. Je Auftrag sagt instant, ob er als Sofortüberweisung (SCT Inst) zu senden ist.
{
"operationId": "get_api_geraet_zahlungen",
"summary": "Freigegebene Zahlungsaufträge",
"description": "Aufträge der eigenen Bankverbindung, die in Summator vorbereitet und mit Passwort und Code freigegeben, aber noch nicht abgeholt sind. Je Auftrag sagt instant, ob er als Sofortüberweisung (SCT Inst) zu senden ist.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Liste der Aufträge mit Zeilen",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/geraet/zahlungen/{id}/abholen — Zahlungsauftrag abholen
Holt einen freigegebenen Auftrag genau einmal ab; danach steht er auf „gesendet“ und gehört diesem Gerät. Die Antwort enthält Zeilen, SEPA-Datei (pain.001) und Fingerabdruck. Meldet das Gerät innerhalb der Frist kein Ergebnis, steht der Auftrag auf „unbekannt“ und wird nie wiederholt. Eine Sofortüberweisung (instant=true) gibt Summator nur der Summator-App heraus, und nur, wenn die Anfrage instant=true nennt; damit sagt sie zu, den Auftrag dem Kunden als Sofortüberweisung gezeigt zu haben, ihn als solche zu senden und keine Umwandlung in eine Standardüberweisung zuzulassen. Sonst 422, auch für die Browser-Erweiterung mit instant=true, und der Auftrag bleibt freigegeben. Die SEPA-Datei trägt dann das Local Instrument INST.
{
"operationId": "post_api_geraet_zahlungen_abholen",
"summary": "Zahlungsauftrag abholen",
"description": "Holt einen freigegebenen Auftrag genau einmal ab; danach steht er auf „gesendet“ und gehört diesem Gerät. Die Antwort enthält Zeilen, SEPA-Datei (pain.001) und Fingerabdruck. Meldet das Gerät innerhalb der Frist kein Ergebnis, steht der Auftrag auf „unbekannt“ und wird nie wiederholt. Eine Sofortüberweisung (instant=true) gibt Summator nur der Summator-App heraus, und nur, wenn die Anfrage instant=true nennt; damit sagt sie zu, den Auftrag dem Kunden als Sofortüberweisung gezeigt zu haben, ihn als solche zu senden und keine Umwandlung in eine Standardüberweisung zuzulassen. Sonst 422, auch für die Browser-Erweiterung mit instant=true, und der Auftrag bleibt freigegeben. Die SEPA-Datei trägt dann das Local Instrument INST.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Auftrag zum Senden an die Bank",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Kein Auftrag dieser Bankverbindung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Nicht freigegeben oder schon abgeholt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ein Feld heißt wie Zugangsdaten (PIN, TAN, Passwort, Anmeldename) oder ist unbekannt — nichts wird angenommen. Oder der Auftrag ist eine Sofortüberweisung und die Anfrage nennt nicht instant=true — dann bleibt er freigegeben, und die Meldung sagt dem Kunden, was zu tun ist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"schema": {
"type": [
"string",
"null"
],
"description": "pain.001-Fassung, die die Bank annimmt"
},
"instant": {
"type": [
"boolean",
"null"
],
"description": "true: Das Gerät sendet diesen Auftrag als Sofortüberweisung (HKIPZ) und erlaubt der Bank keine Umwandlung in eine Standardüberweisung. Nötig bei einem Auftrag mit instant = true, sonst weglassen."
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]
}POST /api/v1/geraet/zahlungen/{id}/ergebnis — Ergebnis der Bank melden
Nur das Gerät, das abgeholt hat: angenommen, abgelehnt, nicht_gesendet oder unbekannt, dazu der Text der Bank und die Empfängerprüfung. Ausgeglichen wird die Rechnung erst mit der Abbuchung im Kontoabruf.
{
"operationId": "post_api_geraet_zahlungen_ergebnis",
"summary": "Ergebnis der Bank melden",
"description": "Nur das Gerät, das abgeholt hat: angenommen, abgelehnt, nicht_gesendet oder unbekannt, dazu der Text der Bank und die Empfängerprüfung. Ausgeglichen wird die Rechnung erst mit der Abbuchung im Kontoabruf.",
"tags": [
"geraet"
],
"security": [
{
"geraeteschluessel": []
}
],
"responses": {
"200": {
"description": "Auftrag im neuen Zustand",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"401": {
"description": "Kein oder ein widerrufener Geräteschlüssel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht von diesem Gerät abgeholt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Schon abgeschlossen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ein Feld heißt wie Zugangsdaten (PIN, TAN, Passwort, Anmeldename) oder ist unbekannt — nichts wird angenommen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"ergebnis"
],
"properties": {
"ergebnis": {
"type": "string",
"enum": [
"angenommen",
"abgelehnt",
"nicht_gesendet",
"unbekannt"
]
},
"bank_antwort": {
"type": [
"string",
"null"
],
"maxLength": 2000
},
"empfaenger_pruefung": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"empfaenger_text": {
"type": [
"string",
"null"
],
"maxLength": 1000
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]
}GET /api/v1/accounts/{number}/semantics — Bedeutung eines Kontos lesen
Geltende Bedeutung des Sachkontos (Zweck, Standard-Steuerschlüssel, Beispiele, Ausschlüsse, typische Lieferanten) und alle Fassungen, die jüngste zuerst. data ist null, wenn keine Bedeutung hinterlegt oder sie entfernt ist. Die Bedeutung ist kein Teil einer Buchung.
{
"operationId": "get_api_v1_accounts_number_semantics",
"summary": "Bedeutung eines Kontos lesen",
"tags": [
"accounts"
],
"security": [
{
"sanctum": []
}
],
"description": "Geltende Bedeutung des Sachkontos (Zweck, Standard-Steuerschlüssel, Beispiele, Ausschlüsse, typische Lieferanten) und alle Fassungen, die jüngste zuerst. data ist null, wenn keine Bedeutung hinterlegt oder sie entfernt ist. Die Bedeutung ist kein Teil einer Buchung.",
"parameters": [
{
"name": "number",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "^[0-9]+$"
}
}
],
"responses": {
"200": {
"description": "Bedeutung eines Kontos lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"number",
"name"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountSemantics"
},
{
"type": "null"
}
]
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSemantics"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"account",
"data",
"history"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/accounts/{number}/semantics — Bedeutung eines Kontos pflegen
Legt eine neue Fassung der Bedeutung an; die vorige bleibt in history. Nur genannte Felder ändern sich, eine Liste ersetzt die bisherige ganz, null oder leer entfernt ein Feld. Ohne Änderung entsteht keine Fassung. default_tax_key ist der Code eines aktiven Steuerschlüssels passender Richtung (Vorsteuer für Aufwand, Umsatzsteuer für Erlös) und nur ein Vorschlag: ein Satz aus Eingabe oder Beleg geht vor. Nur Sachkonten, keine Personenkonten. Idempotency-Key wird mit 400 idempotency_unsupported abgewiesen.
{
"operationId": "put_api_v1_accounts_number_semantics",
"summary": "Bedeutung eines Kontos pflegen",
"tags": [
"accounts"
],
"security": [
{
"sanctum": []
}
],
"description": "Legt eine neue Fassung der Bedeutung an; die vorige bleibt in history. Nur genannte Felder ändern sich, eine Liste ersetzt die bisherige ganz, null oder leer entfernt ein Feld. Ohne Änderung entsteht keine Fassung. default_tax_key ist der Code eines aktiven Steuerschlüssels passender Richtung (Vorsteuer für Aufwand, Umsatzsteuer für Erlös) und nur ein Vorschlag: ein Satz aus Eingabe oder Beleg geht vor. Nur Sachkonten, keine Personenkonten. Idempotency-Key wird mit 400 idempotency_unsupported abgewiesen.",
"parameters": [
{
"name": "number",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "^[0-9]+$"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purpose": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"default_tax_key": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
]
},
"examples": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string",
"minLength": 2,
"maxLength": 200
}
},
"exclusions": {
"type": "array",
"maxItems": 5,
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"account": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{3,9}$"
},
{
"type": "null"
}
]
}
},
"required": [
"text"
],
"additionalProperties": false
}
]
}
},
"vendors": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"minLength": 2,
"maxLength": 80
}
}
},
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Bedeutung eines Kontos pflegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"number": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"number",
"name"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountSemantics"
},
{
"type": "null"
}
]
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"account",
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Mit Idempotency-Key: idempotency_unsupported, keine Ausführung",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdempotencyBadRequest"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Validierung oder Fachregel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/documents — Dokumente des DMS seitenweise lesen
Dokumente der Dokumentenablage, die zuletzt abgelegten zuerst; Filter wie die Suche.
{
"operationId": "get_api_v1_dms_documents",
"summary": "Dokumente des DMS seitenweise lesen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Dokumente der Dokumentenablage, die zuletzt abgelegten zuerst; Filter wie die Suche.",
"parameters": [
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"description": "Eingang ab (JJJJ-MM-TT)."
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"description": "Eingang bis (JJJJ-MM-TT)."
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pdf",
"bild",
"office",
"text",
"xml",
"mail"
]
},
"description": "Nur diese Dateiart."
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
}
},
{
"name": "document_type",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Nur diese Dokumentart (Kennung)."
},
{
"name": "folder_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Nur dieser Ordner samt Unterordnern."
},
{
"name": "tag",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Nur Dokumente mit diesem Schlagwort."
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"suggested",
"confirmed"
]
},
"description": "suggested: Zuordnung noch offen."
},
{
"name": "payment_status",
"in": "query",
"description": "Nur Rechnungen mit diesem Zahlstatus (Mandanten mit DMS ohne Buchhaltung).",
"schema": {
"type": "string",
"enum": [
"offen",
"teilweise",
"bezahlt",
"skonto"
]
}
}
],
"responses": {
"200": {
"description": "Dokumente des DMS seitenweise lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsDocument"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"page": {
"type": "integer",
"minimum": 1
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"total",
"page",
"per_page"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Filter ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents — Dokument im DMS ablegen
Legt eine Datei unverändert ab (PDF, Bilder, Office-Dateien, Text, XML; bis 32 MB). Das Dokument wird beim Ablegen gesiegelt und bleibt aufbewahrt; sein Text wird für die Suche gelesen. Vorher wird die Datei auf Viren geprüft (ClamAV): Schadsoftware gibt 422 mit code file_rejected, reason virus und finding; ist die Prüfung nicht möglich, 503 mit reason pruefung_gescheitert, nichts wird abgelegt. Ein Scan ohne Textebene wird danach im Hintergrund vom eigenen KI-Server gelesen (text_recognition). Derselbe Inhalt wird nie zweimal abgelegt: dann 409 mit code duplicate und duplicate_of. Recht: Dokumente ablegen (Inhaber oder Buchhaltung, Zugang mit write, nicht im Lesemodus). Ein Inhalt, dessen Dokument endgültig gelöscht ist, wird mit 409 code deleted_content (deleted_at) abgewiesen.
{
"operationId": "post_api_v1_dms_documents",
"summary": "Dokument im DMS ablegen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Legt eine Datei unverändert ab (PDF, Bilder, Office-Dateien, Text, XML; bis 32 MB). Das Dokument wird beim Ablegen gesiegelt und bleibt aufbewahrt; sein Text wird für die Suche gelesen. Vorher wird die Datei auf Viren geprüft (ClamAV): Schadsoftware gibt 422 mit code file_rejected, reason virus und finding; ist die Prüfung nicht möglich, 503 mit reason pruefung_gescheitert, nichts wird abgelegt. Ein Scan ohne Textebene wird danach im Hintergrund vom eigenen KI-Server gelesen (text_recognition). Derselbe Inhalt wird nie zweimal abgelegt: dann 409 mit code duplicate und duplicate_of. Recht: Dokumente ablegen (Inhaber oder Buchhaltung, Zugang mit write, nicht im Lesemodus). Ein Inhalt, dessen Dokument endgültig gelöscht ist, wird mit 409 code deleted_content (deleted_at) abgewiesen.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"title": {
"type": "string",
"maxLength": 255
},
"document_type": {
"type": "string",
"description": "Kennung der Dokumentart; ohne Angabe ein Vorschlag."
},
"folder_id": {
"type": "integer",
"minimum": 1,
"description": "Ordner; ohne Angabe ein Vorschlag."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 30
}
},
"required": [
"file"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Dokument abgelegt",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Derselbe Inhalt liegt schon vor",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"duplicate"
]
},
"message": {
"type": "string"
},
"duplicate_of": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"document_id": {
"type": "integer"
}
},
"required": [
"code",
"message",
"duplicate_of",
"document_id"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Datei fehlt, ist zu groß, hat einen nicht zugelassenen Typ oder enthält Schadsoftware (code file_rejected)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich, etwa die Virenprüfung (code file_rejected, reason pruefung_gescheitert)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/documents/{id} — Ein Dokument des DMS lesen
Ein Dokument samt gewonnenem Text und Prüfung der Datei gegen ihren Fingerabdruck. Die Datei selbst liefert file_url.
{
"operationId": "get_api_v1_dms_documents_id",
"summary": "Ein Dokument des DMS lesen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ein Dokument samt gewonnenem Text und Prüfung der Datei gegen ihren Fingerabdruck. Die Datei selbst liefert file_url.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Ein Dokument des DMS lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PATCH /api/v1/dms/documents/{id} — Art, Ordner und Schlagworte eines Dokuments bestätigen oder ändern
Ohne Felder wird der Vorschlag angenommen. Was fehlt, bleibt; tags ersetzt alle Schlagworte. Danach ist die Zuordnung bestätigt, und das DMS merkt sich das Ziel für den Absender. Jede Änderung steht im Protokoll.
{
"operationId": "patch_api_v1_dms_documents_id",
"summary": "Art, Ordner und Schlagworte eines Dokuments bestätigen oder ändern",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ohne Felder wird der Vorschlag angenommen. Was fehlt, bleibt; tags ersetzt alle Schlagworte. Danach ist die Zuordnung bestätigt, und das DMS merkt sich das Ziel für den Absender. Jede Änderung steht im Protokoll.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"document_type": {
"type": "string",
"description": "Kennung der Dokumentart, etwa vertrag."
},
"folder_id": {
"type": "integer",
"minimum": 1
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 30
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Art, Ordner und Schlagworte eines Dokuments bestätigen oder ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}DELETE /api/v1/dms/documents/{id} — Dokument in den Papierkorb
Legt ein nicht festgeschriebenes Dokument in den Papierkorb; nach 30 Tagen kann der Inhaber es in der Oberfläche endgültig löschen. Ein festgeschriebenes Dokument wird abgewiesen (409 retention_locked), der Versuch steht im Protokoll. Endgültig gelöscht wird nie über die API.
{
"operationId": "delete_api_v1_dms_documents_id",
"summary": "Dokument in den Papierkorb",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Legt ein nicht festgeschriebenes Dokument in den Papierkorb; nach 30 Tagen kann der Inhaber es in der Oberfläche endgültig löschen. Ein festgeschriebenes Dokument wird abgewiesen (409 retention_locked), der Versuch steht im Protokoll. Endgültig gelöscht wird nie über die API.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"maxLength": 500
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Dokument in den Papierkorb",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Festgeschrieben, vor Fristende nicht löschbar",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"retention_locked"
]
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/dms/search — Dokumente im DMS suchen (Volltext und Bedeutung)
Sucht Wörter aus Inhalt und Titel, Rechnungsnummern und IBAN (mit oder ohne Leerzeichen) und zugleich nach Bedeutung: „Miete Halle“ findet auch den Mietvertrag über die Lagerhalle. Dokumente, die eine gesuchte Rechnungsnummer oder IBAN wörtlich tragen, stehen vorn. Treffer nach Rang mit Ausschnitt; match sagt, ob ein Treffer die Wörter trägt oder nur inhaltlich passt. meta.semantic: active (Volltext und Bedeutung), unavailable (Bedeutung gerade nicht erreichbar, nur Volltext), rebuilding (wird neu aufgebaut, nur Volltext), pending (noch nicht berechnet), literal (Wortfolge oder Ausschluss in q oder q nur aus Rechnungsnummern und IBAN, nur Volltext), off (nicht eingerichtet). Scans und Fotos ohne Textebene sind nur über den Titel zu finden.
{
"operationId": "get_api_v1_dms_search",
"summary": "Dokumente im DMS suchen (Volltext und Bedeutung)",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Sucht Wörter aus Inhalt und Titel, Rechnungsnummern und IBAN (mit oder ohne Leerzeichen) und zugleich nach Bedeutung: „Miete Halle“ findet auch den Mietvertrag über die Lagerhalle. Dokumente, die eine gesuchte Rechnungsnummer oder IBAN wörtlich tragen, stehen vorn. Treffer nach Rang mit Ausschnitt; match sagt, ob ein Treffer die Wörter trägt oder nur inhaltlich passt. meta.semantic: active (Volltext und Bedeutung), unavailable (Bedeutung gerade nicht erreichbar, nur Volltext), rebuilding (wird neu aufgebaut, nur Volltext), pending (noch nicht berechnet), literal (Wortfolge oder Ausschluss in q oder q nur aus Rechnungsnummern und IBAN, nur Volltext), off (nicht eingerichtet). Scans und Fotos ohne Textebene sind nur über den Titel zu finden.",
"parameters": [
{
"name": "q",
"in": "query",
"required": true,
"schema": {
"type": "string",
"maxLength": 500
},
"description": "Suchwörter oder eine Umschreibung; \"…\" für eine Wortfolge, - vor einem Wort schließt es aus (beides sucht nur im Volltext)."
},
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"description": "Eingang ab (JJJJ-MM-TT)."
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"description": "Eingang bis (JJJJ-MM-TT)."
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pdf",
"bild",
"office",
"text",
"xml",
"mail"
]
},
"description": "Nur diese Dateiart."
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
}
},
{
"name": "document_type",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Nur diese Dokumentart (Kennung)."
},
{
"name": "folder_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Nur dieser Ordner samt Unterordnern."
},
{
"name": "tag",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Nur Dokumente mit diesem Schlagwort."
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"suggested",
"confirmed"
]
},
"description": "suggested: Zuordnung noch offen."
},
{
"name": "payment_status",
"in": "query",
"description": "Nur Rechnungen mit diesem Zahlstatus (Mandanten mit DMS ohne Buchhaltung).",
"schema": {
"type": "string",
"enum": [
"offen",
"teilweise",
"bezahlt",
"skonto"
]
}
}
],
"responses": {
"200": {
"description": "Dokumente im DMS suchen (Volltext und Bedeutung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsDocument"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"page": {
"type": "integer",
"minimum": 1
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"semantic": {
"type": "string",
"enum": [
"active",
"unavailable",
"rebuilding",
"pending",
"literal",
"off"
],
"description": "Stand der Suche nach Bedeutung für diese Anfrage."
},
"notice": {
"type": [
"string",
"null"
],
"description": "Hinweis für den Nutzer, wenn kein KI-Server eingetragen ist und deshalb nur im Volltext gesucht wird; sonst null."
}
},
"required": [
"total",
"page",
"per_page",
"semantic",
"notice"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Suchwort fehlt oder Filter ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/imports — Altbestände auflisten
Die letzten 50 als ZIP eingespielten Altbestände, neueste zuerst, mit Stand und Zählern (Fahrplan D3b).
{
"operationId": "get_api_v1_dms_imports",
"summary": "Altbestände auflisten",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Die letzten 50 als ZIP eingespielten Altbestände, neueste zuerst, mit Stand und Zählern (Fahrplan D3b).",
"responses": {
"200": {
"description": "Altbestände",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsImport"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/imports — Altbestand als ZIP einspielen
Nimmt ein ZIP mit Ordnern und Dateien an und legt jede Datei im Hintergrund ab: Virenprüfung, Siegel, Texterkennung wie beim einzelnen Ablegen; die Ordner des ZIP werden Ordner im DMS, Dubletten werden erkannt und nicht doppelt abgelegt. Fortschritt und Meldungen je Datei über GET /api/v1/dms/imports/{id}. Ein ZIP über den Grenzen (Größe, Zahl der Dateien, entpackte Größe) wird als Ganzes mit 422 import_rejected abgewiesen.
{
"operationId": "post_api_v1_dms_imports",
"summary": "Altbestand als ZIP einspielen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Nimmt ein ZIP mit Ordnern und Dateien an und legt jede Datei im Hintergrund ab: Virenprüfung, Siegel, Texterkennung wie beim einzelnen Ablegen; die Ordner des ZIP werden Ordner im DMS, Dubletten werden erkannt und nicht doppelt abgelegt. Fortschritt und Meldungen je Datei über GET /api/v1/dms/imports/{id}. Ein ZIP über den Grenzen (Größe, Zahl der Dateien, entpackte Größe) wird als Ganzes mit 422 import_rejected abgewiesen.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "ZIP-Datei; über die Uploadgrenze des Servers hinaus (64 MB) mit dms:altbestand vom Betrieb."
}
},
"required": [
"file"
],
"additionalProperties": false
}
}
}
},
"responses": {
"202": {
"description": "Eingeplant, läuft im Hintergrund",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsImport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Kein lesbares ZIP, über den Grenzen oder ohne Dateien (code import_rejected)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/imports/{id} — Altbestand mit Meldungen je Datei
Fortschritt eines Altbestands und je Datei, die nicht abgelegt wurde, Pfad im ZIP, Ergebnis (dublette oder abgewiesen) und Meldung.
{
"operationId": "get_api_v1_dms_imports_id",
"summary": "Altbestand mit Meldungen je Datei",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Fortschritt eines Altbestands und je Datei, die nicht abgelegt wurde, Pfad im ZIP, Ergebnis (dublette oder abgewiesen) und Meldung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Altbestand",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsImport"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Diesen Altbestand gibt es nicht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/structure — Ordnung des DMS lesen
Dokumentarten mit Aufbewahrungsfrist und gesetzlicher Mindestfrist, Ordner, Schlagworte, Regeln für Vorschläge und ob die Einrichtung erledigt ist.
{
"operationId": "get_api_v1_dms_structure",
"summary": "Ordnung des DMS lesen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Dokumentarten mit Aufbewahrungsfrist und gesetzlicher Mindestfrist, Ordner, Schlagworte, Regeln für Vorschläge und ob die Einrichtung erledigt ist.",
"parameters": [],
"responses": {
"200": {
"description": "Ordnung des DMS lesen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsStructure"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/folders — Ordner anlegen
Legt einen Ordner oben oder unter einem anderen an; by_year legt Dokumente in einen Unterordner je Eingangsjahr. Ordner werden nicht gelöscht.
{
"operationId": "post_api_v1_dms_folders",
"summary": "Ordner anlegen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Legt einen Ordner oben oder unter einem anderen an; by_year legt Dokumente in einen Unterordner je Eingangsjahr. Ordner werden nicht gelöscht.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"parent_id": {
"type": "integer",
"minimum": 1
},
"by_year": {
"type": "boolean"
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Ordner anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsFolder"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}PATCH /api/v1/dms/document-types/{key} — Aufbewahrungsfrist einer Dokumentart ändern
Verlängert oder ändert die Frist einer Dokumentart mit Grund; nie unter die gesetzliche Mindestfrist der Art (422).
{
"operationId": "patch_api_v1_dms_document_types_key",
"summary": "Aufbewahrungsfrist einer Dokumentart ändern",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Verlängert oder ändert die Frist einer Dokumentart mit Grund; nie unter die gesetzliche Mindestfrist der Art (422).",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"retention_years": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"reason": {
"type": "string",
"maxLength": 500
}
},
"required": [
"retention_years",
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Aufbewahrungsfrist einer Dokumentart ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocumentType"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Kennung der Dokumentart, etwa vertrag."
}
]
}POST /api/v1/dms/rules — Regel für Vorschläge anlegen
Enthält Absender, Titel oder Text das Wort contains, schlägt die Regel Art, Ordner und Schlagworte vor; automatic übernimmt sie ohne Bestätigung. Regeln gehen dem Gedächtnis vor.
{
"operationId": "post_api_v1_dms_rules",
"summary": "Regel für Vorschläge anlegen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Enthält Absender, Titel oder Text das Wort contains, schlägt die Regel Art, Ordner und Schlagworte vor; automatic übernimmt sie ohne Bestätigung. Regeln gehen dem Gedächtnis vor.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"field": {
"type": "string",
"enum": [
"sender",
"title",
"text"
]
},
"contains": {
"type": "string",
"maxLength": 200
},
"document_type": {
"type": "string"
},
"folder_id": {
"type": "integer",
"minimum": 1
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 30
},
"automatic": {
"type": "boolean"
}
},
"required": [
"name",
"field",
"contains"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Regel für Vorschläge anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsRule"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}POST /api/v1/dms/rules/{id}/deactivate — Regel deaktivieren
Eine Regel wird nie gelöscht, nur deaktiviert.
{
"operationId": "post_api_v1_dms_rules_id_deactivate",
"summary": "Regel deaktivieren",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Eine Regel wird nie gelöscht, nur deaktiviert.",
"responses": {
"200": {
"description": "Regel deaktivieren",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsRule"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/dms/setup — Einrichtung des DMS beantworten
Einmal je Firma: Ist sie eine Bank oder Versicherung, gelten für alle Dokumentarten mit gesetzlicher Frist zehn Jahre. Ein zweiter Aufruf gibt 422.
{
"operationId": "post_api_v1_dms_setup",
"summary": "Einrichtung des DMS beantworten",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Einmal je Firma: Ist sie eine Bank oder Versicherung, gelten für alle Dokumentarten mit gesetzlicher Frist zehn Jahre. Ein zweiter Aufruf gibt 422.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bank_or_insurance": {
"type": "boolean"
},
"retention_enabled": {
"type": "boolean",
"description": "GoBD-Teil einschalten, Vorgabe true."
}
},
"required": [
"bank_or_insurance"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Einrichtung des DMS beantworten",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsStructure"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}GET /api/v1/dms/inbox — Mail-Eingang des DMS lesen
Empfangsadresse (nur mit Recht Dokumente ablegen), Regeln, abgerufene Postfächer ohne Zugangsgeheimnis und die letzten 25 Mails mit Absender, Betreff, Eingangszeit, Status und Ergebnis je Anhang. before_id blättert zu älteren Mails.
{
"operationId": "get_api_v1_dms_inbox",
"summary": "Mail-Eingang des DMS lesen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Empfangsadresse (nur mit Recht Dokumente ablegen), Regeln, abgerufene Postfächer ohne Zugangsgeheimnis und die letzten 25 Mails mit Absender, Betreff, Eingangszeit, Status und Ergebnis je Anhang. before_id blättert zu älteren Mails.",
"parameters": [
{
"name": "before_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Nur Mails mit kleinerer id (next_before_id)."
}
],
"responses": {
"200": {
"description": "Mail-Eingang",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsInbox"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Filter ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/inbox/address — Empfangsadresse einrichten, erneuern oder abschalten
setup richtet die Empfangsadresse ein oder erneuert sie (die alte gilt sofort nicht mehr), disable schaltet sie ab. Recht: Verwalten (Inhaber, Zugang mit admin) und Dokumente ablegen.
{
"operationId": "post_api_v1_dms_inbox_address",
"summary": "Empfangsadresse einrichten, erneuern oder abschalten",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "setup richtet die Empfangsadresse ein oder erneuert sie (die alte gilt sofort nicht mehr), disable schaltet sie ab. Recht: Verwalten (Inhaber, Zugang mit admin) und Dokumente ablegen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"setup",
"disable"
]
}
},
"required": [
"action"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Stand der Empfangsadresse",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
]
},
"since": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"available",
"active",
"email",
"since"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Filter ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/inbox/rules — Regel des Mail-Eingangs anlegen
Mails eines Absenders annehmen: sender ist eine Adresse, eine Domain mit @ davor oder * für alle; wahlweise Betreff und Anhangname (Muster wie *.pdf) und ob die Mail selbst als .eml abgelegt wird. Ohne passende Regel gilt eine Mail als fremder Absender und wird nicht abgelegt. Recht: Verwalten.
{
"operationId": "post_api_v1_dms_inbox_rules",
"summary": "Regel des Mail-Eingangs anlegen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Mails eines Absenders annehmen: sender ist eine Adresse, eine Domain mit @ davor oder * für alle; wahlweise Betreff und Anhangname (Muster wie *.pdf) und ob die Mail selbst als .eml abgelegt wird. Ohne passende Regel gilt eine Mail als fremder Absender und wird nicht abgelegt. Recht: Verwalten.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"sender": {
"type": "string",
"maxLength": 255
},
"subject_contains": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"attachment_pattern": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"store_eml": {
"type": "boolean"
}
},
"required": [
"name",
"sender"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Regel angelegt",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sender": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"sender",
"active"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Filter ungültig",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/inbox/rules/{id}/deactivate — Regel des Mail-Eingangs ausschalten
Die Regel gilt danach nicht mehr; gelöscht wird sie nie. Recht: Verwalten.
{
"operationId": "post_api_v1_dms_inbox_rules_id_deactivate",
"summary": "Regel des Mail-Eingangs ausschalten",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Die Regel gilt danach nicht mehr; gelöscht wird sie nie. Recht: Verwalten.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Regel aus",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"active": {
"type": "boolean"
}
},
"required": [
"id",
"active"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/inbox/mailboxes/{id}/fetch — IMAP-Postfach jetzt abrufen
Ruft das Postfach ab (sonst alle fünf Minuten): neue Mails ab der letzten UID, Anhänge werden nach den Regeln abgelegt, am Postfach wird nichts verändert. Scheitert der Abruf (etwa Anmeldung abgelehnt), 422 mit code mailbox_<kennung>; der Fehler steht danach auch am Postfach. Recht: Dokumente ablegen.
{
"operationId": "post_api_v1_dms_inbox_mailboxes_id_fetch",
"summary": "IMAP-Postfach jetzt abrufen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ruft das Postfach ab (sonst alle fünf Minuten): neue Mails ab der letzten UID, Anhänge werden nach den Regeln abgelegt, am Postfach wird nichts verändert. Scheitert der Abruf (etwa Anmeldung abgelehnt), 422 mit code mailbox_<kennung>; der Fehler steht danach auch am Postfach. Recht: Dokumente ablegen.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Abgerufen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsMailbox"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Abruf gescheitert",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"mailbox_verbindung",
"mailbox_tls",
"mailbox_anmeldung",
"mailbox_ordner",
"mailbox_protokoll",
"mailbox_unverschluesselt",
"mailbox_nicht_berechtigt"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsMailbox"
}
},
"required": [
"code",
"message",
"data"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/inbox/mailboxes/{id}/deactivate — IMAP-Postfach nicht mehr abrufen
Schaltet den Abruf ab; Postfach, Mails und Dokumente bleiben. Anlegen und Zugangsdaten ändern geht nur in der Oberfläche. Recht: Verwalten.
{
"operationId": "post_api_v1_dms_inbox_mailboxes_id_deactivate",
"summary": "IMAP-Postfach nicht mehr abrufen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Schaltet den Abruf ab; Postfach, Mails und Dokumente bleiben. Anlegen und Zugangsdaten ändern geht nur in der Oberfläche. Recht: Verwalten.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Postfach aus",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsMailbox"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/weclapp — weclapp-Anbindung des DMS lesen
Verbindung zu weclapp (Konto, Benutzer, Abholen ab, letzter Abruf, Fehler, Benachrichtigungsadresse nur mit Recht Dokumente ablegen; nie das Token) und die zuletzt abgeholten Ausgangsrechnungen mit Ergebnis je Datei (Beleg, E-Rechnung, Stornobeleg).
{
"operationId": "get_api_v1_dms_weclapp",
"summary": "weclapp-Anbindung des DMS lesen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Verbindung zu weclapp (Konto, Benutzer, Abholen ab, letzter Abruf, Fehler, Benachrichtigungsadresse nur mit Recht Dokumente ablegen; nie das Token) und die zuletzt abgeholten Ausgangsrechnungen mit Ergebnis je Datei (Beleg, E-Rechnung, Stornobeleg).",
"responses": {
"200": {
"description": "weclapp-Anbindung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsWeclapp"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/weclapp/fetch — weclapp jetzt abrufen
Fragt weclapp jetzt ab (sonst alle 15 Minuten und bei jeder Benachrichtigung): neue und geänderte Ausgangsrechnungen ab DOCUMENT_CREATED werden mit Beleg, E-Rechnung und Stornobeleg abgelegt, nichts doppelt. Scheitert der Abruf (Token abgelehnt, keine Rechte, Abrufgrenze), 422 mit code weclapp_<kennung>; der Fehler steht danach auch an der Verbindung.
{
"operationId": "post_api_v1_dms_weclapp_fetch",
"summary": "weclapp jetzt abrufen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Fragt weclapp jetzt ab (sonst alle 15 Minuten und bei jeder Benachrichtigung): neue und geänderte Ausgangsrechnungen ab DOCUMENT_CREATED werden mit Beleg, E-Rechnung und Stornobeleg abgelegt, nichts doppelt. Scheitert der Abruf (Token abgelehnt, keine Rechte, Abrufgrenze), 422 mit code weclapp_<kennung>; der Fehler steht danach auch an der Verbindung.",
"responses": {
"200": {
"description": "Abgerufen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "weclapp ist nicht verbunden (code weclapp_not_connected) oder der Abruf ist gescheitert (code weclapp_<kennung>)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"weclapp_not_connected",
"weclapp_anmeldung",
"weclapp_rechte",
"weclapp_grenze",
"weclapp_verbindung",
"weclapp_antwort",
"weclapp_nicht_berechtigt",
"weclapp_pruefung",
"weclapp_nicht_gefunden",
"weclapp_leer",
"weclapp_zu_gross",
"weclapp_ablage"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"code",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/weclapp/deactivate — weclapp-Anbindung abschalten
Schaltet die Anbindung ab: nichts wird mehr abgeholt, die Benachrichtigungsadresse antwortet 404. Abgelegte Dokumente bleiben. Verbinden und Token ersetzen geht nur in der Oberfläche.
{
"operationId": "post_api_v1_dms_weclapp_deactivate",
"summary": "weclapp-Anbindung abschalten",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Schaltet die Anbindung ab: nichts wird mehr abgeholt, die Benachrichtigungsadresse antwortet 404. Abgelegte Dokumente bleiben. Verbinden und Token ersetzen geht nur in der Oberfläche.",
"responses": {
"200": {
"description": "Abgeschaltet",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "weclapp ist nicht verbunden (code weclapp_not_connected) oder der Abruf ist gescheitert (code weclapp_<kennung>)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"weclapp_not_connected",
"weclapp_anmeldung",
"weclapp_rechte",
"weclapp_grenze",
"weclapp_verbindung",
"weclapp_antwort",
"weclapp_nicht_berechtigt",
"weclapp_pruefung",
"weclapp_nicht_gefunden",
"weclapp_leer",
"weclapp_zu_gross",
"weclapp_ablage"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"code",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/weclapp/webhook/{geheimnis} — Benachrichtigung von weclapp
Benachrichtigung von weclapp (Webhook für salesInvoice bei Anlage und Änderung). Geschützt durch das Geheimnis in der Adresse, weil weclapp nicht signiert. Die Nutzlast nennt nur entityId, entityName und type und wird nie geglaubt: die Rechnung wird über die weclapp-API nachgeladen, nach der Antwort. Ohne entityId wird die Abfrage angestoßen.
{
"operationId": "get_api_v1_dms_weclapp_webhook_geheimnis",
"summary": "Benachrichtigung von weclapp",
"tags": [
"dms"
],
"security": [],
"description": "Benachrichtigung von weclapp (Webhook für salesInvoice bei Anlage und Änderung). Geschützt durch das Geheimnis in der Adresse, weil weclapp nicht signiert. Die Nutzlast nennt nur entityId, entityName und type und wird nie geglaubt: die Rechnung wird über die weclapp-API nachgeladen, nach der Antwort. Ohne entityId wird die Abfrage angestoßen.",
"parameters": [
{
"name": "geheimnis",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Zufallsteil der Adresse aus der Oberfläche."
},
{
"name": "entityId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entityName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Angenommen (status accepted) oder übergangen (status ignored: andere Entität oder DELETE)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"accepted",
"ignored"
]
}
},
"required": [
"status"
]
}
}
}
},
"403": {
"description": "Leistung dms nicht gebucht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder abgeschaltete Adresse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "60 je Minute",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/weclapp/webhook/{geheimnis} — Benachrichtigung von weclapp
Benachrichtigung von weclapp (Webhook für salesInvoice bei Anlage und Änderung). Geschützt durch das Geheimnis in der Adresse, weil weclapp nicht signiert. Die Nutzlast nennt nur entityId, entityName und type und wird nie geglaubt: die Rechnung wird über die weclapp-API nachgeladen, nach der Antwort. Ohne entityId wird die Abfrage angestoßen.
{
"operationId": "post_api_v1_dms_weclapp_webhook_geheimnis",
"summary": "Benachrichtigung von weclapp",
"tags": [
"dms"
],
"security": [],
"description": "Benachrichtigung von weclapp (Webhook für salesInvoice bei Anlage und Änderung). Geschützt durch das Geheimnis in der Adresse, weil weclapp nicht signiert. Die Nutzlast nennt nur entityId, entityName und type und wird nie geglaubt: die Rechnung wird über die weclapp-API nachgeladen, nach der Antwort. Ohne entityId wird die Abfrage angestoßen.",
"parameters": [
{
"name": "geheimnis",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Zufallsteil der Adresse aus der Oberfläche."
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"entityName": {
"type": "string",
"examples": [
"salesInvoice"
]
},
"type": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
}
}
}
}
},
"responses": {
"202": {
"description": "Angenommen (status accepted) oder übergangen (status ignored: andere Entität oder DELETE)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"accepted",
"ignored"
]
}
},
"required": [
"status"
]
}
}
}
},
"403": {
"description": "Leistung dms nicht gebucht",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Unbekannte oder abgeschaltete Adresse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "60 je Minute",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents/{id}/lock — Dokument festschreiben
Schreibt ein Dokument nach der Frist seiner Art fest, wenn der GoBD-Teil an ist. Danach sind Inhalt, Art und Frist gesperrt; vor Fristende lässt es sich nicht löschen. Bei Verträgen ist event_date das Vertragsende.
{
"operationId": "post_api_v1_dms_documents_id_lock",
"summary": "Dokument festschreiben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Schreibt ein Dokument nach der Frist seiner Art fest, wenn der GoBD-Teil an ist. Danach sind Inhalt, Art und Frist gesperrt; vor Fristende lässt es sich nicht löschen. Bei Verträgen ist event_date das Vertragsende.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"maxLength": 500
},
"event_date": {
"type": "string",
"format": "date"
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Dokument festschreiben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}POST /api/v1/dms/documents/{id}/restore — Dokument aus dem Papierkorb zurückholen
Holt ein Dokument aus dem Papierkorb zurück, solange es nicht endgültig gelöscht ist.
{
"operationId": "post_api_v1_dms_documents_id_restore",
"summary": "Dokument aus dem Papierkorb zurückholen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Holt ein Dokument aus dem Papierkorb zurück, solange es nicht endgültig gelöscht ist.",
"responses": {
"200": {
"description": "Dokument aus dem Papierkorb zurückholen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocument"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/dms/documents/{id}/history — Verlauf eines Dokuments
Der Verlauf aus dem unveränderlichen Protokoll: Ablage, Siegel, Zuordnung, Festschreibung, Papierkorb, Löschung und abgewiesene Löschversuche, älteste zuerst. Bleibt nach der Löschung vollständig erhalten.
{
"operationId": "get_api_v1_dms_documents_id_history",
"summary": "Verlauf eines Dokuments",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Der Verlauf aus dem unveränderlichen Protokoll: Ablage, Siegel, Zuordnung, Festschreibung, Papierkorb, Löschung und abgewiesene Löschversuche, älteste zuerst. Bleibt nach der Löschung vollständig erhalten.",
"responses": {
"200": {
"description": "Verlauf eines Dokuments",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"at": {
"type": "string"
},
"by": {
"type": "string"
},
"event": {
"type": "string"
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"at",
"by",
"event",
"detail"
],
"additionalProperties": false
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}GET /api/v1/dms/deletion-proposals — Löschvorschläge
Dokumente, deren Frist abgelaufen ist, und Dokumente, die seit 30 Tagen im Papierkorb liegen. Gelöscht wird nur in der Oberfläche nach Bestätigung des Inhabers.
{
"operationId": "get_api_v1_dms_deletion_proposals",
"summary": "Löschvorschläge",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Dokumente, deren Frist abgelaufen ist, und Dokumente, die seit 30 Tagen im Papierkorb liegen. Gelöscht wird nur in der Oberfläche nach Bestätigung des Inhabers.",
"responses": {
"200": {
"description": "Löschvorschläge",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsDocument"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}GET /api/v1/dms/bank/transactions — Bankumsätze mit Stand des Abgleichs
Bankumsätze des Mandanten, neueste zuerst, mit Stand: open (nicht zugeordnet), assigned (einer Rechnung zugeordnet, mit allocation_id und document_id) oder used. Filter status = open (Vorgabe), assigned, all. Nur für Mandanten mit DMS ohne Buchhaltung.
{
"operationId": "get_api_v1_dms_bank_transactions",
"summary": "Bankumsätze mit Stand des Abgleichs",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Bankumsätze des Mandanten, neueste zuerst, mit Stand: open (nicht zugeordnet), assigned (einer Rechnung zugeordnet, mit allocation_id und document_id) oder used. Filter status = open (Vorgabe), assigned, all. Nur für Mandanten mit DMS ohne Buchhaltung.",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"open",
"assigned",
"all"
]
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Umsätze",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/DmsUmsatz"
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"open",
"assigned",
"used"
]
},
"allocation_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"document_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
}
}
]
}
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
}
}
}
},
"required": [
"data",
"meta"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gleicht die Buchhaltung ab (code abgleich_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"abgleich_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/bank/transactions/{id}/suggestions — Vorschläge aus den Rechnungsdokumenten zu einem Umsatz
Bewertete Kandidaten aus den offenen Eingangs- und Ausgangsrechnungen mit Gründen: kind full (Betrag stimmt), partial (Teilzahlung) oder discount (Betrag stimmt mit Skonto innerhalb der Frist). Entschieden wird nichts; zugeordnet wird erst mit POST /api/v1/dms/payments.
{
"operationId": "get_api_v1_dms_bank_transactions_id_suggestions",
"summary": "Vorschläge aus den Rechnungsdokumenten zu einem Umsatz",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Bewertete Kandidaten aus den offenen Eingangs- und Ausgangsrechnungen mit Gründen: kind full (Betrag stimmt), partial (Teilzahlung) oder discount (Betrag stimmt mit Skonto innerhalb der Frist). Entschieden wird nichts; zugeordnet wird erst mit POST /api/v1/dms/payments.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Vorschläge",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"document_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partner": {
"type": "string"
},
"open_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"amount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"discount_cents": {
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
"kind": {
"type": "string",
"enum": [
"full",
"partial",
"discount"
]
},
"score": {
"type": "integer"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"document_id",
"kind",
"score",
"reasons"
]
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Umsatz unbekannt",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gleicht die Buchhaltung ab (code abgleich_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"abgleich_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/dms/documents/{id}/invoice — Rechnungsangaben erfassen oder berichtigen
Betrag, Partner, Rechnungsnummer, IBAN, Datum, Fälligkeit und Skonto einer Eingangs- oder Ausgangsrechnung. Eine Berichtigung ist eine neue Fassung; die frühere bleibt im Protokoll. Danach hat die Rechnung einen Zahlstatus.
{
"operationId": "put_api_v1_dms_documents_id_invoice",
"summary": "Rechnungsangaben erfassen oder berichtigen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Betrag, Partner, Rechnungsnummer, IBAN, Datum, Fälligkeit und Skonto einer Eingangs- oder Ausgangsrechnung. Eine Berichtigung ist eine neue Fassung; die frühere bleibt im Protokoll. Danach hat die Rechnung einen Zahlstatus.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"amount_cents": {
"type": "integer",
"minimum": 1
},
"partner": {
"type": "string",
"maxLength": 255
},
"invoice_number": {
"type": "string",
"maxLength": 255
},
"iban": {
"type": "string"
},
"invoice_date": {
"type": "string",
"format": "date"
},
"due_on": {
"type": "string",
"format": "date"
},
"discount_percent": {
"type": "number",
"exclusiveMinimum": 0,
"exclusiveMaximum": 100
},
"discount_until": {
"type": "string",
"format": "date"
}
},
"required": [
"amount_cents",
"partner"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Zahlstatus der Rechnung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsZahlung"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gleicht die Buchhaltung ab (code abgleich_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"abgleich_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "weclapp ist nicht verbunden (code weclapp_not_connected) oder der Abruf ist gescheitert (code weclapp_<kennung>)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"weclapp_not_connected",
"weclapp_anmeldung",
"weclapp_rechte",
"weclapp_grenze",
"weclapp_verbindung",
"weclapp_antwort",
"weclapp_nicht_berechtigt",
"weclapp_pruefung",
"weclapp_nicht_gefunden",
"weclapp_leer",
"weclapp_zu_gross",
"weclapp_ablage"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"code",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/payments — Umsatz einer Rechnung zuordnen
Ordnet einen Bankumsatz einer Rechnung zu, ganz oder als Teilzahlung; discount schließt den Rest als Skonto ab (nur mit Skonto der Rechnung). Nur auf ausdrückliche Bestätigung. Es entsteht keine Buchung; der Zahlstatus ergibt sich aus den Zuordnungen.
{
"operationId": "post_api_v1_dms_payments",
"summary": "Umsatz einer Rechnung zuordnen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ordnet einen Bankumsatz einer Rechnung zu, ganz oder als Teilzahlung; discount schließt den Rest als Skonto ab (nur mit Skonto der Rechnung). Nur auf ausdrückliche Bestätigung. Es entsteht keine Buchung; der Zahlstatus ergibt sich aus den Zuordnungen.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transaction_id": {
"type": "integer"
},
"document_id": {
"type": "integer"
},
"discount": {
"type": "boolean"
}
},
"required": [
"transaction_id",
"document_id"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Zugeordnet",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DmsZuordnung"
},
{
"type": "object",
"properties": {
"payment": {
"anyOf": [
{
"$ref": "#/components/schemas/DmsZahlung"
},
{
"type": "null"
}
]
}
}
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gleicht die Buchhaltung ab (code abgleich_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"abgleich_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "weclapp ist nicht verbunden (code weclapp_not_connected) oder der Abruf ist gescheitert (code weclapp_<kennung>)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"weclapp_not_connected",
"weclapp_anmeldung",
"weclapp_rechte",
"weclapp_grenze",
"weclapp_verbindung",
"weclapp_antwort",
"weclapp_nicht_berechtigt",
"weclapp_pruefung",
"weclapp_nicht_gefunden",
"weclapp_leer",
"weclapp_zu_gross",
"weclapp_ablage"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"code",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/payments/{id}/cancel — Zuordnung aufheben
Hebt eine Zuordnung mit Grund auf. Gelöscht wird nichts: die Aufhebung ist ein neues Ereignis, der Umsatz ist danach wieder offen.
{
"operationId": "post_api_v1_dms_payments_id_cancel",
"summary": "Zuordnung aufheben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Hebt eine Zuordnung mit Grund auf. Gelöscht wird nichts: die Aufhebung ist ein neues Ereignis, der Umsatz ist danach wieder offen.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"maxLength": 500
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Aufgehoben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DmsZuordnung"
},
{
"type": "object",
"properties": {
"payment": {
"anyOf": [
{
"$ref": "#/components/schemas/DmsZahlung"
},
{
"type": "null"
}
]
}
}
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gleicht die Buchhaltung ab (code abgleich_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"abgleich_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "weclapp ist nicht verbunden (code weclapp_not_connected) oder der Abruf ist gescheitert (code weclapp_<kennung>)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"weclapp_not_connected",
"weclapp_anmeldung",
"weclapp_rechte",
"weclapp_grenze",
"weclapp_verbindung",
"weclapp_antwort",
"weclapp_nicht_berechtigt",
"weclapp_pruefung",
"weclapp_nicht_gefunden",
"weclapp_leer",
"weclapp_zu_gross",
"weclapp_ablage"
]
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DmsWeclappConnection"
}
},
"required": [
"code",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/pre-postings — Vorbuchungen
Vorbuchungen des DMS (Fahrplan D6a), die jüngsten zuerst; status=draft, confirmed oder handed_over filtert. Nur für Mandanten ohne Buchhaltung.
{
"operationId": "get_api_v1_dms_pre_postings",
"summary": "Vorbuchungen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Vorbuchungen des DMS (Fahrplan D6a), die jüngsten zuerst; status=draft, confirmed oder handed_over filtert. Nur für Mandanten ohne Buchhaltung.",
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"draft",
"confirmed",
"handed_over"
]
}
}
],
"responses": {
"200": {
"description": "Vorbuchungen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsPrePosting"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/documents/{id}/pre-posting — Vorbuchung eines Dokuments
Die Vorbuchung einer Eingangs- oder Ausgangsrechnung mit Kontierungsvorschlag (Herkunft und Begründung) und offenen Fragen. Gibt es noch keine, legt der erste Aufruf mit Schreibrecht einen Entwurf an.
{
"operationId": "get_api_v1_dms_documents_id_pre_posting",
"summary": "Vorbuchung eines Dokuments",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Die Vorbuchung einer Eingangs- oder Ausgangsrechnung mit Kontierungsvorschlag (Herkunft und Begründung) und offenen Fragen. Gibt es noch keine, legt der erste Aufruf mit Schreibrecht einen Entwurf an.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Vorbuchung eines Dokuments",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsPrePosting"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/dms/documents/{id}/pre-posting — Vorbuchung ändern
Ändert einen Entwurf: Geschäftspartner, Rechnungsdatum, Rechnungsnummer, Buchungstext, Leistungsdatum und Zeilen (ersetzt alle). remember_rule=true legt eine Kontierungsregel für den Geschäftspartner an. Bestätigte Vorbuchungen zuerst in der Oberfläche wieder öffnen; übergebene sind festgeschrieben.
{
"operationId": "put_api_v1_dms_documents_id_pre_posting",
"summary": "Vorbuchung ändern",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ändert einen Entwurf: Geschäftspartner, Rechnungsdatum, Rechnungsnummer, Buchungstext, Leistungsdatum und Zeilen (ersetzt alle). remember_rule=true legt eine Kontierungsregel für den Geschäftspartner an. Bestätigte Vorbuchungen zuerst in der Oberfläche wieder öffnen; übergebene sind festgeschrieben.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"partner_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"document_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"invoice_number": {
"anyOf": [
{
"type": "string",
"maxLength": 36
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
]
},
"service_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"lines": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer"
},
"tax_key_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"amount_cents": {
"type": "integer",
"minimum": 1
}
},
"required": [
"account_id",
"amount_cents"
],
"additionalProperties": false
}
},
"remember_rule": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Vorbuchung ändern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsPrePosting"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents/{id}/pre-posting/confirm — Vorbuchung bestätigen
Bestätigt einen Entwurf, wenn keine Frage offen ist. Bestätigte Vorbuchungen gehen mit der nächsten Übergabe an DATEV; übergeben wird nur in der Oberfläche nach frischer Bestätigung.
{
"operationId": "post_api_v1_dms_documents_id_pre_posting_confirm",
"summary": "Vorbuchung bestätigen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Bestätigt einen Entwurf, wenn keine Frage offen ist. Bestätigte Vorbuchungen gehen mit der nächsten Übergabe an DATEV; übergeben wird nur in der Oberfläche nach frischer Bestätigung.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Vorbuchung bestätigen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsPrePosting"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/datev/preview — Vorschau der DATEV-Übergabe
Was eine Übergabe an DATEV enthielte: Anzahl, Summe, Warnungen und Hindernisse für Beraternummer, Mandantennummer, Sachkontenlänge, Wirtschaftsjahr und Stichtag. Die Übergabe selbst schreibt fest und geht nur in der Oberfläche.
{
"operationId": "get_api_v1_dms_datev_preview",
"summary": "Vorschau der DATEV-Übergabe",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Was eine Übergabe an DATEV enthielte: Anzahl, Summe, Warnungen und Hindernisse für Beraternummer, Mandantennummer, Sachkontenlänge, Wirtschaftsjahr und Stichtag. Die Übergabe selbst schreibt fest und geht nur in der Oberfläche.",
"parameters": [
{
"name": "advisor",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "client",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "account_length",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 4,
"maximum": 8
}
},
{
"name": "fiscal_year",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "until",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Vorschau der DATEV-Übergabe",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"total_cents": {
"type": "integer"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"obstacles": {
"type": "array",
"items": {
"type": "string"
}
},
"fingerprint": {
"type": "string"
},
"pre_postings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"document_id": {
"type": "integer"
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"total_cents": {
"type": "integer"
}
},
"required": [
"id",
"document_id",
"invoice_number",
"document_date",
"total_cents"
],
"additionalProperties": false
}
},
"note": {
"type": "string"
}
},
"required": [
"count",
"total_cents",
"warnings",
"obstacles",
"fingerprint",
"pre_postings",
"note"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/datev/handovers — DATEV-Übergaben
Die bisherigen Übergaben an DATEV mit Nummer, Anzahl, Summe, Frist und Prüfsumme des Manifests.
{
"operationId": "get_api_v1_dms_datev_handovers",
"summary": "DATEV-Übergaben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Die bisherigen Übergaben an DATEV mit Nummer, Anzahl, Summe, Frist und Prüfsumme des Manifests.",
"responses": {
"200": {
"description": "DATEV-Übergaben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsDatevHandover"
}
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/datev/handovers/{id}/package — Paket einer DATEV-Übergabe
Lädt das Paket (ZIP mit Buchungsstapel im DATEV-Format, Festschreibung 0, Personenkonten, Belegen und Manifest) byte-gleich herunter, solange es zu seiner Prüfsumme passt.
{
"operationId": "get_api_v1_dms_datev_handovers_id_package",
"summary": "Paket einer DATEV-Übergabe",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Lädt das Paket (ZIP mit Buchungsstapel im DATEV-Format, Festschreibung 0, Personenkonten, Belegen und Manifest) byte-gleich herunter, solange es zu seiner Prüfsumme passt.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Paket einer DATEV-Übergabe",
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang oder Leistung reicht nicht; ein Mandant mit Buchhaltung bekommt vorbuchen_nicht_verfuegbar",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Paket nicht unverändert vorhanden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Zu viele Anfragen",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/documents/{id}/file — Datei eines Dokuments
Liefert die Datei, wenn der Benutzer des Zugangs das Dokument sieht (Rechte je Ordner, D5); passt sie nicht mehr zu ihrem Fingerabdruck, 404. Lesen gesperrter oder eingeschränkter Dokumente steht im Protokoll.
{
"operationId": "get_api_v1_dms_documents_id_file",
"summary": "Datei eines Dokuments",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Liefert die Datei, wenn der Benutzer des Zugangs das Dokument sieht (Rechte je Ordner, D5); passt sie nicht mehr zu ihrem Fingerabdruck, 404. Lesen gesperrter oder eingeschränkter Dokumente steht im Protokoll.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Die Datei des Dokuments, unverändert",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/access — Ordner, Sperren und Leserechte
Alle Ordner mit Pfad, ob gesperrt (selbst oder über einen Ordner darüber) und den gültigen Leserechten. Nur der Inhaber.
{
"operationId": "get_api_v1_dms_access",
"summary": "Ordner, Sperren und Leserechte",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Alle Ordner mit Pfad, ob gesperrt (selbst oder über einen Ordner darüber) und den gültigen Leserechten. Nur der Inhaber.",
"responses": {
"200": {
"description": "Ordner, Sperren und Leserechte",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/folders/{id}/lock — Ordner sperren oder freigeben
Einen gesperrten Ordner samt Unterordnern sehen nur der Inhaber und wer ein Leserecht daran hat. Steht im Protokoll.
{
"operationId": "post_api_v1_dms_folders_id_lock",
"summary": "Ordner sperren oder freigeben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Einen gesperrten Ordner samt Unterordnern sehen nur der Inhaber und wer ein Leserecht daran hat. Steht im Protokoll.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"locked": {
"type": "boolean"
}
},
"required": [
"locked"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Ordner sperren oder freigeben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/folders/{id}/rights — Leserecht am Ordner erteilen
Erteilt einer Person ein Leserecht am Ordner (vererbt auf Unterordner). Nie gelöscht, nur entzogen; steht im Protokoll.
{
"operationId": "post_api_v1_dms_folders_id_rights",
"summary": "Leserecht am Ordner erteilen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Erteilt einer Person ein Leserecht am Ordner (vererbt auf Unterordner). Nie gelöscht, nur entzogen; steht im Protokoll.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
}
},
"required": [
"user_id"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Leserecht am Ordner erteilen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/folder-rights/{id}/revoke — Leserecht entziehen
Entzieht ein Leserecht; das Recht bleibt mit Zeitpunkt des Entzugs im Protokoll.
{
"operationId": "post_api_v1_dms_folder_rights_id_revoke",
"summary": "Leserecht entziehen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Entzieht ein Leserecht; das Recht bleibt mit Zeitpunkt des Entzugs im Protokoll.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "Entzogen"
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents/{id}/restriction — Nach Art. 18 DSGVO einschränken
Das Dokument sehen danach nur Inhaber und Prüfer; Suchtext, Abschnitte und Vektoren werden gelöscht, Original, Siegel und Frist bleiben.
{
"operationId": "post_api_v1_dms_documents_id_restriction",
"summary": "Nach Art. 18 DSGVO einschränken",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Das Dokument sehen danach nur Inhaber und Prüfer; Suchtext, Abschnitte und Vektoren werden gelöscht, Original, Siegel und Frist bleiben.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Nach Art. 18 DSGVO einschränken",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents/{id}/restriction/lift — Einschränkung aufheben
Hebt die Einschränkung auf und gewinnt den Suchtext aus dem Original neu.
{
"operationId": "post_api_v1_dms_documents_id_restriction_lift",
"summary": "Einschränkung aufheben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Hebt die Einschränkung auf und gewinnt den Suchtext aus dem Original neu.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Einschränkung aufheben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/exports — Eigene Exporte
Die letzten 50 Exporte des Benutzers mit Stand, Anzahl, Fingerabdruck und Ablauf.
{
"operationId": "get_api_v1_dms_exports",
"summary": "Eigene Exporte",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Die letzten 50 Exporte des Benutzers mit Stand, Anzahl, Fingerabdruck und Ablauf.",
"responses": {
"200": {
"description": "Eigene Exporte",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/exports — Export anfordern
Packt im Hintergrund alle Dokumente, die der Zugang sehen darf, als ZIP mit Ordnerstruktur, Index (CSV, XML mit DTD), Prüfsummen, Protokoll und Prüfskript. scope: all, folder (mit folder_id) oder audit (from, to). Auch mit einem Schlüssel „nur lesen“.
{
"operationId": "post_api_v1_dms_exports",
"summary": "Export anfordern",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Packt im Hintergrund alle Dokumente, die der Zugang sehen darf, als ZIP mit Ordnerstruktur, Index (CSV, XML mit DTD), Prüfsummen, Protokoll und Prüfskript. scope: all, folder (mit folder_id) oder audit (from, to). Auch mit einem Schlüssel „nur lesen“.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"all",
"folder",
"audit"
]
},
"folder_id": {
"type": "integer"
},
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
}
},
"required": [
"scope"
],
"additionalProperties": false
}
}
}
},
"responses": {
"202": {
"description": "Export anfordern",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/exports/{id} — Stand eines Exports
Stand (queued, running, ready, failed, deleted), Anzahl, Größe, Fingerabdruck und file_url, solange die Datei da ist.
{
"operationId": "get_api_v1_dms_exports_id",
"summary": "Stand eines Exports",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Stand (queued, running, ready, failed, deleted), Anzahl, Größe, Fingerabdruck und file_url, solange die Datei da ist.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Stand eines Exports",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/exports/{id}/file — Export herunterladen
Das ZIP des Exports, 30 Tage lang, nur für den, der ihn angefordert hat.
{
"operationId": "get_api_v1_dms_exports_id_file",
"summary": "Export herunterladen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Das ZIP des Exports, 30 Tage lang, nur für den, der ihn angefordert hat.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "ZIP-Datei",
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/ask — Frage an die Dokumente
Beantwortet eine Frage in Alltagssprache nur aus Dokumenten, die der Zugang sehen darf (höchstens fünf), mit nummerierten Quellen; gerechnet wird nur auf dem eigenen KI-Server. status: answered, not_found (answer ist dann der feste Satz), read_only (die Frage verlangt eine Änderung; answer nennt den Weg), no_server (kein KI-Server erreichbar; notice und die gefundenen documents), busy. previous: vorige Fragen derselben Sitzung für den Abruf, document_ids grenzt auf diese Dokumente ein. Ändert nichts, auch mit einem Schlüssel „nur lesen“.
{
"operationId": "post_api_v1_dms_ask",
"summary": "Frage an die Dokumente",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Beantwortet eine Frage in Alltagssprache nur aus Dokumenten, die der Zugang sehen darf (höchstens fünf), mit nummerierten Quellen; gerechnet wird nur auf dem eigenen KI-Server. status: answered, not_found (answer ist dann der feste Satz), read_only (die Frage verlangt eine Änderung; answer nennt den Weg), no_server (kein KI-Server erreichbar; notice und die gefundenen documents), busy. previous: vorige Fragen derselben Sitzung für den Abruf, document_ids grenzt auf diese Dokumente ein. Ändert nichts, auch mit einem Schlüssel „nur lesen“.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"question": {
"type": "string",
"maxLength": 500
},
"previous": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500
},
"maxItems": 20
},
"document_ids": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 100
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Antwort mit Quellen oder Hinweis",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"answered",
"not_found",
"read_only",
"no_server",
"busy"
]
},
"answer": {
"type": [
"string",
"null"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "integer"
},
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"excerpt": {
"type": "string"
}
},
"required": [
"number",
"id",
"title",
"url",
"excerpt"
],
"additionalProperties": false
}
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"excerpt": {
"type": "string"
}
},
"required": [
"id",
"title",
"url",
"excerpt"
],
"additionalProperties": false
}
},
"notice": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"answer",
"sources",
"documents",
"notice",
"model"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/approvals — Laufende Rechnungsfreigaben
Eingangsrechnungen, deren Freigabe offen oder in Klärung ist, die der Benutzer sehen darf. Mit mine=1 nur die, bei denen er jetzt entscheiden oder eine Rückfrage beantworten soll.
{
"operationId": "get_api_v1_dms_approvals",
"summary": "Laufende Rechnungsfreigaben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Eingangsrechnungen, deren Freigabe offen oder in Klärung ist, die der Benutzer sehen darf. Mit mine=1 nur die, bei denen er jetzt entscheiden oder eine Rückfrage beantworten soll.",
"parameters": [
{
"name": "mine",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsFreigabe"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "Abgewiesen, mit Grund (etwa vier Augen, Grenze, nicht zuständig, Klärung offen)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/documents/{id}/approval — Stand der Rechnungsfreigabe
Stand, Stufe, Zuständige, Verlauf und was der Benutzer jetzt tun kann. status none, wenn das Dokument keine Freigabe braucht.
{
"operationId": "get_api_v1_dms_documents_id_approval",
"summary": "Stand der Rechnungsfreigabe",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Stand, Stufe, Zuständige, Verlauf und was der Benutzer jetzt tun kann. status none, wenn das Dokument keine Freigabe braucht.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsFreigabe"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument gibt es nicht oder es ist nicht sichtbar"
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/documents/{id}/approval — In der Rechnungsfreigabe entscheiden
Freigeben (approve), ablehnen mit Grund (reject, text), Klärung anfordern (clarify, user_id und text) oder die Klärung beantworten bzw. beenden (answer, text). Jede Entscheidung ist ein neues Ereignis im Protokoll; vier Augen ab der zweiten Stufe.
{
"operationId": "post_api_v1_dms_documents_id_approval",
"summary": "In der Rechnungsfreigabe entscheiden",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Freigeben (approve), ablehnen mit Grund (reject, text), Klärung anfordern (clarify, user_id und text) oder die Klärung beantworten bzw. beenden (answer, text). Jede Entscheidung ist ein neues Ereignis im Protokoll; vier Augen ab der zweiten Stufe.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"approve",
"reject",
"clarify",
"answer"
]
},
"text": {
"type": "string",
"maxLength": 1000
},
"user_id": {
"type": "integer"
}
},
"required": [
"action"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsFreigabe"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Dokument gibt es nicht oder es ist nicht sichtbar"
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "Abgewiesen, mit Grund (etwa vier Augen, Grenze, nicht zuständig, Klärung offen)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/approval-settings — Regeln und Freigeber der Rechnungsfreigabe
Ob die Freigabe an ist, die aktiven Regeln (ab Betrag, Stufen, benannte Freigeber), die Freigeber (Grenzen anderer nur für den Inhaber) und die Erinnerungsfristen in Werktagen. Vergeben wird nur in der Oberfläche.
{
"operationId": "get_api_v1_dms_approval_settings",
"summary": "Regeln und Freigeber der Rechnungsfreigabe",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Ob die Freigabe an ist, die aktiven Regeln (ab Betrag, Stufen, benannte Freigeber), die Freigeber (Grenzen anderer nur für den Inhaber) und die Erinnerungsfristen in Werktagen. Vergeben wird nur in der Oberfläche.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"from_cents": {
"type": "integer"
},
"stages": {
"type": "integer"
},
"stage1_user_id": {
"type": [
"integer",
"null"
]
},
"stage2_user_id": {
"type": [
"integer",
"null"
]
}
}
}
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"limit_cents": {
"type": [
"integer",
"null"
]
}
}
}
},
"reminders": {
"type": "object",
"properties": {
"after_working_days": {
"type": "integer"
},
"owner_after_working_days": {
"type": "integer"
}
}
}
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/dms/absences — Abwesenheiten der Freigeber
Laufende und kommende Abwesenheiten mit Vertreter: für den Inhaber alle, sonst die eigenen und die, in denen man vertritt.
{
"operationId": "get_api_v1_dms_absences",
"summary": "Abwesenheiten der Freigeber",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Laufende und kommende Abwesenheiten mit Vertreter: für den Inhaber alle, sonst die eigenen und die, in denen man vertritt.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"from": {
"type": "string",
"format": "date"
},
"until": {
"type": "string",
"format": "date"
},
"deputy_id": {
"type": [
"integer",
"null"
]
},
"deputy": {
"type": [
"string",
"null"
]
}
}
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/absences — Abwesenheit eintragen
Eigene Abwesenheit (der Inhaber auch für andere, user_id) mit Vertreter. In der Zeit entscheidet der Vertreter die zugeordneten Stufen „in Vertretung für“.
{
"operationId": "post_api_v1_dms_absences",
"summary": "Abwesenheit eintragen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Eigene Abwesenheit (der Inhaber auch für andere, user_id) mit Vertreter. In der Zeit entscheidet der Vertreter die zugeordneten Stufen „in Vertretung für“.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date"
},
"until": {
"type": "string",
"format": "date"
},
"deputy_id": {
"type": "integer"
},
"user_id": {
"type": "integer"
}
},
"required": [
"from",
"until"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Eingetragen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "Abgewiesen, mit Grund (etwa vier Augen, Grenze, nicht zuständig, Klärung offen)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/dms/absences/{id}/end — Abwesenheit aufheben
Hebt eine Abwesenheit auf; gelöscht wird nichts.
{
"operationId": "post_api_v1_dms_absences_id_end",
"summary": "Abwesenheit aufheben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Hebt eine Abwesenheit auf; gelöscht wird nichts.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"ended": {
"type": "boolean"
}
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Bei diesem Mandanten gibt die Buchhaltung frei, nicht das DMS (code freigabe_buchhaltung)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"freigabe_buchhaltung"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}
}
}
},
"422": {
"description": "Abgewiesen, mit Grund (etwa vier Augen, Grenze, nicht zuständig, Klärung offen)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PATCH /api/v1/dms/folders/{id} — Ordner umbenennen oder verschieben
Benennt einen Ordner um (name) und/oder verschiebt ihn (parent_id; null = oberste Ebene). Nur der Inhaber. Jahresordner bleiben, kein Ordner kommt unter sich selbst, ein Verschieben, das jemandem mehr zeigen würde, wird mit 422 abgewiesen. Beides steht im Protokoll.
{
"operationId": "patch_api_v1_dms_folders_id",
"summary": "Ordner umbenennen oder verschieben",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Benennt einen Ordner um (name) und/oder verschiebt ihn (parent_id; null = oberste Ebene). Nur der Inhaber. Jahresordner bleiben, kein Ordner kommt unter sich selbst, ein Verschieben, das jemandem mehr zeigen würde, wird mit 422 abgewiesen. Beides steht im Protokoll.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"parent_id": {
"type": [
"integer",
"null"
]
}
},
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Ordner umbenennen oder verschieben",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_id": {
"type": [
"integer",
"null"
]
},
"path": {
"type": "string"
}
},
"required": [
"id",
"name",
"parent_id",
"path"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Nicht gefunden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"description": "Kennung des Ordners."
}
]
}POST /api/v1/dms/document-types — Eigene Dokumentart anlegen
Legt eine eigene Dokumentart an. based_on ist die Kennung einer vorgegebenen Art (nicht datev_uebergabe); von ihr erbt die eigene Art Mindestfrist, Ereignis, buchungsrelevant und Festschreiben. retention_years nie unter der Mindestfrist des Vorbilds, danach nur verlängerbar. Nur der Inhaber; nie gelöscht.
{
"operationId": "post_api_v1_dms_document_types",
"summary": "Eigene Dokumentart anlegen",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Legt eine eigene Dokumentart an. based_on ist die Kennung einer vorgegebenen Art (nicht datev_uebergabe); von ihr erbt die eigene Art Mindestfrist, Ereignis, buchungsrelevant und Festschreiben. retention_years nie unter der Mindestfrist des Vorbilds, danach nur verlängerbar. Nur der Inhaber; nie gelöscht.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120
},
"based_on": {
"type": "string",
"maxLength": 64
},
"folder_id": {
"type": "integer"
},
"retention_years": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"reason": {
"type": "string",
"maxLength": 500
}
},
"required": [
"name",
"based_on",
"folder_id",
"retention_years",
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"201": {
"description": "Eigene Dokumentart anlegen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DmsDocumentType"
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}POST /api/v1/dms/deletions/proposal — Löschvorschlag mit Bestätigung
Schritt 1 des endgültigen Löschens: nennt von ids die löschbaren (Frist abgelaufen oder 30 Tage im Papierkorb) und die übrigen mit Grund, dazu eine Bestätigungskennung (15 Minuten, nur für diesen Benutzer, einmal verwendbar). Löscht nichts. Nur der Inhaber mit Zugang „Verwalten“.
{
"operationId": "post_api_v1_dms_deletions_proposal",
"summary": "Löschvorschlag mit Bestätigung",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Schritt 1 des endgültigen Löschens: nennt von ids die löschbaren (Frist abgelaufen oder 30 Tage im Papierkorb) und die übrigen mit Grund, dazu eine Bestätigungskennung (15 Minuten, nur für diesen Benutzer, einmal verwendbar). Löscht nichts. Nur der Inhaber mit Zugang „Verwalten“.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"minItems": 1,
"maxItems": 500
}
},
"required": [
"ids"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Löschvorschlag mit Bestätigung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deletable": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmsDocument"
}
},
"rejected": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"message"
],
"additionalProperties": false
}
},
"confirmation": {
"type": [
"string",
"null"
]
},
"valid_until": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"notice": {
"type": "string"
}
},
"required": [
"deletable",
"rejected",
"confirmation",
"valid_until",
"notice"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}POST /api/v1/dms/deletions — Endgültig löschen mit Bestätigung
Schritt 2: löscht genau die Dokumente der Bestätigungskennung aus Schritt 1, mit Grund; Datei und Suchtext gehen, Zeile, Siegel, Löschnachweis und Protokoll bleiben. Eine Kennung gilt nur einmal, nur für denselben Benutzer und 15 Minuten (sonst 422). Nur der Inhaber mit Zugang „Verwalten“.
{
"operationId": "post_api_v1_dms_deletions",
"summary": "Endgültig löschen mit Bestätigung",
"tags": [
"dms"
],
"security": [
{
"sanctum": []
}
],
"description": "Schritt 2: löscht genau die Dokumente der Bestätigungskennung aus Schritt 1, mit Grund; Datei und Suchtext gehen, Zeile, Siegel, Löschnachweis und Protokoll bleiben. Eine Kennung gilt nur einmal, nur für denselben Benutzer und 15 Minuten (sonst 422). Nur der Inhaber mit Zugang „Verwalten“.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"confirmation": {
"type": "string",
"maxLength": 20000
},
"reason": {
"type": "string",
"maxLength": 500
}
},
"required": [
"confirmation",
"reason"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Endgültig löschen mit Bestätigung",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "integer",
"minimum": 0
},
"rejected": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"deleted",
"rejected"
],
"additionalProperties": false
},
"setup": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"message": {
"type": "string"
},
"missing": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"complete",
"message",
"missing"
],
"additionalProperties": false
},
"billing": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"overdue",
"payment_failed"
]
},
"can_write": {
"type": "boolean"
},
"message": {
"type": "string"
},
"due_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_cents": {
"anyOf": [
{
"type": "integer",
"description": "Ganzzahlige Cent, keine Euro-Gleitkommazahl."
},
{
"type": "null"
}
]
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transfer": {
"type": [
"object",
"null"
],
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"status",
"can_write",
"message",
"due_by",
"amount_cents",
"reference",
"transfer"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "Bearer fehlt/ungültig/widerrufen oder falscher Mandant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Rolle, Zugang, Leistung oder Mandantenstatus verweigert",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Ungültige Angaben",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "120 je Minute und Mandant/Zugang",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Vorübergehend nicht möglich",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": []
}Die Ansicht zeigt ausschließlich den Vertrag; sie sendet keine API-Anfragen.