dunningAPI-Referenz

POST/v2/dunning/run

Fällige Mahnungen ausführen

Prüft fällige Rechnungen und Buchungen ohne Rechnung anhand aktiver Regeln. Im normalen Lauf entstehen Mahnvorgänge, gegebenenfalls Mahngebühren, Nachrichten oder Buchungsstornierungen. dry_run=true berechnet Kandidaten ohne diese Folgeaktionen; Standardkonfiguration kann trotzdem angelegt werden. limit wird bei <=0 auf 50 und maximal auf 250 normalisiert. Ein deaktiviertes Mahnwesen verarbeitet nichts.

Operation-ID post_v2_dunning_run

Vertrag & Verhalten

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

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.

Ressource: dunning · dunn
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

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"
  ]
}

Request Body

optional

`application/json`

object

data object

dry_run Typ nicht eingeschränkt

Direkter PHP-Bool-Cast; JSON true/false verwenden. Nichtleere Zeichenfolgen wie "false" sind wahr.

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

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "boolean"
}

limit Typ nicht eingeschränkt

Direkter Integer-Cast; Standard 50, maximal 250, <=0 verwendet 50.

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

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "integer"
}

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "dry_run": {
          "description": "Direkter PHP-Bool-Cast; JSON true/false verwenden. Nichtleere Zeichenfolgen wie \"false\" sind wahr.",
          "x-edoobox-canonicalType": "boolean"
        },
        "limit": {
          "description": "Direkter Integer-Cast; Standard 50, maximal 250, <=0 verwendet 50.",
          "x-edoobox-canonicalType": "integer"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Fällige Mahnungen ausführen

{
  "data": {
    "dry_run": true,
    "limit": 25
  }
}

Antworten

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

200application/json

Ausführungszeit, Aktivierung, created/processed und erzeugte oder simulierte entries. created zählt im dry_run die Kandidaten.

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

enabled boolean

run_at integer

created integer

processed integer

entries array

Array-Elemente

Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

id string

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

pattern: "^dunningentry_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"dunningentry_012345abcdef_123456"

context string

rule Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

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

pattern: "^dunningrule_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"dunningrule_012345abcdef_123456"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

leading_booking Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

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

pattern: "^booking_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"booking_012345abcdef_123456"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

invoice Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

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

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

Schema-Beispiel

"invoice_012345abcdef_123456"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

invoice_number string

fee Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

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

pattern: "^fee_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"fee_012345abcdef_123456"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

level integer

action string

delivery string

status string

amount_open number

payment_open boolean

fee_amount number

currency string

reference string

bookings array

Array-Elemente

object

id string

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

pattern: "^booking_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"booking_012345abcdef_123456"

number string

name string

leading boolean

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

created_at integer

processed_at integer

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

Variante 2 object

dry_run boolean

context string

rule object

id string

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

pattern: "^dunningrule_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"dunningrule_012345abcdef_123456"

context string

Erlaubte Werte

"invoice""booking_without_invoice"

days_without_payment integer

name string

name_translations object

Schema für zusätzliche Felder

string

action string

Erlaubte Werte

"reminder""dunning""cancellation"

fee_amount number

level integer

delivery string

email_template integer

post_template integer

active boolean

status integer

sort_order integer

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

reference string

bookings array

Array-Elemente

string

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

pattern: "^booking_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"booking_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": {
        "enabled": {
          "type": "boolean"
        },
        "run_at": {
          "type": "integer"
        },
        "created": {
          "type": "integer"
        },
        "processed": {
          "type": "integer"
        },
        "entries": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^dunningentry_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                    "examples": [
                      "dunningentry_012345abcdef_123456"
                    ]
                  },
                  "context": {
                    "type": "string"
                  },
                  "rule": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^dunningrule_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "dunningrule_012345abcdef_123456"
                        ]
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "leading_booking": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "booking_012345abcdef_123456"
                        ]
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "invoice": {
                    "anyOf": [
                      {
                        "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"
                        ]
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "invoice_number": {
                    "type": "string"
                  },
                  "fee": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^fee_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "fee_012345abcdef_123456"
                        ]
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "level": {
                    "type": "integer"
                  },
                  "action": {
                    "type": "string"
                  },
                  "delivery": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "amount_open": {
                    "type": "number"
                  },
                  "payment_open": {
                    "type": "boolean"
                  },
                  "fee_amount": {
                    "type": "number"
                  },
                  "currency": {
                    "type": "string"
                  },
                  "reference": {
                    "type": "string"
                  },
                  "bookings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                          "examples": [
                            "booking_012345abcdef_123456"
                          ]
                        },
                        "number": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "leading": {
                          "type": "boolean"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "processed_at": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "dry_run": {
                    "type": "boolean"
                  },
                  "context": {
                    "type": "string"
                  },
                  "rule": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^dunningrule_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "dunningrule_012345abcdef_123456"
                        ]
                      },
                      "context": {
                        "type": "string",
                        "enum": [
                          "invoice",
                          "booking_without_invoice"
                        ]
                      },
                      "days_without_payment": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      },
                      "name_translations": {
                        "type": "object",
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      "action": {
                        "type": "string",
                        "enum": [
                          "reminder",
                          "dunning",
                          "cancellation"
                        ]
                      },
                      "fee_amount": {
                        "type": "number"
                      },
                      "level": {
                        "type": "integer"
                      },
                      "delivery": {
                        "type": "string"
                      },
                      "email_template": {
                        "type": "integer"
                      },
                      "post_template": {
                        "type": "integer"
                      },
                      "active": {
                        "type": "boolean"
                      },
                      "status": {
                        "type": "integer"
                      },
                      "sort_order": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true
                  },
                  "reference": {
                    "type": "string"
                  },
                  "bookings": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                      "examples": [
                        "booking_012345abcdef_123456"
                      ]
                    }
                  }
                },
                "additionalProperties": true
              }
            ]
          }
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "enabled": true,
    "run_at": 1792051200,
    "created": 0,
    "processed": 0,
    "entries": []
  }
}

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

`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"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Dunning.php:66postDunning()

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/Dunning.php",
  "method": "postDunning",
  "line": 66
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "dunning",
  "short": "dunn",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_dunning_run",
  "summary": "Fällige Mahnungen ausführen",
  "description": "Prüft fällige Rechnungen und Buchungen ohne Rechnung anhand aktiver Regeln. Im normalen Lauf entstehen Mahnvorgänge, gegebenenfalls Mahngebühren, Nachrichten oder Buchungsstornierungen. dry_run=true berechnet Kandidaten ohne diese Folgeaktionen; Standardkonfiguration kann trotzdem angelegt werden. limit wird bei <=0 auf 50 und maximal auf 250 normalisiert. Ein deaktiviertes Mahnwesen verarbeitet nichts.",
  "tags": [
    "dunning"
  ],
  "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": "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": "Ausführungszeit, Aktivierung, created/processed und erzeugte oder simulierte entries. created zählt im dry_run die Kandidaten.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "enabled": true,
              "run_at": 1792051200,
              "created": 0,
              "processed": 0,
              "entries": []
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "run_at": {
                    "type": "integer"
                  },
                  "created": {
                    "type": "integer"
                  },
                  "processed": {
                    "type": "integer"
                  },
                  "entries": {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "pattern": "^dunningentry_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                              "examples": [
                                "dunningentry_012345abcdef_123456"
                              ]
                            },
                            "context": {
                              "type": "string"
                            },
                            "rule": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "pattern": "^dunningrule_[a-f0-9]{12}_-?[0-9]+$",
                                  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                  "examples": [
                                    "dunningrule_012345abcdef_123456"
                                  ]
                                },
                                {
                                  "const": false
                                }
                              ]
                            },
                            "leading_booking": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                                  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                  "examples": [
                                    "booking_012345abcdef_123456"
                                  ]
                                },
                                {
                                  "const": false
                                }
                              ]
                            },
                            "invoice": {
                              "anyOf": [
                                {
                                  "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"
                                  ]
                                },
                                {
                                  "const": false
                                }
                              ]
                            },
                            "invoice_number": {
                              "type": "string"
                            },
                            "fee": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "pattern": "^fee_[a-f0-9]{12}_-?[0-9]+$",
                                  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                  "examples": [
                                    "fee_012345abcdef_123456"
                                  ]
                                },
                                {
                                  "const": false
                                }
                              ]
                            },
                            "level": {
                              "type": "integer"
                            },
                            "action": {
                              "type": "string"
                            },
                            "delivery": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string"
                            },
                            "amount_open": {
                              "type": "number"
                            },
                            "payment_open": {
                              "type": "boolean"
                            },
                            "fee_amount": {
                              "type": "number"
                            },
                            "currency": {
                              "type": "string"
                            },
                            "reference": {
                              "type": "string"
                            },
                            "bookings": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                                    "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                    "examples": [
                                      "booking_012345abcdef_123456"
                                    ]
                                  },
                                  "number": {
                                    "type": "string"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "leading": {
                                    "type": "boolean"
                                  }
                                },
                                "additionalProperties": true
                              }
                            },
                            "created_at": {
                              "type": "integer"
                            },
                            "processed_at": {
                              "type": "integer"
                            }
                          },
                          "additionalProperties": true
                        },
                        {
                          "type": "object",
                          "properties": {
                            "dry_run": {
                              "type": "boolean"
                            },
                            "context": {
                              "type": "string"
                            },
                            "rule": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "pattern": "^dunningrule_[a-f0-9]{12}_-?[0-9]+$",
                                  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                  "examples": [
                                    "dunningrule_012345abcdef_123456"
                                  ]
                                },
                                "context": {
                                  "type": "string",
                                  "enum": [
                                    "invoice",
                                    "booking_without_invoice"
                                  ]
                                },
                                "days_without_payment": {
                                  "type": "integer"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "name_translations": {
                                  "type": "object",
                                  "additionalProperties": {
                                    "type": "string"
                                  }
                                },
                                "action": {
                                  "type": "string",
                                  "enum": [
                                    "reminder",
                                    "dunning",
                                    "cancellation"
                                  ]
                                },
                                "fee_amount": {
                                  "type": "number"
                                },
                                "level": {
                                  "type": "integer"
                                },
                                "delivery": {
                                  "type": "string"
                                },
                                "email_template": {
                                  "type": "integer"
                                },
                                "post_template": {
                                  "type": "integer"
                                },
                                "active": {
                                  "type": "boolean"
                                },
                                "status": {
                                  "type": "integer"
                                },
                                "sort_order": {
                                  "type": "integer"
                                }
                              },
                              "additionalProperties": true
                            },
                            "reference": {
                              "type": "string"
                            },
                            "bookings": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                                "examples": [
                                  "booking_012345abcdef_123456"
                                ]
                              }
                            }
                          },
                          "additionalProperties": true
                        }
                      ]
                    }
                  }
                },
                "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": false,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "dry_run": {
                  "description": "Direkter PHP-Bool-Cast; JSON true/false verwenden. Nichtleere Zeichenfolgen wie \"false\" sind wahr.",
                  "x-edoobox-canonicalType": "boolean"
                },
                "limit": {
                  "description": "Direkter Integer-Cast; Standard 50, maximal 250, <=0 verwendet 50.",
                  "x-edoobox-canonicalType": "integer"
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "examples": {
          "request": {
            "summary": "Fällige Mahnungen ausführen",
            "value": {
              "data": {
                "dry_run": true,
                "limit": 25
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/04-accounting.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Dunning.php",
    "method": "postDunning",
    "line": 66
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "dunning",
    "short": "dunn",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "dry_run": true,
    "limit": 25
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/dunning/run' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/dunning/run";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "dry_run": true,
    "limit": 25
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/dunning/run"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"dry_run\":true,\"limit\":25}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/dunning/run";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "dry_run": true,
    "limit": 25
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/dunning/run"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"dry_run\":true,\"limit\":25}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.