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

Zusatzleistung auflisten

Liest Zusatzleistung-Datensätze des gewählten Kontos. fields, filter, order und limit steuern die Auswahl. Einzelabfragen bleiben Sammlungen; response_type=array liefert eine Liste, sonst wird nach öffentlicher ID indiziert. Leere Ergebnisse sind []. Die übergeordnete Gruppe muss zur passenden Art gehören und darf nicht gelöscht sein.

Operation-ID get_v2_deliverables

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

Authentifizierung

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

Alternative 1

bearerAuthhttp · 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

fieldsoptional

JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  "id"
]
Array-Elemente
string
Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "examples": [
    [
      "id"
    ]
  ]
}
Beispiel
[
  "id"
]
filteroptional

JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "deliverables_012345abcdef_123456"
  }
]
Array-Elemente
object
property string
expression string
value Typ nicht eingeschränkt

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "expression": {
        "type": "string"
      },
      "value": {}
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "expression": "=",
        "value": "deliverables_012345abcdef_123456"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "deliverables_012345abcdef_123456"
  }
]
limitoptional

JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

object
Schema-Beispiel
{
  "start": 0,
  "reply": 25
}
start integer
minimum
0

Standardwert: 0

reply integer
maximum
2000

Standardwert: 100

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "start": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "reply": {
      "type": "integer",
      "maximum": 2000,
      "default": 100
    }
  },
  "examples": [
    {
      "start": 0,
      "reply": 25
    }
  ]
}
Beispiel
{
  "start": 0,
  "reply": 25
}
orderoptional

JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
Array-Elemente
object
property string
value string
Erlaubte Werte
"ASC""DESC"

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ]
      }
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "value": "ASC"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
response_typeoptional

Controls generic collection representation; default is an ID-keyed object.

string
Erlaubte Werte
"array""object"
Schema-Beispiel
"array"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "array",
    "object"
  ],
  "examples": [
    "array"
  ]
}

Header

languageoptional

Account language code, where the resource supports setLanguage().

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

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

data ist eine Sammlung; limit.start/reply/total enthält Paginierung und Trefferzahl.

application/json

object
success boolean
error boolean | string
error_code string
data Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 object
Schema für zusätzliche Felder
object
id string erforderlich

Öffentliche v2-ID; Beispiel ist synthetisch.

pattern
"^deliverables_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"deliverables_012345abcdef_123456"
status boolean
deliverablesgroup string

Öffentliche v2-ID; Beispiel ist synthetisch.

pattern
"^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"deliverablesgroup_012345abcdef_123456"
name string
description string
settlement string
Erlaubte Werte
"add""subtract"
amount number
order integer

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

Variante 2 array
Array-Elemente
object
id string erforderlich

Öffentliche v2-ID; Beispiel ist synthetisch.

pattern
"^deliverables_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"deliverables_012345abcdef_123456"
status boolean
deliverablesgroup string

Öffentliche v2-ID; Beispiel ist synthetisch.

pattern
"^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"deliverablesgroup_012345abcdef_123456"
name string
description string
settlement string
Erlaubte Werte
"add""subtract"
amount number
order integer

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": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^deliverables_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                "examples": [
                  "deliverables_012345abcdef_123456"
                ]
              },
              "status": {
                "type": "boolean"
              },
              "deliverablesgroup": {
                "type": "string",
                "pattern": "^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                "examples": [
                  "deliverablesgroup_012345abcdef_123456"
                ]
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "settlement": {
                "type": "string",
                "enum": [
                  "add",
                  "subtract"
                ]
              },
              "amount": {
                "type": "number"
              },
              "order": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id"
            ]
          }
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^deliverables_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                "examples": [
                  "deliverables_012345abcdef_123456"
                ]
              },
              "status": {
                "type": "boolean"
              },
              "deliverablesgroup": {
                "type": "string",
                "pattern": "^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                "examples": [
                  "deliverablesgroup_012345abcdef_123456"
                ]
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "settlement": {
                "type": "string",
                "enum": [
                  "add",
                  "subtract"
                ]
              },
              "amount": {
                "type": "number"
              },
              "order": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id"
            ]
          }
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "deliverables_012345abcdef_123456": {
      "id": "deliverables_012345abcdef_123456"
    }
  },
  "limit": {
    "start": 0,
    "reply": 100,
    "total": 1
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

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

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

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

application/json

Typ nicht eingeschränkt

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

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

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

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

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

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

application/json

Typ nicht eingeschränkt

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

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

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

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

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

Validation failed.

application/json

Typ nicht eingeschränkt

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

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

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

Response Header

Retry-After

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

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

application/json

Typ nicht eingeschränkt

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

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

Server-side operation failed.

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED50201"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Deliverables.php:230getDeliverables()

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
false
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/10-other-resources.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Deliverables.php",
  "method": "getDeliverables",
  "line": 230
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "deliverables",
  "short": "dela",
  "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_deliverables",
  "summary": "Zusatzleistung auflisten",
  "description": "Liest Zusatzleistung-Datensätze des gewählten Kontos. fields, filter, order und limit steuern die Auswahl. Einzelabfragen bleiben Sammlungen; response_type=array liefert eine Liste, sonst wird nach öffentlicher ID indiziert. Leere Ergebnisse sind []. Die übergeordnete Gruppe muss zur passenden Art gehören und darf nicht gelöscht sein.",
  "tags": [
    "deliverables"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "fields",
      "in": "query",
      "required": false,
      "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "id"
              ]
            ]
          },
          "example": [
            "id"
          ]
        }
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "expression": {
                  "type": "string"
                },
                "value": {}
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "expression": "=",
                  "value": "deliverables_012345abcdef_123456"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "expression": "=",
              "value": "deliverables_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "start": {
                "type": "integer",
                "minimum": 0,
                "default": 0
              },
              "reply": {
                "type": "integer",
                "maximum": 2000,
                "default": 100
              }
            },
            "examples": [
              {
                "start": 0,
                "reply": 25
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "order",
      "in": "query",
      "required": false,
      "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "ASC",
                    "DESC"
                  ]
                }
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "value": "ASC"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "value": "ASC"
            }
          ]
        }
      }
    },
    {
      "name": "response_type",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "array",
          "object"
        ],
        "examples": [
          "array"
        ]
      },
      "description": "Controls generic collection representation; default is an ID-keyed object."
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "data ist eine Sammlung; limit.start/reply/total enthält Paginierung und Trefferzahl.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "deliverables_012345abcdef_123456": {
                "id": "deliverables_012345abcdef_123456"
              }
            },
            "limit": {
              "start": 0,
              "reply": 100,
              "total": 1
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^deliverables_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                          "examples": [
                            "deliverables_012345abcdef_123456"
                          ]
                        },
                        "status": {
                          "type": "boolean"
                        },
                        "deliverablesgroup": {
                          "type": "string",
                          "pattern": "^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                          "examples": [
                            "deliverablesgroup_012345abcdef_123456"
                          ]
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "settlement": {
                          "type": "string",
                          "enum": [
                            "add",
                            "subtract"
                          ]
                        },
                        "amount": {
                          "type": "number"
                        },
                        "order": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id"
                      ]
                    }
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^deliverables_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                          "examples": [
                            "deliverables_012345abcdef_123456"
                          ]
                        },
                        "status": {
                          "type": "boolean"
                        },
                        "deliverablesgroup": {
                          "type": "string",
                          "pattern": "^deliverablesgroup_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID; Beispiel ist synthetisch.",
                          "examples": [
                            "deliverablesgroup_012345abcdef_123456"
                          ]
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "settlement": {
                          "type": "string",
                          "enum": [
                            "add",
                            "subtract"
                          ]
                        },
                        "amount": {
                          "type": "number"
                        },
                        "order": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id"
                      ]
                    }
                  }
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/10-other-resources.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Deliverables.php",
    "method": "getDeliverables",
    "line": 230
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "deliverables",
    "short": "dela",
    "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."
  }
}