Rechnungen als Sammel-PDF exportieren

{
  "operationId": "get_v2_invoice_list_invoice_collective_pdf_export",
  "summary": "Rechnungen als Sammel-PDF exportieren",
  "description": "Erzeugt ein gemeinsames PDF aus bis zu 500 Rechnungen und Belegen im Erstellungszeitraum und überspringt extern geführte Rechnungen. storage=download liefert die Datei. securefilemanager erfordert zusätzliche settings-Schreibrechte und antwortet zunächst processing, während der Server die Datei erstellt und dort speichert. Ein noch laufender Export liefert existing_job_still_running. Der GET schreibt den Job-Cache und kann eine Datei im Konto anlegen.",
  "tags": [
    "invoice"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": true,
      "description": "Beginn des Erstellungszeitraums, mit strtotime parsebar.",
      "schema": {
        "type": "string",
        "description": "Mit PHP strtotime parsebarer Datumstext; kanonisch ISO 8601 mit Zeitzone.",
        "examples": [
          "2026-10-15T10:00:00+02:00"
        ]
      },
      "example": "2026-10-01T00:00:00+02:00"
    },
    {
      "name": "to",
      "in": "query",
      "required": true,
      "description": "Ende des Erstellungszeitraums; muss nach from liegen.",
      "schema": {
        "type": "string",
        "description": "Mit PHP strtotime parsebarer Datumstext; kanonisch ISO 8601 mit Zeitzone.",
        "examples": [
          "2026-10-15T10:00:00+02:00"
        ]
      },
      "example": "2026-10-31T23:59:59+01:00"
    },
    {
      "name": "storage",
      "in": "query",
      "required": true,
      "description": "Ziel des Exports.",
      "schema": {
        "type": "string",
        "enum": [
          "download",
          "securefilemanager"
        ]
      },
      "example": "download"
    },
    {
      "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": "PDF-Download, JSON status=processing bei Dateimanager-Ziel oder existing_job_still_running sowie JSON-Fehler.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "string",
                    "enum": [
                      "processing",
                      "existing_job_still_running"
                    ]
                  }
                },
                "additionalProperties": true
              }
            },
            "additionalProperties": true
          }
        },
        "application/pdf": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      },
      "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-mutationReview": {
    "source": {
      "file": "application/config/config.php",
      "line": 258,
      "reason": "APIPermissions resource mapping to invo.",
      "sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82"
    },
    "reason": "storage=download only renders a document; storage=securefilemanager persists a new account file and uploads it to private object storage, including asynchronous work after the response. The native helper now requires current settings PUT capability and a non-readonly context before that persistent branch.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-02.json",
      "pointer": "/operations/16",
      "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-02.json",
    "pointer": "/operations/16",
    "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-readonly-query": {
    "storage": "download"
  },
  "x-edoobox-conditionalAdditionalNativePermission": {
    "when": {
      "query": {
        "storage": {
          "const": "securefilemanager"
        }
      }
    },
    "short": "setti",
    "levels": [
      3,
      4
    ],
    "readOnlyAllowed": false,
    "source": {
      "file": "application/models/v2/Invoicefunc.php",
      "method": "_getCollectivePDFExport"
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/04-accounting.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Invoice.php",
    "method": "getInvoice",
    "line": 443,
    "branch": {
      "file": "application/models/v2/Invoice.php",
      "line": 718
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "invoice",
    "short": "invo",
    "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."
  }
}