Lesende Backend-Schnittstellen
Avis lesen
Avis lesen
GET
https://mock.macoapp.de
/getAvisBasic
Lesen des Avises mittels Avisnummer (Parameter1)
query Parameters
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
parameter1* | avisNummer | avis Number · Beispiel: 123456 | string |
command | Entspricht der operationId dieser Schnittstelle. Diese Operation Id entspricht dem Command im Camunda Konnektor Prozess. Wenn das Backend einen generischen Endpunkt bereitstellt, kann dieses Command gentutzt werden um zu definieren welche Operation ausgeführt werden soll. | string |
Avis lesen › Responses
Erfolgreiches Lesen des Avises
Array of: Avis — die Antwort ist eine Liste dieser Objekte, nicht ein einzelnes Objekt. Jeder Eintrag hat diesen Aufbau:
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
boTyp* | Typ des BO | stringANSPRECHPARTNER, AVIS, ENERGIEMENGE GESCHAEFTSOBJEKT, GESCHAEFTSPARTNER, MARKTLOKATION, MARKTTEILNEHMER, MESSLOKATION, ZAEHLER, KOSTEN, TARIF, PREISBLATT, PREISBLATTNETZNUTZUNG, PREISBLATTMESSUNG, PREISBLATTUMLAGEN, PREISBLATTDIENSTLEISTUNG, PREISBLATTKONZESSIONSABGABE, ZEITREIHE, LASTGANG, HANDELSUNSTIMMIGKEIT, ANFRAGE, AUFTRAG, STATUSMITTEILUNG, BERECHNUNGSFORMEL, RECHNUNG, BILANZIERUNG, NETZNUTZUNGSVERTRAG, MESSSTELLENBETRIEBSVERTRAG, ENERGIELIEFERVERTRAG, SPERRAUFTRAG, ANGEBOT, TRANCHE, KOMMUNIKATIONSDATEN, ZAEHLZEITDEFINITION, SCHALTZEITDEFINITION, LEISTUNGSKURVENDEFINITION, NETZLOKATION, STEUERBARE_RESSOURCE, TECHNISCHE_RESSOURCE, AD_HOC_STEUERKANAL, LOKATIONSBUENDEL, WERTE_NACH_TYP2, REKLAMATION, STATUSBERICHT, VERTRAG, BILANZKREIS, VERWENDUNGSZEITRAUM, TARIFINFO, SUMMENZEITREIHE |
versionStruktur* | versionStruktur | string |
avisNummer | Zahlungsavisnummer vergeben vom Absender des Dokuments. | string |
avisTyp | Gibt den Typ des Avis an, Typ und Funktion einer Nachricht BGM 481 PI 33002 33003 33004 33001 | stringABGELEHNTE_FORDERUNG, ZAHLUNGSAVIS |
| zuZahlen | Summenbetrag | object |
wert | Geforderter Rechnungsbetrag MOA 9 PI 29001 REMADV PI 33001 33002 33003 33004 MOA 12 PI 33001 33002 33003 33004 INVOIC MOA 203/77/113/9 | number (float) |
waehrung | Währungsangaben der Rechnung, Referenzwährung Euro, Geldbetrag EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| positionen[ ] | Avispositionen - Angaben zu den Dokumenten 380 Handelsrechnung 389 Selbst ausgestellte Rechnung (engl.: "Selfbilled invoice") 457 Storno einer Belastung Z25 Storno für selbst ausgestellte Rechnung (Gutschrift im Gutschriftsverfahren) DOC 380 PI 33001 33002 33003 33004 | object[] |
rechnungsNummer | Dokumentennummer | string |
rechnungsDatum | Rechnungsdatum DTM 137 PI 33001 33002 33003 33004 | string (date-time) |
istStorno | Storno 457 Storno einer Belastung. Z25 Storno für selbst ausgestellte Rechnung (Gutschrift im Gutschriftsverfahren) | boolean |
istSelbstausgestellt | Selbst ausgestellte Rechnung 389 Selbst ausgestellte Rechnung (engl.: "Selfbilled invoice") | boolean |
referenz | Referenznummer auf COMDIS RFF ACW PI 33002 33003 33004 | string |
| gesamtBrutto | Summenbetrag | object |
wert | Geforderter Rechnungsbetrag MOA 9 PI 29001 REMADV PI 33001 33002 33003 33004 MOA 12 PI 33001 33002 33003 33004 INVOIC MOA 203/77/113/9 | number (float) |
waehrung | Währungsangaben der Rechnung, Referenzwährung Euro, Geldbetrag EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| zuZahlen | Summenbetrag | object |
wert | Geforderter Rechnungsbetrag MOA 9 PI 29001 REMADV PI 33001 33002 33003 33004 MOA 12 PI 33001 33002 33003 33004 INVOIC MOA 203/77/113/9 | number (float) |
waehrung | Währungsangaben der Rechnung, Referenzwährung Euro, Geldbetrag EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| abweichung[ ] | Abweichungsgrund, alle erkannten Ablehnungsgründe ATJ PI 33002 33003 | object[] |
abweichungsgrund | nicht in Benutzung | stringPREIS_RECHENREGEL_FALSCH, FALSCHER_ABRECHNUNGSZEITRAUM, UNBEKANNTE_MARKTLOKATION_MESSLOKATION SONSTIGER_ABWEICHUNGSGRUND, DOPPELTE_RECHNUNG, ABRECHNUNGSBEGINN_UNGLEICH_VERTRAGSBEGINN, ABRECHNUNGSENDE_UNGLEICH_VERTRAGSENDE, BETRAG_DER_ABSCHLAGSRECHNUNG_FALSCH, VORAUSBEZAHLTER_BETRAG_FALSCH, ARTIKEL_NICHT_VEREINBART, NETZNUTZUNGSMESSWERTE_ENERGIEMENGEN_FEHLEN, RECHNUNGSNUMMER_BEREITS_ERHALTEN, NETZNUTZUNGSMESSWERTE_ENERGIEMENGEN_FALSCH, ZEITLICHE_MENGENANGABE_FEHLERHAFT, FALSCHER_BILANZIERUNGSBEGINN, FALSCHES_NETZNUTZUNGSENDE, BILANZIERTE_MENGE_FEHLT, BILANZIERTE_MENGE_FALSCH, NETZNUTZUNGSABRECHNUNG_FEHLT, REVERSE_CHARGE_ANWENDUNG_FEHLT_ODER_FEHLERHAFT, ALLOKATIONSLISTE_FEHLT, MEHR_MINDERMENGE_FALSCH, UNGUELTIGES_RECHNUNGSDATUM, ZEITINTERVALL_DER_BILANZIERTEN_MENGE_INKONSISTENT, RECHNUNGSEMPFAENGER_WIDERSPRICHT_DER_STEUERRECHTLICHEN_EINSCHAETZUNG_DES_RECHNUNGSSTELLERS, ANGEGEBENE_QUOTES_AN_MARKTLOKATION_NICHT_VORHANDEN, RECHNUNGSABWICKLUNG_NICHT_VEREINBART, COMDIS_WIRD_ABGELEHNT |
abweichungsgrundBemerkung | Bemerkung zum Abweichungsgrund | string |
zugehoerigeRechnung | Angabe der Rechnungsnummer - Zugehörige Rechnung RFF AFL PI 31010 33003 | string |
zugehoerigeBestellung | Angabe der Bestellungsnummer, auf die sich diese Abweichung bezieht | string |
abweichungsgrundCode | Code des Abweichungsgrundes, Codes aus den EBDs | string |
abweichungsgrundCodeliste | Codeliste oder EBD | string |
fehlendePositionen1 | fehlende Positionsnummer eines Angebotes 1 FTX Z16 PI 33003 | string |
fehlendePositionen2 | fehlende Positionsnummer eines Angebotes 2 | string |
fehlendePositionen3 | fehlende Positionsnummer eines Angebotes 3 | string |
fehlendePositionen4 | fehlende Positionsnummer eines Angebotes 4 | string |
fehlendePositionen5 | fehlende Positionsnummer eines Angebotes 5 | string |
abweichungsgrundBemerkung1 | Information über Abweichung 1 FTX ABO PI 33002 33003 | string |
abweichungsgrundBemerkung2 | Information über Abweichung 2 | string |
abweichungsgrundBemerkung3 | Information über Abweichung 3 | string |
abweichungsgrundBemerkung4 | Information über Abweichung 4 | string |
abweichungsgrundBemerkung5 | Information über Abweichung 5 | string |
referenz | Referenznummer einer vorangegangenen Nachricht RFF ACW PI 33004 | string |
abschlagsrechnungen[ ] | Enthaltene Abschlagsrechnungen - Rechnungsnummer FTX Z14 PI 33003 | string[] |
| positionen[ ] | Identifikation der Zeile - Position im Dokument DLI 1 PI 33004 | object[] |
positionsnummer | Positionsnummer | integer |
| abweichung[ ] | Abweichung | object[] |
abweichungsgrund | nicht in Benutzung | stringPREIS_RECHENREGEL_FALSCH, FALSCHER_ABRECHNUNGSZEITRAUM, UNBEKANNTE_MARKTLOKATION_MESSLOKATION SONSTIGER_ABWEICHUNGSGRUND, DOPPELTE_RECHNUNG, ABRECHNUNGSBEGINN_UNGLEICH_VERTRAGSBEGINN, ABRECHNUNGSENDE_UNGLEICH_VERTRAGSENDE, BETRAG_DER_ABSCHLAGSRECHNUNG_FALSCH, VORAUSBEZAHLTER_BETRAG_FALSCH, ARTIKEL_NICHT_VEREINBART, NETZNUTZUNGSMESSWERTE_ENERGIEMENGEN_FEHLEN, RECHNUNGSNUMMER_BEREITS_ERHALTEN, NETZNUTZUNGSMESSWERTE_ENERGIEMENGEN_FALSCH, ZEITLICHE_MENGENANGABE_FEHLERHAFT, FALSCHER_BILANZIERUNGSBEGINN, FALSCHES_NETZNUTZUNGSENDE, BILANZIERTE_MENGE_FEHLT, BILANZIERTE_MENGE_FALSCH, NETZNUTZUNGSABRECHNUNG_FEHLT, REVERSE_CHARGE_ANWENDUNG_FEHLT_ODER_FEHLERHAFT, ALLOKATIONSLISTE_FEHLT, MEHR_MINDERMENGE_FALSCH, UNGUELTIGES_RECHNUNGSDATUM, ZEITINTERVALL_DER_BILANZIERTEN_MENGE_INKONSISTENT, RECHNUNGSEMPFAENGER_WIDERSPRICHT_DER_STEUERRECHTLICHEN_EINSCHAETZUNG_DES_RECHNUNGSSTELLERS, ANGEGEBENE_QUOTES_AN_MARKTLOKATION_NICHT_VORHANDEN, RECHNUNGSABWICKLUNG_NICHT_VEREINBART, COMDIS_WIRD_ABGELEHNT |
abweichungsgrundBemerkung | Bemerkung zum Abweichungsgrund | string |
zugehoerigeRechnung | Angabe der Rechnungsnummer - Zugehörige Rechnung RFF AFL PI 31010 33003 | string |
zugehoerigeBestellung | Angabe der Bestellungsnummer, auf die sich diese Abweichung bezieht | string |
abweichungsgrundCode | Code des Abweichungsgrundes, Codes aus den EBDs | string |
abweichungsgrundCodeliste | Codeliste oder EBD | string |
fehlendePositionen1 | fehlende Positionsnummer eines Angebotes 1 FTX Z16 PI 33003 | string |
fehlendePositionen2 | fehlende Positionsnummer eines Angebotes 2 | string |
fehlendePositionen3 | fehlende Positionsnummer eines Angebotes 3 | string |
fehlendePositionen4 | fehlende Positionsnummer eines Angebotes 4 | string |
fehlendePositionen5 | fehlende Positionsnummer eines Angebotes 5 | string |
abweichungsgrundBemerkung1 | Information über Abweichung 1 FTX ABO PI 33002 33003 | string |
abweichungsgrundBemerkung2 | Information über Abweichung 2 | string |
abweichungsgrundBemerkung3 | Information über Abweichung 3 | string |
abweichungsgrundBemerkung4 | Information über Abweichung 4 | string |
abweichungsgrundBemerkung5 | Information über Abweichung 5 | string |
referenz | Referenznummer einer vorangegangenen Nachricht RFF ACW PI 33004 | string |
abschlagsrechnungen[ ] | Enthaltene Abschlagsrechnungen - Rechnungsnummer FTX Z14 PI 33003 | string[] |