Document objects (8)
Zusatzdaten
BO4E-Dokumentobjekt · 10 Felder · 0 Verwendungen in Prüfis und Events · 210 namensgleiche Felder inline definiert
Fields
| Field | Type | Description | Defined inline |
|---|---|---|---|
prozessId | string | Id of the document / record in the backend. Is used to assign the response. (not from the time slice; source: api-definitionen/schema-eigen/backend-schreiben-lf.yaml) Identical wording in backend-schreiben-msb.yaml and backend-schreiben-nb.yaml, in the schemas "ZUSATZDATEN (create SST)" and "ZUSATZDATEN (update SST)" as zusatzdaten.prozessId (nullable, not required there). This is a field with the same name in a API schema, not a use of the cdoc object. In the MaloIdent responses 03002/03003 of the same file the text differs: "Reference Id of the request document / record in the backend. Can be used to assign the response." and the field is required. | 105 (inline) |
eventname | EventNameECS_LIEFERBEGINN, START_MALOIDENT, START_KUENDIGUNG START_LIEFERBEGINN, START_LIEFERENDE, START_VERSAND_SDAE, START_ABMELDEANFRAGE, START_AUFH_ZUK_ZUORDNUNG, START_ENDE_ZUORDNUNG, START_ABR_NN, START_ABR_BK, START_EINRICHTUNG_KONFIG, START_BERECHNUNGSFORMEL, START_WIEDERHERST_LB, START_EOG, START_ANFORDERUNG_MESSWERTE, START_BESTELLUNG_ABRECHNUNGSDATEN, START_ERHEBUNG_MESSWERTE, START_BESTELLUNG_SDAE, START_VERSAND_LIEFERSCHEIN, START_VERSAND_ANTWORT_NNA, START_ANFRAGE_KONFIGURATION, START_BESTELLUNG_KONFIGURATION, START_BESTELLUNG_ANGEBOT_KONFIGURATION, START_BESTELLUNG_ZAEHLZEITDEFINITION, START_VERSAND_BESTANDSLISTE, START_VERSAND_ANF_STORNO, START_VERSAND_BEST_BEEND_KONFIG, START_VERSAND_STORNO_MSCONS, START_BEGINN_MSB, START_ENDE_MSB, START_ENDE_MSB_STILLLEGUNG, START_KUENDIGUNG_MSB, START_GESCHAEFTSDATENANFRAGE, START_VERSAND_PREISBLATT_IMS, START_UEBERMITTLUNG_ENFG, START_PARTIN, START_GERAETEUEBERNAHME, START_ANGEBOT_GERAETEUEBERNAHME, START_BESTELLUNG_GERAETEUEBERNAHME, START_UEBERM_DEFINITION, START_UEBERSICHT_LEISTUNGSKURVENDEF, START_UEBERSICHT_SCHALTZEITDEF, START_UEBERSICHT_ZAEHLZEITDEF, START_REKLAMATION_DEFINITION, START_VERSAND_STATUSMELDUNG, START_GERAETEWECHSEL, START_ANTWORT_GERAETEWECHSEL, START_ANFORDERUNG_VON_WERTEN, START_REKLAMATION_VON_WERTEN, START_ABO_PROFILE | Identification of the event | 105 (inline) |
ediTyp | string | — | — |
ediEmpfangsDatum | string (date-time) | — | — |
ediVersion | string | — | — |
marktpartnerRolle | Enum MarktrolleNB, LF, MSB MSBA, GMSB, MDL, DL, BKV, UENB, KUNDE-SELBST-NN, MGV, EIV, RB, KUNDE, INTERESSENT, KN, UBA, BIKO, ESA | A market participant can take on these roles | — |
contrlReferenz | string | This field has no description and no usage. The time slice gives it no text, and it does not occur in the API specifications that this documentation reads. (not from the time slice; source: measurement on 05.09.2026 across site-d/apis/ (16 specifications), _apidog-export/ (322 files), api-definitionen/ (13 files) and the test inventory) 0 occurrences in all four inventories; in this repository only in the BO4E definition itself and in the bundle. Unlike parentBusinessKey, any English equivalent is missing as well. | — |
parentBusinessKey | string | This field has no verifiable meaning in the sources. It appears in the BO4E definition; no source read by this documentation states what it is supposed to carry. (not from the time slice; source: measurement on 05.09.2026 across site-d/apis/ (16 specifications), _apidog-export/ (322 files), api-definitionen/ (13 files) and the test corpus) 0 occurrences in all four corpora. The only occurrences in this repository are the BO4E definition itself (_sources/v<fv>/bo4e/cdoc/Zusatzdaten.yaml, the field atom and the bundle) and its English version. Invented meaning is expressly not given here. | — |
targetBusinessKey | string | Id of the initially referencing process. (not from the time slice; source: api-definitionen/schema-eigen/backend-schreiben-lf.yaml) Identical wording in backend-schreiben-msb.yaml and backend-schreiben-nb.yaml as zusatzdaten.targetBusinessKey; mandatory only in the schema „ZUSATZDATEN ( update SST)“. In the MaloIdent responses 03002/03003 the same field is called „BusinessKey of the initial process“ and is mandatory. These, too, are fields with the same name in API schemas, not a use of the cdoc object. | — |
ermaechtigungVorhanden | boolean | Response message of the SST Lesen_Zuordnungsermächtigung with information on whether an allocation authorization exists | — |
| Structure (BO4E) | Description | Format |
|---|---|---|
| prozessId | Id of the document / record in the backend. Is used to assign the response. (not from the time slice; source: api-definitionen/schema-eigen/backend-schreiben-lf.yaml) Identical wording in backend-schreiben-msb.yaml and backend-schreiben-nb.yaml, in the schemas "ZUSATZDATEN (create SST)" and "ZUSATZDATEN (update SST)" as zusatzdaten.prozessId (nullable, not required there). This is a field with the same name in a API schema, not a use of the cdoc object. In the MaloIdent responses 03002/03003 of the same file the text differs: "Reference Id of the request document / record in the backend. Can be used to assign the response." and the field is required. | string |
| eventname | Identification of the event | EventNameECS_LIEFERBEGINN, START_MALOIDENT, START_KUENDIGUNG START_LIEFERBEGINN, START_LIEFERENDE, START_VERSAND_SDAE, START_ABMELDEANFRAGE, START_AUFH_ZUK_ZUORDNUNG, START_ENDE_ZUORDNUNG, START_ABR_NN, START_ABR_BK, START_EINRICHTUNG_KONFIG, START_BERECHNUNGSFORMEL, START_WIEDERHERST_LB, START_EOG, START_ANFORDERUNG_MESSWERTE, START_BESTELLUNG_ABRECHNUNGSDATEN, START_ERHEBUNG_MESSWERTE, START_BESTELLUNG_SDAE, START_VERSAND_LIEFERSCHEIN, START_VERSAND_ANTWORT_NNA, START_ANFRAGE_KONFIGURATION, START_BESTELLUNG_KONFIGURATION, START_BESTELLUNG_ANGEBOT_KONFIGURATION, START_BESTELLUNG_ZAEHLZEITDEFINITION, START_VERSAND_BESTANDSLISTE, START_VERSAND_ANF_STORNO, START_VERSAND_BEST_BEEND_KONFIG, START_VERSAND_STORNO_MSCONS, START_BEGINN_MSB, START_ENDE_MSB, START_ENDE_MSB_STILLLEGUNG, START_KUENDIGUNG_MSB, START_GESCHAEFTSDATENANFRAGE, START_VERSAND_PREISBLATT_IMS, START_UEBERMITTLUNG_ENFG, START_PARTIN, START_GERAETEUEBERNAHME, START_ANGEBOT_GERAETEUEBERNAHME, START_BESTELLUNG_GERAETEUEBERNAHME, START_UEBERM_DEFINITION, START_UEBERSICHT_LEISTUNGSKURVENDEF, START_UEBERSICHT_SCHALTZEITDEF, START_UEBERSICHT_ZAEHLZEITDEF, START_REKLAMATION_DEFINITION, START_VERSAND_STATUSMELDUNG, START_GERAETEWECHSEL, START_ANTWORT_GERAETEWECHSEL, START_ANFORDERUNG_VON_WERTEN, START_REKLAMATION_VON_WERTEN, START_ABO_PROFILE |
| ediTyp | — | string |
| ediEmpfangsDatum | — | string (date-time) |
| ediVersion | — | string |
| marktpartnerRolle | A market participant can take on these roles | Enum MarktrolleNB, LF, MSB MSBA, GMSB, MDL, DL, BKV, UENB, KUNDE-SELBST-NN, MGV, EIV, RB, KUNDE, INTERESSENT, KN, UBA, BIKO, ESA |
| contrlReferenz | This field has no description and no usage. The time slice gives it no text, and it does not occur in the API specifications that this documentation reads. (not from the time slice; source: measurement on 05.09.2026 across site-d/apis/ (16 specifications), _apidog-export/ (322 files), api-definitionen/ (13 files) and the test inventory) 0 occurrences in all four inventories; in this repository only in the BO4E definition itself and in the bundle. Unlike parentBusinessKey, any English equivalent is missing as well. | string |
| parentBusinessKey | This field has no verifiable meaning in the sources. It appears in the BO4E definition; no source read by this documentation states what it is supposed to carry. (not from the time slice; source: measurement on 05.09.2026 across site-d/apis/ (16 specifications), _apidog-export/ (322 files), api-definitionen/ (13 files) and the test corpus) 0 occurrences in all four corpora. The only occurrences in this repository are the BO4E definition itself (_sources/v<fv>/bo4e/cdoc/Zusatzdaten.yaml, the field atom and the bundle) and its English version. Invented meaning is expressly not given here. | string |
| targetBusinessKey | Id of the initially referencing process. (not from the time slice; source: api-definitionen/schema-eigen/backend-schreiben-lf.yaml) Identical wording in backend-schreiben-msb.yaml and backend-schreiben-nb.yaml as zusatzdaten.targetBusinessKey; mandatory only in the schema „ZUSATZDATEN ( update SST)“. In the MaloIdent responses 03002/03003 the same field is called „BusinessKey of the initial process“ and is mandatory. These, too, are fields with the same name in API schemas, not a use of the cdoc object. | string |
| ermaechtigungVorhanden | Response message of the SST Lesen_Zuordnungsermächtigung with information on whether an allocation authorization exists | boolean |
Defined inline under the same name
prozessId
105 Quelle(n) definieren ein Feld prozessId inline.
eventname
105 Quelle(n) definieren ein Feld eventname inline.
Notes on this page
A * after a field name marks a mandatory field; the BO4E schema lists it under required.
The descriptions marked not from the time slice are not in _sources/v202604/bo4e but in the source named in each case; they have been adopted editorially and are not derived from the schemas of this page. The page Keys describes the keys in context.
These sources spell out a field of the same name themselves instead of referencing the BO4E field atom. The $ref graph above does not see these places, and they are not a usage of the field atom either — which is why they are listed separately here and are nowhere added to the usages.