Billing of services of price sheet A…

START_VERSAND_ANTWORT_NNA (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (8):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "AVIS": [
      {
        "avisNummer": "avisNummer",
        "avisTyp": "ABGELEHNTE_FORDERUNG",
        "positionen": [
          {
            "gesamtBrutto": {
              "wert": 0
            },
            "istSelbstausgestellt": true,
            "istStorno": true,
            "rechnungsDatum": "2024-08-25T15:00:00Z",
            "rechnungsNummer": "rechnungsNummer",
            "zuZahlen": {
              "wert": 0
            }
          }
        ],
        "zuZahlen": {
          "waehrung": "waehrung",
          "wert": 0
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "nachrichtendatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "33001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_ANTWORT_NNA",
    "prozessId": "prozessId"
  }
}'

START_VERSAND_ANTWORT_NNA (LF) › Request Body

The body of this call — one column per admissible Prüfidentifikator. A value in the column means the field belongs to that Prüfidentifikator: Must where the schema requires it, otherwise May.

Structure (BO4E)	Description	Format	33001	33002	33003	33004
stammdaten*	—	object	Muss	Muss	Muss	Muss
AVIS[ ]*	—	object[]	Muss	Muss	Muss	Muss
`avisNummer`*00010	A number for the remittance advice that is unique in the context of use.	string	Muss	Muss	Muss	Muss
`avisTyp`*00020	Indicates the type of the remittance advice.	string	Muss	Muss	Muss	Muss
`ABGELEHNTE_FORDERUNG`			Muss	Muss	Muss	Muss
`ZAHLUNGSAVIS`			Muss	Muss	Muss	Muss
positionen[ ]*	—	object[]	Muss	Muss	Muss	Muss
`istSelbstausgestellt`*00030	istSelbstausgestellt	boolean	Muss	Muss	Muss	Muss
`istStorno`*00040	istStorno	boolean	Muss	Muss	Muss	Muss
`rechnungsDatum`*00050	rechnungsDatum	string (date-time)	Muss	Muss	Muss	Muss
`rechnungsNummer`*00060	rechnungsNummer	string	Muss	Muss	Muss	Muss
gesamtBrutto*	—	object	Muss	Muss	Muss	Muss
`wert`*00070	Value	number (float)	Muss	Muss	Muss	Muss
zuZahlen*	—	object	Muss	Muss	Muss	Muss
`wert`*00080	Value	number (float)	Muss	Muss	Muss	Muss
`referenz`00090	referenz	string		Kann	Kann	Kann
abweichung[ ]*	—	object[]		Muss	Muss
`abweichungsgrundBemerkung1`00100	Deviation reason remark 1	string		Kann	Kann
`abweichungsgrundBemerkung2`00110	Deviation reason remark 2	string		Kann	Kann
`abweichungsgrundBemerkung3`00120	Deviation reason remark 3	string		Kann	Kann
`abweichungsgrundBemerkung4`00130	Deviation reason remark 4	string		Kann	Kann
`abweichungsgrundBemerkung5`00140	Deviation reason remark 5	string		Kann	Kann
`abweichungsgrundCode`*00150	Code of the reason for deviation	string		Muss	Muss
`abweichungsgrundCodeliste`*00160	Code list of the deviation reason	string		Muss	Muss
`abschlagsrechnungen`[ ]00170	Instalment invoices	string[]			Kann
`fehlendePositionen1`00180	missing line items 1	string			Kann
`fehlendePositionen2`00190	missing line items 2	string			Kann
`fehlendePositionen3`00200	missing line items 3	string			Kann
`fehlendePositionen4`00210	missing line items 4	string			Kann
`fehlendePositionen5`00220	missing line items 5	string			Kann
`zugehoerigeRechnung`00230	Specification of the invoice number to which this deviation refers	string			Kann
positionen[ ]*	—	object[]				Muss
`positionsnummer`*00240	Line item number	integer				Muss
abweichung[ ]*	—	object[]				Muss
`abweichungsgrundBemerkung1`00250	Deviation reason remark 1	string				Kann
`abweichungsgrundBemerkung2`00260	Deviation reason remark 2	string				Kann
`abweichungsgrundBemerkung3`00270	Deviation reason remark 3	string				Kann
`abweichungsgrundBemerkung4`00280	Deviation reason remark 4	string				Kann
`abweichungsgrundBemerkung5`00290	Deviation reason remark 5	string				Kann
`abweichungsgrundCode`*00300	Code of the reason for deviation	string				Muss
`abweichungsgrundCodeliste`*00310	Code list of the deviation reason	string				Muss
`referenz`00320	referenz	string				Kann
`zugehoerigeRechnung`00330	Specification of the invoice number to which this deviation refers	string				Kann
zuZahlen*	—	object	Muss	Muss	Muss	Muss
`waehrung`*00340	Currency of the price	string	Muss	Muss	Muss	Muss
`wert`*00350	Value	number (float)	Muss	Muss	Muss	Muss
transaktionsdaten*	—	object	Muss	Muss	Muss	Muss
`kategorie`*00360	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss	Muss	Muss	Muss
`nachrichtendatum`*00370	Creation date of the EDIFact / DTM+137	string (date-time)	Muss	Muss	Muss	Muss
`pruefidentifikator`*00380	Determined dynamically in the event process (basis for the decision: kategorie, pruefi). A value supplied by the sender is ignored. Check identifiers possible in the topic — 33001, 33002, 33003, 33004.	—	Muss	Muss	Muss	Muss
`sparte`*00390	Contains information about the division	string	Muss	Muss	Muss	Muss
`STROM`			Muss	Muss	Muss	Muss
`GAS`			Muss	Muss	Muss	Muss
`FERNWAERME`			Muss	Muss	Muss	Muss
`NAHWAERME`			Muss	Muss	Muss	Muss
`WASSER`			Muss	Muss	Muss	Muss
`ABWASSER`			Muss	Muss	Muss	Muss
absender*	—	object	Muss	Muss	Muss	Muss
`rollencodenummer`00400	Specifies the code value of the market role.	string	Kann	Kann	Kann	Kann
empfaenger*	—	object	Muss	Muss	Muss	Muss
`marktrolle`00410	Indicates the designation of the market role in free text.	string	Kann	Kann	Kann	Kann
`NB`			Kann	Kann	Kann	Kann
`LF`			Kann	Kann	Kann	Kann
`MSB`			Kann	Kann	Kann	Kann
`MSBA`			Kann	Kann	Kann	Kann
`GMSB`			Kann	Kann	Kann	Kann
`MDL`			Kann	Kann	Kann	Kann
`DL`			Kann	Kann	Kann	Kann
`BKV`			Kann	Kann	Kann	Kann
`BKO`			Kann	Kann	Kann	Kann
`UENB`			Kann	Kann	Kann	Kann
`KUNDE-SELBST-NN`			Kann	Kann	Kann	Kann
`MGV`			Kann	Kann	Kann	Kann
`EIV`			Kann	Kann	Kann	Kann
`RB`			Kann	Kann	Kann	Kann
`KUNDE`			Kann	Kann	Kann	Kann
`INTERESSENT`			Kann	Kann	Kann	Kann
`KN`			Kann	Kann	Kann	Kann
`UBA`			Kann	Kann	Kann	Kann
`BIKO`			Kann	Kann	Kann	Kann
`ESA`			Kann	Kann	Kann	Kann
`rollencodenummer`00420	Specifies the code value of the market role.	string	Kann	Kann	Kann	Kann
zusatzdaten*	—	object	Muss	Muss	Muss	Muss
`eventname`*00430	—	string	Muss	Muss	Muss	Muss
`prozessId`*00440	—	string	Muss	Muss	Muss	Muss

Example Request Body

{
  "stammdaten": {
    "AVIS": [
      {
        "avisNummer": "avisNummer",
        "avisTyp": "ABGELEHNTE_FORDERUNG",
        "positionen": [
          {
            "gesamtBrutto": {
              "wert": 0
            },
            "istSelbstausgestellt": true,
            "istStorno": true,
            "rechnungsDatum": "2024-08-25T15:00:00Z",
            "rechnungsNummer": "rechnungsNummer",
            "zuZahlen": {
              "wert": 0
            }
          }
        ],
        "zuZahlen": {
          "waehrung": "waehrung",
          "wert": 0
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "nachrichtendatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "33001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_ANTWORT_NNA",
    "prozessId": "prozessId"
  }
}

json

START_VERSAND_ANTWORT_NNA (LF) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_VERSAND_ANTWORT_NNA der Marktrolle LF.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Der Aufruf geht tatsächlich an POST /inbound; das Event ergibt sich aus zusatzdaten.eventname im Rumpf. Diese Seite trennt eine von 104 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.

START_VERSAND_ANF_STORNO Order placement for termination of a…

START_VERSAND_ANTWORT_NNA (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (8):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "AVIS": [
      {
        "avisNummer": "avisNummer",
        "avisTyp": "ABGELEHNTE_FORDERUNG",
        "positionen": [
          {
            "gesamtBrutto": {
              "wert": 0
            },
            "istSelbstausgestellt": true,
            "istStorno": true,
            "rechnungsDatum": "2024-08-25T15:00:00Z",
            "rechnungsNummer": "rechnungsNummer",
            "zuZahlen": {
              "wert": 0
            }
          }
        ],
        "zuZahlen": {
          "waehrung": "waehrung",
          "wert": 0
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "nachrichtendatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "33001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_ANTWORT_NNA",
    "prozessId": "prozessId"
  }
}'

START_VERSAND_ANTWORT_NNA (LF) › Request Body

Structure (BO4E)	Description	Format	33001	33002	33003	33004
stammdaten*	—	object	Muss	Muss	Muss	Muss
AVIS[ ]*	—	object[]	Muss	Muss	Muss	Muss
`avisNummer`*00010	A number for the remittance advice that is unique in the context of use.	string	Muss	Muss	Muss	Muss
`avisTyp`*00020	Indicates the type of the remittance advice.	string	Muss	Muss	Muss	Muss
`ABGELEHNTE_FORDERUNG`			Muss	Muss	Muss	Muss
`ZAHLUNGSAVIS`			Muss	Muss	Muss	Muss
positionen[ ]*	—	object[]	Muss	Muss	Muss	Muss
`istSelbstausgestellt`*00030	istSelbstausgestellt	boolean	Muss	Muss	Muss	Muss
`istStorno`*00040	istStorno	boolean	Muss	Muss	Muss	Muss
`rechnungsDatum`*00050	rechnungsDatum	string (date-time)	Muss	Muss	Muss	Muss
`rechnungsNummer`*00060	rechnungsNummer	string	Muss	Muss	Muss	Muss
gesamtBrutto*	—	object	Muss	Muss	Muss	Muss
`wert`*00070	Value	number (float)	Muss	Muss	Muss	Muss
zuZahlen*	—	object	Muss	Muss	Muss	Muss
`wert`*00080	Value	number (float)	Muss	Muss	Muss	Muss
`referenz`00090	referenz	string		Kann	Kann	Kann
abweichung[ ]*	—	object[]		Muss	Muss
`abweichungsgrundBemerkung1`00100	Deviation reason remark 1	string		Kann	Kann
`abweichungsgrundBemerkung2`00110	Deviation reason remark 2	string		Kann	Kann
`abweichungsgrundBemerkung3`00120	Deviation reason remark 3	string		Kann	Kann
`abweichungsgrundBemerkung4`00130	Deviation reason remark 4	string		Kann	Kann
`abweichungsgrundBemerkung5`00140	Deviation reason remark 5	string		Kann	Kann
`abweichungsgrundCode`*00150	Code of the reason for deviation	string		Muss	Muss
`abweichungsgrundCodeliste`*00160	Code list of the deviation reason	string		Muss	Muss
`abschlagsrechnungen`[ ]00170	Instalment invoices	string[]			Kann
`fehlendePositionen1`00180	missing line items 1	string			Kann
`fehlendePositionen2`00190	missing line items 2	string			Kann
`fehlendePositionen3`00200	missing line items 3	string			Kann
`fehlendePositionen4`00210	missing line items 4	string			Kann
`fehlendePositionen5`00220	missing line items 5	string			Kann
`zugehoerigeRechnung`00230	Specification of the invoice number to which this deviation refers	string			Kann
positionen[ ]*	—	object[]				Muss
`positionsnummer`*00240	Line item number	integer				Muss
abweichung[ ]*	—	object[]				Muss
`abweichungsgrundBemerkung1`00250	Deviation reason remark 1	string				Kann
`abweichungsgrundBemerkung2`00260	Deviation reason remark 2	string				Kann
`abweichungsgrundBemerkung3`00270	Deviation reason remark 3	string				Kann
`abweichungsgrundBemerkung4`00280	Deviation reason remark 4	string				Kann
`abweichungsgrundBemerkung5`00290	Deviation reason remark 5	string				Kann
`abweichungsgrundCode`*00300	Code of the reason for deviation	string				Muss
`abweichungsgrundCodeliste`*00310	Code list of the deviation reason	string				Muss
`referenz`00320	referenz	string				Kann
`zugehoerigeRechnung`00330	Specification of the invoice number to which this deviation refers	string				Kann
zuZahlen*	—	object	Muss	Muss	Muss	Muss
`waehrung`*00340	Currency of the price	string	Muss	Muss	Muss	Muss
`wert`*00350	Value	number (float)	Muss	Muss	Muss	Muss
transaktionsdaten*	—	object	Muss	Muss	Muss	Muss
`kategorie`*00360	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss	Muss	Muss	Muss
`nachrichtendatum`*00370	Creation date of the EDIFact / DTM+137	string (date-time)	Muss	Muss	Muss	Muss
`pruefidentifikator`*00380	Determined dynamically in the event process (basis for the decision: kategorie, pruefi). A value supplied by the sender is ignored. Check identifiers possible in the topic — 33001, 33002, 33003, 33004.	—	Muss	Muss	Muss	Muss
`sparte`*00390	Contains information about the division	string	Muss	Muss	Muss	Muss
`STROM`			Muss	Muss	Muss	Muss
`GAS`			Muss	Muss	Muss	Muss
`FERNWAERME`			Muss	Muss	Muss	Muss
`NAHWAERME`			Muss	Muss	Muss	Muss
`WASSER`			Muss	Muss	Muss	Muss
`ABWASSER`			Muss	Muss	Muss	Muss
absender*	—	object	Muss	Muss	Muss	Muss
`rollencodenummer`00400	Specifies the code value of the market role.	string	Kann	Kann	Kann	Kann
empfaenger*	—	object	Muss	Muss	Muss	Muss
`marktrolle`00410	Indicates the designation of the market role in free text.	string	Kann	Kann	Kann	Kann
`NB`			Kann	Kann	Kann	Kann
`LF`			Kann	Kann	Kann	Kann
`MSB`			Kann	Kann	Kann	Kann
`MSBA`			Kann	Kann	Kann	Kann
`GMSB`			Kann	Kann	Kann	Kann
`MDL`			Kann	Kann	Kann	Kann
`DL`			Kann	Kann	Kann	Kann
`BKV`			Kann	Kann	Kann	Kann
`BKO`			Kann	Kann	Kann	Kann
`UENB`			Kann	Kann	Kann	Kann
`KUNDE-SELBST-NN`			Kann	Kann	Kann	Kann
`MGV`			Kann	Kann	Kann	Kann
`EIV`			Kann	Kann	Kann	Kann
`RB`			Kann	Kann	Kann	Kann
`KUNDE`			Kann	Kann	Kann	Kann
`INTERESSENT`			Kann	Kann	Kann	Kann
`KN`			Kann	Kann	Kann	Kann
`UBA`			Kann	Kann	Kann	Kann
`BIKO`			Kann	Kann	Kann	Kann
`ESA`			Kann	Kann	Kann	Kann
`rollencodenummer`00420	Specifies the code value of the market role.	string	Kann	Kann	Kann	Kann
zusatzdaten*	—	object	Muss	Muss	Muss	Muss
`eventname`*00430	—	string	Muss	Muss	Muss	Muss
`prozessId`*00440	—	string	Muss	Muss	Muss	Muss

Example Request Body

{
  "stammdaten": {
    "AVIS": [
      {
        "avisNummer": "avisNummer",
        "avisTyp": "ABGELEHNTE_FORDERUNG",
        "positionen": [
          {
            "gesamtBrutto": {
              "wert": 0
            },
            "istSelbstausgestellt": true,
            "istStorno": true,
            "rechnungsDatum": "2024-08-25T15:00:00Z",
            "rechnungsNummer": "rechnungsNummer",
            "zuZahlen": {
              "wert": 0
            }
          }
        ],
        "zuZahlen": {
          "waehrung": "waehrung",
          "wert": 0
        }
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "marktrolle": "NB",
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "nachrichtendatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "33001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_ANTWORT_NNA",
    "prozessId": "prozessId"
  }
}

json

START_VERSAND_ANTWORT_NNA (LF) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_VERSAND_ANTWORT_NNA der Marktrolle LF.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Feedback on the documentation

Feedback on the documentation

Billing of services of price sheet A…

START_VERSAND_ANTWORT_NNA (LF)

START_VERSAND_ANTWORT_NNA (LF) › Request Body

START_VERSAND_ANTWORT_NNA (LF) › Responses

Billing of services of price sheet A…

START_VERSAND_ANTWORT_NNA (LF)

START_VERSAND_ANTWORT_NNA (LF) › Request Body

START_VERSAND_ANTWORT_NNA (LF) › Responses