Inkasso.List - Web-Dokumentation

Sollten nicht alle Ihre Fragen auf dieser Webseite beantwortet werden, so wenden Sie sich bitte an unsere IT-Abteilung unter der kostenlosen Hotline: 0800 / 11 44 111.


Inhaltsverzeichnis

  1. Allgemeine Funktionsbeschreibung
  2. Request - Anfrage an den XML-Server
  3. Response - Antwort vom XML-Server
  4. Beispiel-Antwort des XML-Servers

1. Allgemeine Funktionsbeschreibung

Übersicht der erteilten Inkassoverfahren

Sprung zum Anfang

2. Request - Anfrage an den XML-Server

struct/array Feldname Datentyp Beschreibung
  SIGNON struct allgemeine Angaben (zur Identifizierung des Anfragenden)
SIGNON USER_ID int User-ID von handelsauskunft.com (z. B. 210234)
SIGNON PASSWORD string Passwort zur User-ID (Änderung im Kundenbereich der Webseite möglich)
SIGNON SESSION_ID string Kann alternativ zu USER_ID und PASSWORD angegeben werden, wird von [Session.Login][] vergeben
SIGNON CUSTOMER_DUNS int D-U-N-S Nr. des Kunden, für den die Auskunft abgerufen wird (siehe Vertrag)
  REQUEST struct Anfrage-spezifische Angaben (die ersten 3 Felder sind allerdings bei allen Anfragen enthalten)
REQUEST CLIENT_REF string Aktenzeichen (beliebiger Inhalt), wird unverändert wieder zurückgegeben
REQUEST VERSION string Version der XML-Schnittstelle, muß derzeit "0.1" sein
REQUEST REASON string [Anfragegrund][]
REQUEST TEST boolean Kostenlose Testdaten werden bei "TEST = 1" zurück geliefert. Bei "TEST = 0" oder wenn "TEST" fehlt, dann werden immer Echt-Daten abgerufen!
REQUEST STATUS string Status des Inkassoverfahrens (NEU, OFFEN, VORGERICHTLICH, GERICHTLICH, NACHGERICHTLICH, ERLEDIGT) (Default: OFFEN = VORGERICHTLICH, GERICHTLICH oder NACHGERICHTLICH)
REQUEST KUNDEN_ID int Zeigt alle Inkassofaelle eines Kunden an, soweit Rechte dafuer vorhanden sind.
REQUEST GLAEUBIGER_ID string Zu jedem Auftraggeber wird beim Inkassobuero eine ID hinterlegt.
REQUEST RECHNUNGS_NR string Zeigt nur die Inkassofälle an, bei denen eine Rechnungs-Nummer übereinstimmt.
REQUEST ALLE_GLAEUBIGER boolean Zu einem Gläubiger koennen mehrere Gläubiger zugeordent werden. Mit dem Parameter = 1 werden alle Akten aller zugeordneten Gläubiger angezeigt. "1" ist Standand.
REQUEST USER_ID int Zeigt alle Inkassofaelle pro User an, soweit Rechte dafuer vorhanden sind.
REQUEST KUNDEN_AZ string Aktenzeichen des Kunden, das er für den Schuldner vorgebene hat (meistens die Debitorennummer) (Default: alle)
REQUEST INKASSO_AZ string Aktenzeichen eines Inkassofalls, es wird nur ein Ergebnis zur¼ck geliefer (Default: alle)
REQUEST SCHULDNER_NAME string Suche nach Schuldnername (Default: alle)
REQUEST SCHULDNER_PLZ string Suche nach Postleitzahl des Schuldners (Default: alle)
REQUEST SCHULDNER_ORT string Suche nach dem Ort des Schuldners (Default: alle)
REQUEST UEBERN_ZEITRAUM string Zeigt alle Inkassofälle innerhalb eines Zeitraums (0D = Heute, 3D = letzte 3 Tage, 7D = letzte 7 Tage, 14D = letzte 14 Tage, 1M = letzter Monat, 3M = letzte 3 Monate, 1Y = letztes 12 Monate, 2Y = letzte 24 Monate) (Default: all) an.
REQUEST BEARBEIT_ZEITRAUM string Zeigt alle Inkassofälle an, bei denen innerhalb eines Zeitraums (0D = Heute, 3D = letzte 3 Tage, 7D = letzte 7 Tage, 14D = letzte 14 Tage, 1M = letzter Monat, 3M = letzte 3 Monate, 1Y = letztes 12 Monate, 2Y = letzte 24 Monate) (Default: all) eine Bearbeitung statt gefunden hat.
REQUEST AMPEL_FARBE string Zeigt alle Inkassofälle mit gleichen Ampel-Farbe (R = rot, Y = gelb, G = grün, '-' = keine Prüfung erfolgt) (Default: alle)
REQUEST OFFENE_FRAGEN boolean Offene Fragen vom Innendienst an den Mandanten?
REQUEST ALLE_USER boolean Inkassoverfahren aller User einer Kunden-ID anzeigen?
REQUEST ALLE_KUNDEN boolean Inkassoverfahren aller Kunden (eines Partners) anzeigen? Dazu muß ALL_USERS ebenfalls gesetzt sein.
REQUEST RETURN_START int Beginne Anzeige bei Datensatz Nr. ... (angefangen bei 1) (Default: 1)
REQUEST RETURN_MAX int Es werden nur die letzten ... Inkassoverfahren angezeigt (Default: 10 - Maximal: 100 - Empfehlung: 30)
REQUEST RETURN_SORT int Sortierreihenfolge der Datensätze ("DATUM ASC", "DATUM DESC") (Default: "DATUM DESC" - absteigend nach Übergabedatum)
Sprung zum Anfang

3. Response - Antwort vom XML-Server

struct/array Feldname Datentyp Beschreibung
  RESPONSE struct allgemeine Angaben (Aktenzeichen und Preis)
RESPONSE CLIENT_REF string Wiederholung des Aktenzeichen
RESPONSE SERVER_REF string Aktenzeichen auf Serverseite (bitte bei Rückfragen angeben)
RESPONSE PRICE_UNITS double Preis der Auskunft in Einheiten
RESPONSE PRICE_EURO double Preis der Auskunft in Euro (Netto-Betrag)
  LIST struct
LIST GLAEUBIGER array Es koennen Akten verschiedener Glaeubiger zurueck geliefert werden. Diese muessen erst vom Kundenservice miteinander verknuepft werden.
GLAEUBIGER AKTEN_ANZAHL int Anzahl der Inkassofaelle pro Glaeubiger
GLAEUBIGER AKTEN_IN_DATEN boolean 0 = Es befinden sich keine Akten im Elemente DATEN; Werte in PAGES beziehen sich nicht mit auf diesesn Gläubiger, bei 1 = es sind Daten vorhanden.
GLAEUBIGER ANREDE string Anrede (Herr/Frau/Firma/unbekannt)
GLAEUBIGER DUNS_NBR string D-U-N-S Nr. (nur bei Firmen)
GLAEUBIGER FIRMENNAME string Firmenname (bei Firmen)
GLAEUBIGER GLAEUBIGER_ID string ID mit der der Gläubiger in der Inkassosoftware angelegt wurde, ist nicht identisch mit der KUNDEN_ID
GLAEUBIGER LAND string [Länderkode][] (2 Zeichen)
GLAEUBIGER LETZTER_VORGANG string Gibt den Zeitraum an, in dem ein Inkassofall des Gläubigers zuletzt bearbeitet wurde. (0D = Heute, 3D = letzte 3 Tage, 7D = letzte 7 Tage, 14D = letzte 14 Tage, 1M = letzter Monat, 3M = letzte 3 Monate, 1Y = letztes 12 Monate, 2Y = letzte 24 Monate).
GLAEUBIGER NACHNAME string Nachname (bei Privatpersonen
GLAEUBIGER ORT string Ort
GLAEUBIGER PLZ string Plz
GLAEUBIGER RECHTSFORM string REchtsform (wie GmbH, AG, KG usw.)
GLAEUBIGER STRASSE string Straße
GLAEUBIGER VORNAME string Vorname (bei Privatpersonen
LIST DATEN array Über das Parameter RETURN_MAX kann man die Anzahl der zurück gelieferten Datensätze bestimmen.
DATEN AKTUELLE_HF double Betrag der aktuellen noch offenen Hauptforderung.
DATEN AMPEL string Ampelfarbe (R = rot, Y = gelb, G = grün oder '-' = es erfolgte noch keine Boni-Prüfung) zeigt, ob zum Schuldner Negativdaten vorliegen.
DATEN CLIENT_REF string Aktenzeichen des Gläubigers, häufig die Debitorennummer
DATEN GLAEUBIGER_ID string Gläubiger-ID die zu dieser Akte gehört.
DATEN INKASSO_AZ string Bearbeitungsaktenzeichen des Inkassounternehmens
DATEN INKASSO_ID string Inkasso-ID von noch nicht verarbeiteten Inkassofaellen.
DATEN LAND string Die Kennzeichnung für das Land des Schuldners, für Deutschland = "DE".
DATEN OFFENE_FRAGEN boolean Dieses Feld wird mit einer "1" gefüllt, wenn der Inkassoinnendienst eine Frage an den Gläubiger hat und von diesen eine Entscheidung für die weitere Inkassobearbeitung benötigt.
DATEN ORT string Ort des Schuldners
DATEN SCHULDNER string Name des Schuldners
DATEN STATUS string Bearbeitungsstatus des Inkassofalls
DATEN UEBERGABE_DATUM string Datum an dem der Gläubiger das Inkassounternehmen mit der Beitreibung seiner Forderung beauftragt.
DATEN UEBERGEB_HF double Betrag der Hauptforderung zum Zeitpunkt der Erteilung des Inkassoauftrages.
LIST PAGES struct
PAGES START int Aufgrund der Limit-Funktion können nicht alle Treffer angezeigt werden. Beginn in der Liste der möglichen Treffer.
PAGES END int Ende in der Liste der möglichen Treffer.
PAGES MAXIMAL int Anzahl der möglichen Treffer.
Sprung zum Anfang

4. Beispiel-Antwort des XML-Servers

Anfolgendes Beispiel erhalten Sie, wenn Sie bei der Anfage an den XML-Server das Parameter: TEST = 1 setzen. Die Nachfolgende Ausgabe wurde mit dem Modul: Dumper erzeugt und zeigt die Struktur der Antwort auf.

{
  'GLAEUBIGER' => [
    {
      'ORT' => 'Gläubigerstadt',
      'NACHNAME' => '',
      'STRASSE' => 'Gläubigerplatz 1',
      'VORNAME' => '',
      'LETZTER_VORGANG' => '3D',
      'PLZ' => '99999',
      'GLAEUBIGER_ID' => '01234',
      'AKTEN_IN_DATEN' => '1',
      'FIRMENNAME' => 'Max Mustermann AG',
      'LAND' => 'DE',
      'ANREDE' => 'Firma',
      'AKTEN_ANZAHL' => '10',
      'RECHTSFORM' => 'AG',
      'DUNS_NBR' => '00-000-0001'
    }
  ],
  'PAGES' => {
       'MAXIMAL' => '10',
       'START' => '1',
       'END' => '10'
     },
  'DATEN' => [
       {
 'ORT' => 'Schuldnerdorf',
 'UEBERGABE_DATUM' => '2011-07-15',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '840.63',
 'STATUS' => 'VORGERICHTLICH',
 'AKTUELLE_HF' => '711.83',
 'INKASSO_AZ' => '110015671',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Frank Bacher',
 'INKASSO_ID' => '590002565239',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Schuldnerort',
 'UEBERGABE_DATUM' => '2011-07-15',
 'AMPEL' => 'R',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '661.43',
 'STATUS' => 'VORGERICHTLICH',
 'AKTUELLE_HF' => '661.43',
 'INKASSO_AZ' => '110155138',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Alexander Zaubert',
 'INKASSO_ID' => '590002452638',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Karl-Marx-Stadt',
 'UEBERGABE_DATUM' => '2011-01-28',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '1663.10',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '1663.10',
 'INKASSO_AZ' => '110132456',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Herta Schinger',
 'INKASSO_ID' => '590003423298',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Gerastadt',
 'UEBERGABE_DATUM' => '2011-01-25',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '767.30',
 'STATUS' => 'GERICHTLICH',
 'AKTUELLE_HF' => '611.19',
 'INKASSO_AZ' => '110551209',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Marcel Seibel',
 'INKASSO_ID' => '590002328155',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Hauptstadt Berlin',
 'UEBERGABE_DATUM' => '2010-12-30',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '1542.92',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '1369.65',
 'INKASSO_AZ' => '105573633',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Ralf Pfund',
 'INKASSO_ID' => '590002308656',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'München',
 'UEBERGABE_DATUM' => '2010-06-25',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '1133.63',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '1133.63',
 'INKASSO_AZ' => '102785671',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Adrian Halo',
 'INKASSO_ID' => '590001841300',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Schuldnerstadt',
 'UEBERGABE_DATUM' => '2010-03-31',
 'AMPEL' => 'R',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '695.40',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '695.40',
 'INKASSO_AZ' => '100015203',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Kerstin Meier Obst- u.Naturladen',
 'INKASSO_ID' => '590000000000',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Ossidorf',
 'UEBERGABE_DATUM' => '2009-10-20',
 'AMPEL' => 'G',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '1040.62',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '427.14',
 'INKASSO_AZ' => '090225674',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Ossi Dumpfbacke',
 'INKASSO_ID' => '590000268300',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Wunderland',
 'UEBERGABE_DATUM' => '2009-08-04',
 'AMPEL' => 'R',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '1344.08',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '1344.08',
 'INKASSO_AZ' => '090155078',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Wessi Schlaupi',
 'INKASSO_ID' => '590000375100',
 'OFFENE_FRAGEN' => '0'
       },
       {
 'ORT' => 'Rügen',
 'UEBERGABE_DATUM' => '2009-08-04',
 'AMPEL' => 'Y',
 'CLIENT_REF' => '',
 'UEBERGEB_HF' => '354.40',
 'STATUS' => 'NACHGERICHTLICH',
 'AKTUELLE_HF' => '224.87',
 'INKASSO_AZ' => '090136069',
 'GLAEUBIGER_ID' => '01234',
 'LAND' => 'DE',
 'SCHULDNER' => 'Andrea Melzer',
 'INKASSO_ID' => '59000329600',
 'OFFENE_FRAGEN' => '0'
       }
     ]
};
Sprung zum Anfang