Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
membershipperiodAPI-Referenz
GET/v2/membershipperiod

Abrechnungsperioden einer Mitgliedschaft lesen

Liest Abrechnungsperioden genau einer Mitgliedschaft. Ohne id muss membership direkt als Query oder als filter-Eintrag vorhanden sein; fehlt beides, folgt membership_filter_required. Ein id-Selector liest stattdessen einen Einzelbeleg. Vor der Rückgabe werden verpasste Zahlungsrückmeldungen abgeglichen. Das kann Perioden/Zahlungsreferenzen, Mitgliedschaftsstatus, Gültigkeit, Nutzungsbestand, Audit und Outbox dauerhaft ändern. Sortierung: period_start absteigend, danach Beleg-ID; total ist die Gesamtzahl vor Pagination.

Operation-ID get_v2_membershipperiod

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

03

Parameter

Query-Parameter

filteroptional

JSON-Filter: id wählt einen Einzelbeleg; membership wählt die zugehörige Mitgliedschaft. Mindestens eine dieser Auswahlen ist erforderlich. Andere Eigenschaften und expression werden ignoriert.

application/json

array
Array-Elemente
object
property string erforderlich
value Typ nicht eingeschränkt erforderlich
expression string

Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {},
      "expression": {
        "type": "string",
        "description": "Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value."
      }
    },
    "additionalProperties": true,
    "required": [
      "property",
      "value"
    ]
  }
}
Beispiel
[
  {
    "property": "membership",
    "value": "usermembership_012345abcdef_123456"
  }
]
limitoptional

JSON-Objekt mit start (Offset) und reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; negative Offsets auf 0 gesetzt.

application/json

Typ nicht eingeschränkt
oneOf · Genau eine Variante muss passen
Variante 1 object
start integer
minimum
0

Standardwert: 0

reply integer
minimum
1
maximum
500

Standardwert: 100

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 integer
minimum
1
maximum
500
Vollständiges Schema als JSON
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "start": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        },
        "reply": {
          "type": "integer",
          "minimum": 1,
          "maximum": 500,
          "default": 100
        }
      },
      "additionalProperties": true
    },
    {
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    }
  ]
}
Beispiel
{
  "start": 0,
  "reply": 25
}
idoptional

Einzelobjekt über id auswählen; alternativ gleichnamiger Eintrag im JSON-filter.

string

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"membershipperiod_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
  "examples": [
    "membershipperiod_012345abcdef_123456"
  ]
}
membershipoptional

Pflichtauswahl für die Liste: Mitgliedschaft im aktuellen Konto; alternativ filter mit property=membership.

string

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^usermembership_[a-f0-9]{12}_-?[0-9]+$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
}

Header

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string
pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

11

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data ist bei membership-Auswahl eine JSON-Liste (auch leer), bei id-Auswahl ein einzelnes Objekt. error=false und success=true. Zusätzlich total vor Pagination.

Response Header

X-Edoobox-Revision

Rotated account revision supplied for the next action in one reviewed sequence.

string
pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

application/json

object
success boolean
error boolean | string
error_code string
data Typ nicht eingeschränkt
oneOf · Genau eine Variante muss passen
Variante 1 array
Array-Elemente
object
id string erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"
membership string erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^usermembership_[a-f0-9]{12}_-?[0-9]+$"
type string erforderlich
period_start integer | null erforderlich
period_end integer | null erforderlich
payment_status string erforderlich
amounts object erforderlich
gross string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
net string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
tax string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
currency string erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

vat object erforderlich
id string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^vat_[a-f0-9]{12}_-?[0-9]+$"
rate string erforderlich
label string erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

title string erforderlich
plan_version integer erforderlich
design string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^design_[a-f0-9]{12}_-?[0-9]+$"
transaction string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^transaction_[a-f0-9]{12}_-?[0-9]+$"
invoice string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
invoice_number string | null erforderlich
payment string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
reminder_due_at integer | null erforderlich
renewal_due_at integer | null erforderlich
created_at integer erforderlich
updated_at integer erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 object
id string erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"
membership string erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^usermembership_[a-f0-9]{12}_-?[0-9]+$"
type string erforderlich
period_start integer | null erforderlich
period_end integer | null erforderlich
payment_status string erforderlich
amounts object erforderlich
gross string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
net string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
tax string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern
"^-?[0-9]+\\.[0-9]{2}$"
currency string erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

vat object erforderlich
id string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^vat_[a-f0-9]{12}_-?[0-9]+$"
rate string erforderlich
label string erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

title string erforderlich
plan_version integer erforderlich
design string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^design_[a-f0-9]{12}_-?[0-9]+$"
transaction string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^transaction_[a-f0-9]{12}_-?[0-9]+$"
invoice string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
invoice_number string | null erforderlich
payment string | null erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern
"^pay_[a-f0-9]{12}_-?[0-9]+$"
reminder_due_at integer | null erforderlich
renewal_due_at integer | null erforderlich
created_at integer erforderlich
updated_at integer erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "membership": {
                "type": "string",
                "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "type": {
                "type": "string"
              },
              "period_start": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "period_end": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "payment_status": {
                "type": "string"
              },
              "amounts": {
                "type": "object",
                "properties": {
                  "gross": {
                    "type": "string",
                    "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                    "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                  },
                  "net": {
                    "type": "string",
                    "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                    "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                  },
                  "tax": {
                    "type": "string",
                    "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                    "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                  },
                  "currency": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "gross",
                  "net",
                  "tax",
                  "currency"
                ]
              },
              "vat": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "rate": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "rate",
                  "label"
                ]
              },
              "title": {
                "type": "string"
              },
              "plan_version": {
                "type": "integer"
              },
              "design": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "transaction": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "invoice": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "invoice_number": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "payment": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "reminder_due_at": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "renewal_due_at": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "created_at": {
                "type": "integer"
              },
              "updated_at": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id",
              "membership",
              "type",
              "period_start",
              "period_end",
              "payment_status",
              "amounts",
              "vat",
              "title",
              "plan_version",
              "design",
              "transaction",
              "invoice",
              "invoice_number",
              "payment",
              "reminder_due_at",
              "renewal_due_at",
              "created_at",
              "updated_at"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "membership": {
              "type": "string",
              "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "type": {
              "type": "string"
            },
            "period_start": {
              "type": [
                "integer",
                "null"
              ]
            },
            "period_end": {
              "type": [
                "integer",
                "null"
              ]
            },
            "payment_status": {
              "type": "string"
            },
            "amounts": {
              "type": "object",
              "properties": {
                "gross": {
                  "type": "string",
                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                },
                "net": {
                  "type": "string",
                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                },
                "tax": {
                  "type": "string",
                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                },
                "currency": {
                  "type": "string"
                }
              },
              "additionalProperties": true,
              "required": [
                "gross",
                "net",
                "tax",
                "currency"
              ]
            },
            "vat": {
              "type": "object",
              "properties": {
                "id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                },
                "rate": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "additionalProperties": true,
              "required": [
                "id",
                "rate",
                "label"
              ]
            },
            "title": {
              "type": "string"
            },
            "plan_version": {
              "type": "integer"
            },
            "design": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "transaction": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "invoice": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "invoice_number": {
              "type": [
                "string",
                "null"
              ]
            },
            "payment": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "reminder_due_at": {
              "type": [
                "integer",
                "null"
              ]
            },
            "renewal_due_at": {
              "type": [
                "integer",
                "null"
              ]
            },
            "created_at": {
              "type": "integer"
            },
            "updated_at": {
              "type": "integer"
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "membership",
            "type",
            "period_start",
            "period_end",
            "payment_status",
            "amounts",
            "vat",
            "title",
            "plan_version",
            "design",
            "transaction",
            "invoice",
            "invoice_number",
            "payment",
            "reminder_due_at",
            "renewal_due_at",
            "created_at",
            "updated_at"
          ]
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": [
    {
      "id": "membershipperiod_012345abcdef_123456",
      "membership": "usermembership_012345abcdef_123456",
      "type": "initial",
      "period_start": 1790000000,
      "period_end": 1821536000,
      "payment_status": "free",
      "amounts": {
        "gross": "0.00",
        "net": "0.00",
        "tax": "0.00",
        "currency": "CHF"
      },
      "vat": {
        "id": null,
        "rate": "0.0000",
        "label": ""
      },
      "title": "Jahresmitgliedschaft",
      "plan_version": 1,
      "design": null,
      "transaction": null,
      "invoice": null,
      "invoice_number": null,
      "payment": null,
      "reminder_due_at": 1818944000,
      "renewal_due_at": 1821536000,
      "created_at": 1790000000,
      "updated_at": 1790000000
    }
  ]
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Membershipperiod.php:17getMembershipperiod()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state
true
x-edoobox-runtimeMutationGuard
true
x-edoobox-get-effect
"business-mutation"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/01-membership.json",
  "notes": []
}
x-edoobox-parameterAlternatives
[
  {
    "query": [
      "membership"
    ]
  },
  {
    "query": [
      "id"
    ]
  },
  {
    "query": [
      "filter"
    ],
    "containsProperty": [
      "membership",
      "id"
    ]
  }
]
x-edoobox-source
{
  "file": "application/models/v2/Membershipperiod.php",
  "method": "getMembershipperiod",
  "line": 17
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "membershipperiod",
  "short": "mepe",
  "checkedByDispatcher": true,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
Vollständige Operation als JSON
{
  "operationId": "get_v2_membershipperiod",
  "summary": "Abrechnungsperioden einer Mitgliedschaft lesen",
  "description": "Liest Abrechnungsperioden genau einer Mitgliedschaft. Ohne id muss membership direkt als Query oder als filter-Eintrag vorhanden sein; fehlt beides, folgt membership_filter_required. Ein id-Selector liest stattdessen einen Einzelbeleg.  Vor der Rückgabe werden verpasste Zahlungsrückmeldungen abgeglichen. Das kann Perioden/Zahlungsreferenzen, Mitgliedschaftsstatus, Gültigkeit, Nutzungsbestand, Audit und Outbox dauerhaft ändern. Sortierung: period_start absteigend, danach Beleg-ID; total ist die Gesamtzahl vor Pagination.",
  "tags": [
    "membershipperiod"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-Filter: id wählt einen Einzelbeleg; membership wählt die zugehörige Mitgliedschaft. Mindestens eine dieser Auswahlen ist erforderlich. Andere Eigenschaften und expression werden ignoriert.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {},
                "expression": {
                  "type": "string",
                  "description": "Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value."
                }
              },
              "additionalProperties": true,
              "required": [
                "property",
                "value"
              ]
            }
          },
          "example": [
            {
              "property": "membership",
              "value": "usermembership_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-Objekt mit start (Offset) und reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; negative Offsets auf 0 gesetzt.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "start": {
                    "type": "integer",
                    "minimum": 0,
                    "default": 0
                  },
                  "reply": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 500,
                    "default": 100
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 500
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
        "examples": [
          "membershipperiod_012345abcdef_123456"
        ]
      },
      "description": "Einzelobjekt über id auswählen; alternativ gleichnamiger Eintrag im JSON-filter."
    },
    {
      "name": "membership",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
      },
      "description": "Pflichtauswahl für die Liste: Mitgliedschaft im aktuellen Konto; alternativ filter mit property=membership."
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data ist bei membership-Auswahl eine JSON-Liste (auch leer), bei id-Auswahl ein einzelnes Objekt. error=false und success=true. Zusätzlich total vor Pagination.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": [
              {
                "id": "membershipperiod_012345abcdef_123456",
                "membership": "usermembership_012345abcdef_123456",
                "type": "initial",
                "period_start": 1790000000,
                "period_end": 1821536000,
                "payment_status": "free",
                "amounts": {
                  "gross": "0.00",
                  "net": "0.00",
                  "tax": "0.00",
                  "currency": "CHF"
                },
                "vat": {
                  "id": null,
                  "rate": "0.0000",
                  "label": ""
                },
                "title": "Jahresmitgliedschaft",
                "plan_version": 1,
                "design": null,
                "transaction": null,
                "invoice": null,
                "invoice_number": null,
                "payment": null,
                "reminder_due_at": 1818944000,
                "renewal_due_at": 1821536000,
                "created_at": 1790000000,
                "updated_at": 1790000000
              }
            ]
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "oneOf": [
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "membership": {
                          "type": "string",
                          "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "type": {
                          "type": "string"
                        },
                        "period_start": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "period_end": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "payment_status": {
                          "type": "string"
                        },
                        "amounts": {
                          "type": "object",
                          "properties": {
                            "gross": {
                              "type": "string",
                              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                            },
                            "net": {
                              "type": "string",
                              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                            },
                            "tax": {
                              "type": "string",
                              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                            },
                            "currency": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "gross",
                            "net",
                            "tax",
                            "currency"
                          ]
                        },
                        "vat": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "rate": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "id",
                            "rate",
                            "label"
                          ]
                        },
                        "title": {
                          "type": "string"
                        },
                        "plan_version": {
                          "type": "integer"
                        },
                        "design": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "transaction": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "invoice": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "invoice_number": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "payment": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "reminder_due_at": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "renewal_due_at": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "created_at": {
                          "type": "integer"
                        },
                        "updated_at": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id",
                        "membership",
                        "type",
                        "period_start",
                        "period_end",
                        "payment_status",
                        "amounts",
                        "vat",
                        "title",
                        "plan_version",
                        "design",
                        "transaction",
                        "invoice",
                        "invoice_number",
                        "payment",
                        "reminder_due_at",
                        "renewal_due_at",
                        "created_at",
                        "updated_at"
                      ]
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "membership": {
                        "type": "string",
                        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "type": {
                        "type": "string"
                      },
                      "period_start": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "period_end": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "payment_status": {
                        "type": "string"
                      },
                      "amounts": {
                        "type": "object",
                        "properties": {
                          "gross": {
                            "type": "string",
                            "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                            "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                          },
                          "net": {
                            "type": "string",
                            "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                            "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                          },
                          "tax": {
                            "type": "string",
                            "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                            "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                          },
                          "currency": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "gross",
                          "net",
                          "tax",
                          "currency"
                        ]
                      },
                      "vat": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                          },
                          "rate": {
                            "type": "string"
                          },
                          "label": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "id",
                          "rate",
                          "label"
                        ]
                      },
                      "title": {
                        "type": "string"
                      },
                      "plan_version": {
                        "type": "integer"
                      },
                      "design": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "transaction": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "invoice": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "invoice_number": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "payment": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "reminder_due_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "renewal_due_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "created_at": {
                        "type": "integer"
                      },
                      "updated_at": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "membership",
                      "type",
                      "period_start",
                      "period_end",
                      "payment_status",
                      "amounts",
                      "vat",
                      "title",
                      "plan_version",
                      "design",
                      "transaction",
                      "invoice",
                      "invoice_number",
                      "payment",
                      "reminder_due_at",
                      "renewal_due_at",
                      "created_at",
                      "updated_at"
                    ]
                  }
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-parameterAlternatives": [
    {
      "query": [
        "membership"
      ]
    },
    {
      "query": [
        "id"
      ]
    },
    {
      "query": [
        "filter"
      ],
      "containsProperty": [
        "membership",
        "id"
      ]
    }
  ],
  "x-edoobox-source": {
    "file": "application/models/v2/Membershipperiod.php",
    "method": "getMembershipperiod",
    "line": 17
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "membershipperiod",
    "short": "mepe",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}