{ "openapi": "3.0.0", "info": { "title": "ClubCoPilot API", "description": "Öffentliche API von ClubCoPilot je Verein: https://{verein-host}/api/{version}/{modul}/… — jede Modul-API ist standardmäßig aus und wird vom Verein eingeschaltet. Zugriff mit einem ZITADEL-Token; es gelten die Rechte der Person im Verein (inkl. Abteilungen).", "version": "1.0.0" }, "servers": [ { "url": "https://{verein}/api/v1", "description": "Host des Vereins", "variables": { "verein": { "default": "mein-verein.clubcopilot.de", "description": "Domain des Vereins" } } } ], "paths": { "/ablage/dokumente": { "get": { "tags": [ "ablage" ], "summary": "Dokumente der Ablage auflisten (Metadaten)", "operationId": "ablageDokumenteListe", "parameters": [ { "name": "seite", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "pro_seite", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "quelle", "in": "query", "description": "Herkunft, z. B. upload", "required": false, "schema": { "type": "string" } }, { "name": "kategorie", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Eine Seite Dokumente, jüngste zuerst", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AblageDokument" } }, "meta": { "$ref": "#/components/schemas/Seitenangabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/ablage/dokumente/{id}": { "get": { "tags": [ "ablage" ], "summary": "Die Metadaten eines Dokuments lesen", "operationId": "ablageDokumentZeigen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Das Dokument", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/AblageDokument" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/inventar/artikel": { "get": { "tags": [ "inventar" ], "summary": "Inventar-Artikel auflisten", "operationId": "inventarArtikelListe", "parameters": [ { "name": "kategorie_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "standort_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "typ", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "einzelstueck", "verbrauch", "set" ] } }, { "name": "status[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "aktiv", "defekt", "ausgemustert", "verloren" ] } } }, { "name": "unter_mindestbestand", "in": "query", "description": "Nur Artikel unter dem Mindestbestand", "required": false, "schema": { "type": "boolean" } }, { "name": "hoechstens", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1 } } ], "responses": { "200": { "description": "Artikel nach Name", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventarArtikel" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] }, "post": { "tags": [ "inventar" ], "summary": "Inventar-Artikel anlegen (Stammdaten)", "operationId": "inventarArtikelAnlegen", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Gleicher Schlüssel = gleiches Ergebnis, auch bei Wiederholung", "required": false, "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventarArtikelEingabe" } } } }, "responses": { "201": { "description": "Angelegt", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InventarArtikel" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/inventar/artikel/{id}": { "get": { "tags": [ "inventar" ], "summary": "Einen Inventar-Artikel lesen", "operationId": "inventarArtikelZeigen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Der Artikel mit Set-Komponenten", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InventarArtikel" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] }, "put": { "tags": [ "inventar" ], "summary": "Inventar-Artikel ändern (Stammdaten)", "operationId": "inventarArtikelAendern", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventarArtikelEingabe" } } } }, "responses": { "200": { "description": "Geändert", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InventarArtikel" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/inventar/kategorien": { "get": { "tags": [ "inventar" ], "summary": "Inventar-Kategorien auflisten", "operationId": "inventarKategorienListe", "responses": { "200": { "description": "Kategorien in ihrer Reihenfolge", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventarKategorie" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/inventar/standorte": { "get": { "tags": [ "inventar" ], "summary": "Inventar-Standorte auflisten", "operationId": "inventarStandorteListe", "responses": { "200": { "description": "Standorte in ihrer Reihenfolge", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventarStandort" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/kommunikation/vorlagen": { "get": { "tags": [ "kommunikation" ], "summary": "Brief- und Mailvorlagen auflisten (ohne Inhalt)", "operationId": "kommunikationVorlagenListe", "parameters": [ { "name": "nur_aktiv", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "kategorie", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Vorlagen nach Kategorie und Name", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KommunikationVorlage" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/kommunikation/briefe": { "get": { "tags": [ "kommunikation" ], "summary": "Briefe des Postausgangs auflisten (ohne Inhalt und Anschrift)", "operationId": "kommunikationBriefeListe", "parameters": [ { "name": "seite", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "pro_seite", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "kanal", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "email", "post" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "draft", "queued", "print", "sent", "failed" ] } } ], "responses": { "200": { "description": "Eine Seite Briefe, jüngste zuerst", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KommunikationBrief" } }, "meta": { "$ref": "#/components/schemas/Seitenangabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] }, "post": { "tags": [ "kommunikation" ], "summary": "Brief-Entwurf aus einer Vorlage anlegen (kein Versand)", "description": "Legt nur einen ENTWURF (Status draft) an. Versenden bestätigt ein Mensch in ClubCoPilot.", "operationId": "kommunikationBriefEntwerfen", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Gleicher Schlüssel = gleiches Ergebnis, auch bei Wiederholung", "required": false, "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BriefEntwurfEingabe" } } } }, "responses": { "201": { "description": "Entwurf angelegt", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/KommunikationBrief" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/rechnungen/rechnungen": { "get": { "tags": [ "rechnungen" ], "summary": "Rechnungen auflisten", "operationId": "rechnungenListe", "parameters": [ { "name": "seite", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "pro_seite", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "status[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "issued", "partially_paid", "paid", "cancelled" ] } } } ], "responses": { "200": { "description": "Eine Seite Rechnungen, neueste zuerst", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rechnung" } }, "meta": { "$ref": "#/components/schemas/Seitenangabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] }, "post": { "tags": [ "rechnungen" ], "summary": "Rechnungsentwurf anlegen (ohne Nummer, nicht festgeschrieben)", "description": "Legt nur einen ENTWURF (Status draft) an. Festschreiben, Nummer und Versand bleiben der Oberfläche vorbehalten.", "operationId": "rechnungenEntwerfen", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Gleicher Schlüssel = gleiches Ergebnis, auch bei Wiederholung", "required": false, "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechnungEntwurfEingabe" } } } }, "responses": { "201": { "description": "Entwurf angelegt", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Rechnung" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/rechnungen/rechnungen/{id}": { "get": { "tags": [ "rechnungen" ], "summary": "Eine Rechnung mit Positionen lesen", "operationId": "rechnungenZeigen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Die Rechnung", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Rechnung" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/sepa/mandate": { "get": { "tags": [ "sepa" ], "summary": "SEPA-Mandate auflisten", "operationId": "sepaMandateListe", "parameters": [ { "name": "seite", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "pro_seite", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "aktiv", "widerrufen", "verfallen", "unterschrift_fehlt" ] } } ], "responses": { "200": { "description": "Eine Seite Mandate, neueste zuerst", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SepaMandat" } }, "meta": { "$ref": "#/components/schemas/Seitenangabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/trainingsbetrieb/sportstaetten": { "get": { "tags": [ "trainingsbetrieb" ], "summary": "Sportstätten mit Teilflächen auflisten", "operationId": "trainingsbetriebSportstaettenListe", "parameters": [ { "name": "aktiv", "in": "query", "description": "Nur aktive Sportstätten", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Sportstätten nach Reihenfolge und Name", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Sportstaette" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/trainingsbetrieb/sportstaetten/{id}": { "get": { "tags": [ "trainingsbetrieb" ], "summary": "Eine Sportstätte lesen", "operationId": "trainingsbetriebSportstaetteZeigen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Die Sportstätte", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Sportstaette" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/kalender/termine": { "get": { "tags": [ "kalender" ], "summary": "Vereinstermine auflisten", "operationId": "kalenderTermineListe", "parameters": [ { "name": "von", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "bis", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "sichtbarkeit[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "oeffentlich", "mitglieder", "team" ] } } }, { "name": "team_ids[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "hoechstens", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1 } } ], "responses": { "200": { "description": "Termine nach Beginn", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Termin" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] }, "post": { "tags": [ "kalender" ], "summary": "Vereinstermin anlegen", "operationId": "kalenderTerminAnlegen", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminEingabe" } } } }, "responses": { "201": { "description": "Angelegt", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Termin" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } }, "/kalender/termine/{id}": { "get": { "tags": [ "kalender" ], "summary": "Einen Vereinstermin lesen", "operationId": "kalenderTerminZeigen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Der Termin", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Termin" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] }, "put": { "tags": [ "kalender" ], "summary": "Vereinstermin ändern", "operationId": "kalenderTerminAendern", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminEingabe" } } } }, "responses": { "200": { "description": "Geändert", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Termin" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] }, "delete": { "tags": [ "kalender" ], "summary": "Vereinstermin löschen", "operationId": "kalenderTerminLoeschen", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Gelöscht" }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" } }, "security": [ { "zitadel": [] } ] } }, "/spenden/zuwendungen": { "get": { "tags": [ "spenden" ], "summary": "Zuwendungen auflisten", "operationId": "spendenZuwendungenListe", "parameters": [ { "name": "seite", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "pro_seite", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ausstehend", "offen", "bestaetigt", "storniert" ] } }, { "name": "art", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "geld", "sache", "aufwandsverzicht", "mitgliedsbeitrag" ] } }, { "name": "jahr", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Eine Seite Zuwendungen, neueste zuerst", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Zuwendung" } }, "meta": { "$ref": "#/components/schemas/Seitenangabe" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/NichtAngemeldet" }, "403": { "$ref": "#/components/responses/KeinRecht" }, "404": { "$ref": "#/components/responses/NichtGefunden" }, "422": { "$ref": "#/components/responses/Ungueltig" } }, "security": [ { "zitadel": [] } ] } } }, "components": { "schemas": { "Seitenangabe": { "properties": { "seite": { "description": "Antwortformen der Finanz-APIs (Rechnungen, Zuwendungen, SEPA-Mandate) — ohne Personendaten und Klartext-IBAN.", "type": "integer" }, "pro_seite": { "type": "integer" }, "gesamt": { "description": "Zahl der Treffer nach Filter", "type": "integer" } }, "type": "object" }, "Rechnung": { "required": [ "id", "status", "brutto" ], "properties": { "id": { "type": "integer" }, "nummer": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "draft", "issued", "partially_paid", "paid", "cancelled" ] }, "rechnungsdatum": { "type": "string", "format": "date", "nullable": true }, "leistungsdatum": { "type": "string", "format": "date", "nullable": true }, "faellig_am": { "type": "string", "format": "date", "nullable": true }, "netto": { "type": "string", "example": "100.00" }, "umsatzsteuer": { "type": "string", "example": "0.00" }, "brutto": { "type": "string", "example": "100.00" }, "bezahlt": { "type": "string", "example": "0.00" }, "offen": { "type": "string", "example": "100.00" }, "storniert_am": { "type": "string", "nullable": true }, "positionen": { "description": "Nur beim Einzelabruf", "type": "array", "items": { "properties": { "position": { "type": "integer" }, "bezeichnung": { "type": "string" }, "menge": { "type": "string" }, "einheit": { "type": "string" }, "einzelpreis": { "type": "string" }, "ust_satz": { "type": "string" }, "netto": { "type": "string" }, "umsatzsteuer": { "type": "string" }, "brutto": { "type": "string" } }, "type": "object" } } }, "type": "object" }, "Zuwendung": { "required": [ "id", "datum", "betrag", "art", "status" ], "properties": { "id": { "type": "integer" }, "datum": { "description": "Zufluss-Datum", "type": "string", "format": "date" }, "betrag": { "type": "string", "example": "50.00" }, "art": { "type": "string", "enum": [ "geld", "sache", "aufwandsverzicht", "mitgliedsbeitrag" ] }, "status": { "type": "string", "enum": [ "ausstehend", "offen", "bestaetigt", "storniert" ] }, "quelle": { "type": "string", "enum": [ "manuell", "bank", "stripe", "beitrag" ] }, "projekt_id": { "type": "integer", "nullable": true }, "projekt_name": { "type": "string", "nullable": true }, "bestaetigt": { "description": "Gehört zu einer Zuwendungsbestätigung", "type": "boolean" } }, "type": "object" }, "SepaMandat": { "required": [ "id", "referenz", "status" ], "properties": { "id": { "type": "integer" }, "referenz": { "type": "string" }, "status": { "type": "string", "enum": [ "aktiv", "widerrufen", "verfallen", "unterschrift_fehlt" ] }, "sequenz": { "type": "string", "enum": [ "FRST", "RCUR" ] }, "quelle": { "type": "string" }, "unterschrieben_am": { "type": "string", "format": "date", "nullable": true }, "verfaellt_am": { "type": "string", "format": "date", "nullable": true }, "widerrufen_am": { "type": "string", "nullable": true }, "iban_maskiert": { "type": "string", "nullable": true } }, "type": "object" }, "Termin": { "required": [ "id", "titel", "kategorie", "starts_at", "ganztags", "sichtbarkeit" ], "properties": { "id": { "type": "integer" }, "titel": { "type": "string" }, "beschreibung": { "type": "string", "nullable": true }, "kategorie": { "type": "string", "enum": [ "jhv", "fest", "sitzung", "turnier", "sonstiges" ] }, "starts_at": { "type": "string", "format": "date-time" }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "ganztags": { "type": "boolean" }, "ort": { "type": "string", "nullable": true }, "sichtbarkeit": { "type": "string", "enum": [ "oeffentlich", "mitglieder", "team" ] }, "team_id": { "type": "integer", "nullable": true }, "abteilung_id": { "type": "integer", "nullable": true } }, "type": "object" }, "TerminEingabe": { "required": [ "titel", "kategorie", "starts_at", "sichtbarkeit" ], "properties": { "titel": { "type": "string", "maxLength": 255 }, "beschreibung": { "type": "string", "nullable": true }, "kategorie": { "type": "string", "enum": [ "jhv", "fest", "sitzung", "turnier", "sonstiges" ] }, "starts_at": { "type": "string", "format": "date-time" }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "ganztags": { "type": "boolean" }, "ort": { "type": "string", "maxLength": 255, "nullable": true }, "sichtbarkeit": { "type": "string", "enum": [ "oeffentlich", "mitglieder", "team" ] }, "team_id": { "type": "integer", "nullable": true }, "abteilung_id": { "type": "integer", "nullable": true } }, "type": "object" }, "Teilflaeche": { "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "position": { "type": "integer" }, "cells": { "description": "Bitmaske der abgedeckten Grundzellen", "type": "integer" }, "is_active": { "type": "boolean" } }, "type": "object" }, "Sportstaette": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "hall", "field" ] }, "color": { "type": "string" }, "divisions": { "type": "integer", "enum": [ 1, 2, 4, 8 ] }, "address": { "type": "string", "nullable": true }, "is_active": { "type": "boolean" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Teilflaeche" } } }, "type": "object" }, "InventarKomponente": { "properties": { "id": { "type": "integer" }, "bezeichnung": { "type": "string" }, "menge": { "description": "Feste Menge, wenn keine Größen gepflegt sind", "type": "integer", "nullable": true }, "groessen": { "type": "array", "items": { "properties": { "groesse": { "type": "string" }, "bestand": { "type": "integer" } }, "type": "object" } } }, "type": "object" }, "InventarArtikel": { "required": [ "id", "name", "typ", "status", "bestand" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "typ": { "type": "string", "enum": [ "einzelstueck", "verbrauch", "set" ] }, "status": { "type": "string", "enum": [ "aktiv", "defekt", "ausgemustert", "verloren" ] }, "zustand": { "type": "string", "nullable": true }, "inventar_nummer": { "type": "string", "nullable": true }, "seriennummer": { "type": "string", "nullable": true }, "bestand": { "type": "integer" }, "mindestbestand": { "type": "integer", "nullable": true }, "kategorie_id": { "type": "integer", "nullable": true }, "kategorie_name": { "type": "string", "nullable": true }, "standort_id": { "type": "integer", "nullable": true }, "standort_name": { "type": "string", "nullable": true }, "abteilung_id": { "type": "integer", "nullable": true }, "komponenten": { "type": "array", "items": { "$ref": "#/components/schemas/InventarKomponente" } } }, "type": "object" }, "InventarKategorie": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true } }, "type": "object" }, "InventarStandort": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "type": "object" }, "AblageDokument": { "required": [ "id", "dateiname" ], "properties": { "id": { "type": "integer" }, "titel": { "type": "string", "nullable": true }, "dateiname": { "type": "string" }, "mime": { "type": "string", "nullable": true }, "groesse": { "description": "Bytes", "type": "integer", "nullable": true }, "kategorie": { "type": "string", "nullable": true }, "quelle": { "type": "string", "nullable": true }, "mitglied_id": { "type": "string", "nullable": true }, "haushalt_id": { "type": "integer", "nullable": true }, "erstellt_am": { "type": "string", "format": "date-time", "nullable": true }, "geaendert_am": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "KommunikationVorlage": { "required": [ "id", "key", "name" ], "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" }, "betreff": { "type": "string" }, "kategorie": { "type": "string", "nullable": true }, "beschreibung": { "type": "string", "nullable": true }, "kanal": { "type": "string", "enum": [ "email", "post" ] }, "system": { "type": "boolean" }, "aktiv": { "type": "boolean" }, "geaendert_am": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "KommunikationBrief": { "required": [ "id", "betreff", "kanal", "status" ], "properties": { "id": { "type": "integer" }, "betreff": { "type": "string" }, "kanal": { "type": "string", "enum": [ "email", "post" ] }, "status": { "type": "string", "enum": [ "draft", "queued", "print", "sent", "failed" ] }, "erstellt_am": { "type": "string", "format": "date-time", "nullable": true }, "gesendet_am": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "BriefEntwurfEingabe": { "required": [ "vorlage_id", "kanal", "empfaenger" ], "properties": { "vorlage_id": { "type": "integer" }, "kanal": { "type": "string", "enum": [ "email", "post" ] }, "haushalt_id": { "type": "integer", "nullable": true }, "empfaenger": { "required": [ "mitglied_id", "name" ], "properties": { "mitglied_id": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "email": { "type": "string", "format": "email", "nullable": true }, "anschrift": { "description": "Anschrift in einer Zeile", "type": "string", "nullable": true }, "nummer": { "description": "Mitgliedsnummer", "type": "string", "nullable": true } }, "type": "object" }, "werte": { "description": "Platzhalter-Name → Text für die Vorlage", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "RechnungEntwurfEingabe": { "required": [ "empfaenger_name", "ust_modus", "positionen" ], "properties": { "empfaenger_name": { "type": "string", "maxLength": 255 }, "empfaenger_adresse": { "type": "string", "nullable": true }, "empfaenger_plz": { "type": "string", "nullable": true }, "empfaenger_ort": { "type": "string", "nullable": true }, "empfaenger_land": { "type": "string", "maxLength": 2, "minLength": 2, "example": "DE" }, "empfaenger_email": { "type": "string", "format": "email", "nullable": true }, "empfaenger_ust_id": { "type": "string", "nullable": true }, "rechnungsdatum": { "type": "string", "format": "date", "nullable": true }, "leistungsdatum": { "type": "string", "format": "date", "nullable": true }, "faellig_am": { "type": "string", "format": "date", "nullable": true }, "zahlungsziel_tage": { "type": "integer", "maximum": 365, "minimum": 0, "nullable": true }, "ust_modus": { "type": "string", "enum": [ "standard", "kleinunternehmer", "exempt" ] }, "hinweis": { "type": "string", "maxLength": 1000, "nullable": true }, "positionen": { "type": "array", "items": { "required": [ "bezeichnung", "menge", "einzelpreis" ], "properties": { "bezeichnung": { "type": "string", "maxLength": 500 }, "menge": { "type": "number", "example": 1 }, "einheit": { "type": "string", "nullable": true }, "einzelpreis": { "type": "number", "example": 25.5 }, "ust_satz": { "type": "number", "nullable": true } }, "type": "object" }, "minItems": 1 } }, "type": "object" }, "InventarArtikelEingabe": { "required": [ "name", "typ" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "typ": { "type": "string", "enum": [ "einzelstueck", "verbrauch", "set" ] }, "status": { "type": "string", "default": "aktiv", "enum": [ "aktiv", "defekt", "ausgemustert", "verloren" ] }, "zustand": { "type": "string", "enum": [ "neu", "gut", "gebraucht", "defekt" ], "nullable": true }, "kategorie_id": { "type": "integer", "nullable": true }, "standort_id": { "type": "integer", "nullable": true }, "abteilung_id": { "type": "integer", "nullable": true }, "inventar_nummer": { "type": "string", "nullable": true }, "seriennummer": { "type": "string", "nullable": true }, "bestand": { "type": "integer", "minimum": 0 }, "mindestbestand": { "type": "integer", "minimum": 0, "nullable": true } }, "type": "object" } }, "responses": { "NichtGefunden": { "description": "Nicht gefunden — auch, wenn die Modul-API des Vereins aus ist" }, "NichtAngemeldet": { "description": "Kein oder ungültiges Token" }, "KeinRecht": { "description": "Die Person hat das nötige Recht nicht oder ist im Verein unbekannt" }, "Ungueltig": { "description": "Ungültige Eingaben", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Kopf der öffentlichen API-Beschreibung (K29/K30). Die Pfade beschreiben die Controller unter\n`App\\Http\\Controllers\\Api` per Attribut; `php artisan api:spec` erzeugt daraus `openapi.json` für das\nEntwicklerportal developer.clubcopilot.de. Dienst-zu-Dienst-Aufrufe stehen bewusst NICHT darin.", "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" } } } } }, "securitySchemes": { "zitadel": { "type": "http", "description": "ZITADEL-Zugangstoken (OAuth 2.0)", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "ablage", "description": "ablage" }, { "name": "inventar", "description": "inventar" }, { "name": "kommunikation", "description": "kommunikation" }, { "name": "rechnungen", "description": "rechnungen" }, { "name": "sepa", "description": "sepa" }, { "name": "trainingsbetrieb", "description": "trainingsbetrieb" }, { "name": "kalender", "description": "kalender" }, { "name": "spenden", "description": "spenden" } ] }