Reading backend interfaces
Read remittance advice
Read remittance advice
GET
https://mock.macoapp.de
/getAvisBasic
Reading the advice using the advice number (Parameter1)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | avisNummer | avis Number · Example: 123456 | string |
command | Corresponds to the operationId of this interface. This operation ID corresponds to the command in the Camunda connector process. If the backend provides a generic endpoint, this command can be used to define which operation is to be executed. | string |
Read remittance advice › Responses
Successful reading of the remittance advice
Array of: Advice — the response is a list of these objects, not a single object. Every entry has this structure:
| Structure (BO4E) | Description | Format |
|---|---|---|
boTyp* | Type of the 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 | Payment advice number assigned by the sender of the document. | string |
avisTyp | Indicates the type of the remittance advice, type and function of a message BGM 481 PI 33002 33003 33004 33001 | stringABGELEHNTE_FORDERUNG, ZAHLUNGSAVIS |
| zuZahlen | Total amount | object |
wert | Requested invoice amount 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 | Currency details of the invoice, reference currency euro, monetary amount EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| positionen[ ] | Remittance advice items - details of the documents 380 commercial invoice 389 self-billed invoice 457 cancellation of a debit Z25 cancellation of a self-billed invoice (credit note in the self-billing procedure) DOC 380 PI 33001 33002 33003 33004 | object[] |
rechnungsNummer | Document number | string |
rechnungsDatum | Invoice date DTM 137 PI 33001 33002 33003 33004 | string (date-time) |
istStorno | Cancellation 457 Cancellation of a debit. Z25 Cancellation for a self-billed invoice (credit note in the self-billing procedure) | boolean |
istSelbstausgestellt | Self-billed invoice 389 Self-billed invoice (engl.: "Selfbilled invoice") | boolean |
referenz | Reference number for COMDIS RFF ACW PI 33002 33003 33004 | string |
| gesamtBrutto | Total amount | object |
wert | Requested invoice amount 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 | Currency details of the invoice, reference currency euro, monetary amount EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| zuZahlen | Total amount | object |
wert | Requested invoice amount 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 | Currency details of the invoice, reference currency euro, monetary amount EUR Euro CUX 2 EUR PI 29001 REMADV PI 33001 33002 33003 33004 QUOTES PI 15001 15002 15003 | string |
| abweichung[ ] | Reason for deviation, all detected rejection reasons ATJ PI 33002 33003 | object[] |
abweichungsgrund | not in use | 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 | Remark on the reason for deviation | string |
zugehoerigeRechnung | Invoice number - associated invoice RFF AFL PI 31010 33003 | string |
zugehoerigeBestellung | Specification of the order number to which this deviation refers | string |
abweichungsgrundCode | Code of the deviation reason, codes from the EBDs | string |
abweichungsgrundCodeliste | Code list or EBD | string |
fehlendePositionen1 | missing item number of an offer 1 FTX Z16 PI 33003 | string |
fehlendePositionen2 | missing item number of an offer 2 | string |
fehlendePositionen3 | missing item number of an offer 3 | string |
fehlendePositionen4 | missing item number of an offer 4 | string |
fehlendePositionen5 | missing item number of an offer 5 | string |
abweichungsgrundBemerkung1 | Information on deviation 1 FTX ABO PI 33002 33003 | string |
abweichungsgrundBemerkung2 | Information on deviation 2 | string |
abweichungsgrundBemerkung3 | Information on deviation 3 | string |
abweichungsgrundBemerkung4 | Information on deviation 4 | string |
abweichungsgrundBemerkung5 | Information on deviation 5 | string |
referenz | Reference number of a preceding message RFF ACW PI 33004 | string |
abschlagsrechnungen[ ] | Included advance payment invoices - invoice number FTX Z14 PI 33003 | string[] |
| positionen[ ] | Identification of the line - position in the document DLI 1 PI 33004 | object[] |
positionsnummer | Line item number | integer |
| abweichung[ ] | Deviation | object[] |
abweichungsgrund | not in use | 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 | Remark on the reason for deviation | string |
zugehoerigeRechnung | Invoice number - associated invoice RFF AFL PI 31010 33003 | string |
zugehoerigeBestellung | Specification of the order number to which this deviation refers | string |
abweichungsgrundCode | Code of the deviation reason, codes from the EBDs | string |
abweichungsgrundCodeliste | Code list or EBD | string |
fehlendePositionen1 | missing item number of an offer 1 FTX Z16 PI 33003 | string |
fehlendePositionen2 | missing item number of an offer 2 | string |
fehlendePositionen3 | missing item number of an offer 3 | string |
fehlendePositionen4 | missing item number of an offer 4 | string |
fehlendePositionen5 | missing item number of an offer 5 | string |
abweichungsgrundBemerkung1 | Information on deviation 1 FTX ABO PI 33002 33003 | string |
abweichungsgrundBemerkung2 | Information on deviation 2 | string |
abweichungsgrundBemerkung3 | Information on deviation 3 | string |
abweichungsgrundBemerkung4 | Information on deviation 4 | string |
abweichungsgrundBemerkung5 | Information on deviation 5 | string |
referenz | Reference number of a preceding message RFF ACW PI 33004 | string |
abschlagsrechnungen[ ] | Included advance payment invoices - invoice number FTX Z14 PI 33003 | string[] |