Inhaltsverzeichnis Zahlhistorie auf Basis Abo Nummer Zahlhistorie auf Basis Geschäftspartner Nummer Zahlhistorie auf Basis Abo Nummer Dieser Web Service gibt die Zahlhistorie eines Aboauftrags aus. Path mapping(intern): /net/dsb/avs3/Archive/getPaymentHistory-1.0.0 Fuba: /DSB/_ISM_E_GET_PAYHISTORY URL GET: /rest/{client}/subscriptions/{orderNumber}/payments ParameterBeschreibung clientMandant orderNumberAuftragsnummer invoiceHistoryZahlhistorie ausgeben - Bei Non-Renewal immer setzen! - Ansonsten kommen verzerrte/falsche Ergebnisse raus Ergebnis Die Zahlhistorie wird als JSON Dokument zurückgegeben. Jedoch ist dabei zu beachten dass entweder die externe Rechnungsnummer ausgegeben wird (externalDocumentNumber, hat höhere Prio) oder die interne Rechnungsnummer (InvoiceNumber). Zusätzlich wird auch in der Historie je Satz der Rechnungsstatus mitgegeben (Ausgeglichen = A, Teilausgeglichen = T oder offen = O). Um zu sehen ob noch offene Beträge je Auftragsnummer vorhanden sind, muss zusätzlich auch der Saldo herangezogen werden - Nur wenn dieser Null oder kleiner Null ist sind alle Rechnungen ausgeglichen. Beispiel (zur besseren Darstellung formatiert): { "accountBalances": [ { "contractAccountNumber": "100000055817", "accountBalance": 4.8 } ], "history": [ { "orderNumber": "4100072943", "position": 1, "cycle": 0, "invoiceNumber": "5135882005", "amount": 4.8, "currency": "EUR", "date": "08.12.2020", "contractAccountNumber": "100000055817", "invoiceStatus": "offen", "invoiceStatusCode": "O" }, { "orderNumber": "4100072943", "position": 1, "cycle": 0, "invoiceNumber": "5134157170", "amount": 4.8, "currency": "EUR", "date": "10.11.2020", "contractAccountNumber": "100000055817", "invoiceStatus": "ausgeglichen", "invoiceStatusCode": "A" }, { "orderNumber": "4100072943", "position": 1, "cycle": 0, "invoiceNumber": "5132225844", "amount": 4.8, "currency": "EUR", "date": "14.10.2020", "contractAccountNumber": "100000055817", "invoiceStatus": "ausgeglichen", "invoiceStatusCode": "A" }, { "orderNumber": "4100072943", "position": 1, "cycle": 0, "invoiceNumber": "5130519506", "amount": 4.8, "currency": "EUR", "date": "15.09.2020", "contractAccountNumber": "100000055817", "invoiceStatus": "ausgeglichen", "invoiceStatusCode": "A" } ], "orderNumber": "4100072943" } JSON FeldBeschreibung orderNumberAuftragsnummer archiveId ID des Archivs date Fakturdatum amount Rechnungsbetrag currency Rechnungswährung invoiceNumberRechnungsnummer externalDocumentNumberDokumentnummer position Position cycle Zyklus documentId ID des Dokuments im Archiv invoiceStatus Kürzel für Rechnungsstatus: A,O,T invoiceStatusCode Rechnungsstatus-Kürzel wird ausgeschrieben: A=ausgeglichen (Alle Positionen sind ausgeglichen) O=offen (alle Positionen zur Rechnung sind offen), T=teilausgeglichen (Offene als auch ausgeglichene Positionen zur Rechnung vorhanden) Zahlhistorie auf Basis Geschäftspartner Nummer (Nutzung nur bei entspr. Backendintegration in der ccb Suite) Dieser Web Service gibt die Zahlhistorie eines Geschäftspartners aus. Für den Endsaldo muss über die accountBalance Felder des accountBalances Array kumuliert werden. Path mapping(intern): /net/dsb/avs3/Archive/getPaymentHistoryforBp-1.0.0 Fuba: /DSB/_ISM_E_GET_PAYHISTORY URL GET: /rest/{client}/bp/{bpNumber}/payments?sp={sp}&so={so} ParameterTyp/LängeBeschreibung clientC/3Mandant bpNumberC/10Geschäftspartner Nummer invoiceHistoryZahlhistorie ausgeben - funktioniert nur für DACH sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so C/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) Ergebnis Die Zahlhistorie wird als JSON Dokument zurückgegeben. Jedoch ist dabei zu beachten dass entweder die externe Rechnungsnummer ausgegeben wird (externalDocumentNumber, hat höhere Prio) oder die interne Rechnungsnummer (InvoiceNumber). Zusätzlich wird auch in der Historie je Satz der Rechnungsstatus mitgegeben (Ausgeglichen = A, Teilausgeglichen = T oder offen = O). Um zu sehen ob noch offene Beträge je Auftragsnummer vorhanden sind, muss zusätzlich auch der Saldo herangezogen werden - Nur wenn dieser Null oder kleiner Null ist sind alle Rechnungen ausgeglichen. Beispiel (zur besseren Darstellung formatiert): { "accountBalances": [ { "contractAccountNumber": "100001523848", "accountBalance": 40 }, { "contractAccountNumber": "100001523849", "accountBalance": 45 } ], "history": [ { "orderNumber": "4230106736", "position": 1, "cycle": 0, "externalDocumentNumber": "1591288161102", "amount": 40, "currency": "EUR", "date": "01.12.2020", "contractAccountNumber": "100001523848", "invoiceStatus": "offen", "invoiceStatusCode": "O" "documentId":"00000000000000658_1110_2700153351901_000" }, { "orderNumber": "4230106744", "position": 1, "cycle": 0, "externalDocumentNumber": "1591288162009", "amount": 45, "currency": "EUR", "date": "01.12.2020", "contractAccountNumber": "100001523849", "invoiceStatus": "offen", "invoiceStatusCode": "O" "documentId":"00000000000000658_1110_2700153351901_000" } ], "bpNumber": "1034850380" } JSON FeldBeschreibung accountBalance Saldo contractAccountNumber Vertragskontonummer date Faktur-Datum archiveId ID des Archivs amount Rechnungsbetrag invoiceNumber Rechnungsnummer externalDocumentNumber Dokumenten Nummer currency Rechnungswährung position Position cycle Feld ist im dt. Abomodell nicht relevant documentId ID des Dokuments im Archiv(ist für den Abruf des Rechnungs PDF notwendig) invoiceStatus Kürzel für Rechnungsstatus: A,O,T invoiceStatusCode Rechnungsstatus-Kürzel wird ausgeschrieben: A=ausgeglichen (Alle Positionen sind ausgeglichen) O=offen (alle Positionen zur Rechnung sind offen), T=teilausgeglichen (Offene als auch ausgeglichene Positionen zur Rechnung vorhanden) HTTP Response StatusBedeutung 200 Ergebnis erfolgreich 401 Authorisierung fehlt oder ist fehlgeschlagen 403 Zugriff auf dieses Abo ist für den Benutzer nicht erlaubt. 404 Abo ist nicht vorhanden Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. OK Weitere Information