Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
bookingAPI-Referenz
GET/v2/booking/{id}/invoice_address_suggestions

Frühere Rechnungsadressen vorschlagen

Ermittelt höchstens vier unterschiedliche aktive Rechnungsadressen aus früheren Buchungen des Buchungsinhabers. Die aktuelle Buchung wird ausgeschlossen. Jeder Vorschlag enthält data0 bis data8, active und b2b, einen abgeleiteten 16-stelligen id-Fingerprint sowie bookings mit öffentlichen Buchungs-IDs und Buchungsnummern der zugehörigen früheren Buchungen.

Operation-ID get_v2_booking_id_invoice_address_suggestions

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

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
"booking_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": [
    "booking_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"
  ]
}
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

Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.

application/json

object
success boolean
error boolean | string
error_code string
data object
suggestions array
maxItems
4
Array-Elemente
object
data0 string
data1 string
data2 string
data3 string
data4 string
data5 string
data6 Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string
pattern
"^country_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"country_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

data7 string
data8 string
active boolean
b2b boolean
id string

Abgeleiteter Adress-Fingerprint, keine Datenbank-ID.

pattern
"^[a-f0-9]{16}$"
bookings array
Array-Elemente
object
id string
pattern
"^booking_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"booking_012345abcdef_123456"
number string

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

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

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": {
        "suggestions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "data0": {
                "type": "string"
              },
              "data1": {
                "type": "string"
              },
              "data2": {
                "type": "string"
              },
              "data3": {
                "type": "string"
              },
              "data4": {
                "type": "string"
              },
              "data5": {
                "type": "string"
              },
              "data6": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "country_012345abcdef_123456"
                    ]
                  },
                  {
                    "const": false
                  }
                ]
              },
              "data7": {
                "type": "string"
              },
              "data8": {
                "type": "string"
              },
              "active": {
                "type": "boolean"
              },
              "b2b": {
                "type": "boolean"
              },
              "id": {
                "type": "string",
                "pattern": "^[a-f0-9]{16}$",
                "description": "Abgeleiteter Adress-Fingerprint, keine Datenbank-ID."
              },
              "bookings": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "booking_012345abcdef_123456"
                      ]
                    },
                    "number": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                }
              }
            },
            "additionalProperties": true
          },
          "maxItems": 4
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "suggestions": [
      {
        "active": true,
        "b2b": false,
        "data0": "",
        "data1": "Beispiel AG",
        "data2": "Alex Beispiel",
        "data3": "Musterstrasse 1",
        "data4": "8000 Zürich",
        "data5": "rechnung@example.invalid",
        "data6": "country_012345abcdef_123456",
        "data7": "",
        "data8": "",
        "id": "012345abcdef6789",
        "bookings": [
          {
            "id": "booking_012345abcdef_123457",
            "number": "2026-0999"
          }
        ]
      }
    ]
  }
}
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/Booking.php:556getBooking()

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-get-effect
"read"
x-edoobox-get-permission-review
{
  "file": "docs/openapi/reviews/vue-get-permission-01.json",
  "pointer": "/operations/12",
  "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Booking.php",
    "line": 790,
    "lineEnd": 865,
    "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5",
    "reason": "Decodes current booking, queries account-scoped account/booking owner and delegates to invoice address suggestions."
  },
  "reason": "Suggests invoice addresses already recorded for the booking owner/account.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-01.json",
    "pointer": "/operations/12",
    "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  }
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Booking.php",
  "method": "getBooking",
  "line": 556,
  "branch": {
    "file": "application/models/v2/Booking.php",
    "line": 790
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "booking",
  "short": "book",
  "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_booking_id_invoice_address_suggestions",
  "summary": "Frühere Rechnungsadressen vorschlagen",
  "description": "Ermittelt höchstens vier unterschiedliche aktive Rechnungsadressen aus früheren Buchungen des Buchungsinhabers. Die aktuelle Buchung wird ausgeschlossen. Jeder Vorschlag enthält data0 bis data8, active und b2b, einen abgeleiteten 16-stelligen id-Fingerprint sowie bookings mit öffentlichen Buchungs-IDs und Buchungsnummern der zugehörigen früheren Buchungen.",
  "tags": [
    "booking"
  ],
  "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": [
          "booking_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "suggestions": [
                {
                  "active": true,
                  "b2b": false,
                  "data0": "",
                  "data1": "Beispiel AG",
                  "data2": "Alex Beispiel",
                  "data3": "Musterstrasse 1",
                  "data4": "8000 Zürich",
                  "data5": "rechnung@example.invalid",
                  "data6": "country_012345abcdef_123456",
                  "data7": "",
                  "data8": "",
                  "id": "012345abcdef6789",
                  "bookings": [
                    {
                      "id": "booking_012345abcdef_123457",
                      "number": "2026-0999"
                    }
                  ]
                }
              ]
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "suggestions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "data0": {
                          "type": "string"
                        },
                        "data1": {
                          "type": "string"
                        },
                        "data2": {
                          "type": "string"
                        },
                        "data3": {
                          "type": "string"
                        },
                        "data4": {
                          "type": "string"
                        },
                        "data5": {
                          "type": "string"
                        },
                        "data6": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "country_012345abcdef_123456"
                              ]
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "data7": {
                          "type": "string"
                        },
                        "data8": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "b2b": {
                          "type": "boolean"
                        },
                        "id": {
                          "type": "string",
                          "pattern": "^[a-f0-9]{16}$",
                          "description": "Abgeleiteter Adress-Fingerprint, keine Datenbank-ID."
                        },
                        "bookings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                                "examples": [
                                  "booking_012345abcdef_123456"
                                ]
                              },
                              "number": {
                                "type": "string"
                              }
                            },
                            "additionalProperties": true
                          }
                        }
                      },
                      "additionalProperties": true
                    },
                    "maxItems": 4
                  }
                },
                "additionalProperties": true
              },
              "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-get-effect": "read",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-01.json",
    "pointer": "/operations/12",
    "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Booking.php",
      "line": 790,
      "lineEnd": 865,
      "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5",
      "reason": "Decodes current booking, queries account-scoped account/booking owner and delegates to invoice address suggestions."
    },
    "reason": "Suggests invoice addresses already recorded for the booking owner/account.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-01.json",
      "pointer": "/operations/12",
      "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Booking.php",
    "method": "getBooking",
    "line": 556,
    "branch": {
      "file": "application/models/v2/Booking.php",
      "line": 790
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "booking",
    "short": "book",
    "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."
  }
}