Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
invoiceAPI-Referenz
PUT/v2/invoice/{id}

Fälligkeit einer Rechnung ändern

Aktualisiert das beschreibbare Feld date_payuntil einer eigenen Rechnung. Betrag, Währung, Teilnehmer, Rechnungsnummer und Zahlungsstatus werden über diesen allgemeinen Schreibweg nicht geändert; für Zahlung, Erstattung, Versand und Stornierung die benannten Aktionen verwenden. Beim Basisendpunkt ist äußeres id erforderlich.

Operation-ID put_v2_invoice_id

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein
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

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
  "examples": [
    "invoice_012345abcdef_123456"
  ]
}

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
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

erforderlich

application/json

object
data object erforderlich

Source-declared fields; action-specific and account validation still apply.

minProperties
1
id kein Wert zulässig
amount kein Wert zulässig
amount_pay kein Wert zulässig
currency kein Wert zulässig
number kein Wert zulässig
description kein Wert zulässig
user kein Wert zulässig
paytrans kein Wert zulässig
date_create kein Wert zulässig
date_payuntil Typ nicht eingeschränkt

dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel
"2026-10-15T10:00:00+02:00"
Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-sourceLine": 127
}
date_pay kein Wert zulässig
date_cancelled kein Wert zulässig
status kein Wert zulässig

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

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-readOnlyFields": [
    "amount",
    "amount_pay",
    "currency",
    "number",
    "description",
    "user",
    "paytrans",
    "date_create",
    "date_pay",
    "date_cancelled",
    "status"
  ],
  "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns."
}
id string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"

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

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": false,
        "amount": false,
        "amount_pay": false,
        "currency": false,
        "number": false,
        "description": false,
        "user": false,
        "paytrans": false,
        "date_create": false,
        "date_payuntil": {
          "x-edoobox-canonicalType": "string",
          "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
          "examples": [
            "2026-10-15T10:00:00+02:00"
          ],
          "x-edoobox-sourceLine": 127
        },
        "date_pay": false,
        "date_cancelled": false,
        "status": false
      },
      "additionalProperties": true,
      "description": "Source-declared fields; action-specific and account validation still apply.",
      "minProperties": 1,
      "x-edoobox-readOnlyFields": [
        "amount",
        "amount_pay",
        "currency",
        "number",
        "description",
        "user",
        "paytrans",
        "date_create",
        "date_pay",
        "date_cancelled",
        "status"
      ],
      "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns."
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
      "examples": [
        "invoice_012345abcdef_123456"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
Fälligkeit einer Rechnung ändern
{
  "data": {
    "date_payuntil": "2026-11-15T00:00:00+01:00"
  }
}
05

Antworten

11

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

200application/json

update und öffentliche Rechnungs-ID.

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 object
update boolean
id string

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

pattern
"^invoice_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"invoice_012345abcdef_123456"

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": {
      "type": "object",
      "properties": {
        "update": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
          "examples": [
            "invoice_012345abcdef_123456"
          ]
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "update": true,
    "id": "invoice_012345abcdef_123456"
  }
}
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/Invoice.php:245updateInvoice()

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-documentationReview
{
  "file": "docs/openapi/operation-contracts/04-accounting.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Invoice.php",
  "method": "updateInvoice",
  "line": 245
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "invoice",
  "short": "invo",
  "checkedByDispatcher": true,
  "levels": [
    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": "put_v2_invoice_id",
  "summary": "Fälligkeit einer Rechnung ändern",
  "description": "Aktualisiert das beschreibbare Feld date_payuntil einer eigenen Rechnung. Betrag, Währung, Teilnehmer, Rechnungsnummer und Zahlungsstatus werden über diesen allgemeinen Schreibweg nicht geändert; für Zahlung, Erstattung, Versand und Stornierung die benannten Aktionen verwenden. Beim Basisendpunkt ist äußeres id erforderlich.",
  "tags": [
    "invoice"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "v2 object identifier in the selected account.",
      "schema": {
        "type": "string",
        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
        "examples": [
          "invoice_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "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": "update und öffentliche Rechnungs-ID.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "update": true,
              "id": "invoice_012345abcdef_123456"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "update": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "string",
                    "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                    "examples": [
                      "invoice_012345abcdef_123456"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "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,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": false,
                "amount": false,
                "amount_pay": false,
                "currency": false,
                "number": false,
                "description": false,
                "user": false,
                "paytrans": false,
                "date_create": false,
                "date_payuntil": {
                  "x-edoobox-canonicalType": "string",
                  "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                  "examples": [
                    "2026-10-15T10:00:00+02:00"
                  ],
                  "x-edoobox-sourceLine": 127
                },
                "date_pay": false,
                "date_cancelled": false,
                "status": false
              },
              "additionalProperties": true,
              "description": "Source-declared fields; action-specific and account validation still apply.",
              "minProperties": 1,
              "x-edoobox-readOnlyFields": [
                "amount",
                "amount_pay",
                "currency",
                "number",
                "description",
                "user",
                "paytrans",
                "date_create",
                "date_pay",
                "date_cancelled",
                "status"
              ],
              "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns."
            },
            "id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "invoice_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Fälligkeit einer Rechnung ändern",
            "value": {
              "data": {
                "date_payuntil": "2026-11-15T00:00:00+01:00"
              }
            }
          }
        }
      }
    }
  },
  "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": "updateInvoice",
    "line": 245
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "invoice",
    "short": "invo",
    "checkedByDispatcher": true,
    "levels": [
      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."
  }
}