Dokumentation Websuite Ressourcen
Was ist die Websuite Ressourcen ?
Eine vollständige allgemeine Beschreibung finden Sie auf der Produktseite der Web-Ressourcen-Suite.
Wie sende ich die Dokumente?
Akzeptierte Formate
Das akzeptierte Format ist PDF.
Anzahl der Dateien pro Aufruf
Die Anzahl der akzeptierten Dateien hängt vom Dokumenttyp ab:
– französische Einkommensteuer: nur 1 Datei
– Gehaltsabrechnung Beamte FR: 1 Datei
– Zahlungsbescheinigung CAF FR: mehrere Dateien
Web-Oberfläche
Zentrales Element der Suite, die Web-Oberfläche ermöglicht Ihnen:
– Details Ihres Abonnements einsehen
– Verbleibende Überprüfungen pro Abonnement anzeigen
– Auf die Historie Ihrer API-Aufrufe zugreifen
– JSON- und XML-Berichte jedes Aufrufs herunterladen
– Entsprechende Daten löschen
Verfügbare Sprachen
Die Web-Oberfläche ist in folgenden Sprachen verfügbar:
– Französisch
– Englisch
Reiter Abonnements
Auf der Startseite der Web-Oberfläche finden Sie Ihre Abonnements mit folgenden Informationen:
– Tarifart (PRO, BUSINESS, CORPORATE oder SINGLE_PAYMENT)
– Abrechnungszeitraum (monatlich oder jährlich, nicht verfügbar für SINGLE_PAYMENT)
– Aktives Abonnement: Ist Ihr Abonnement aktiv oder nicht
– Verlängerungs- bzw. Enddatum des Abonnements
– Verbleibende Überprüfungen: Anzahl der verbleibenden Überprüfungen für Ihr Abonnement im Zeitraum
Reiter Ressourcen
Der Reiter „Ressourcen“ (zugänglich, wenn ein Ressourcen-Abonnement aktiv ist) ermöglicht Ihnen Zugriff auf verschiedene Informationen und Werkzeuge.
Verlauf
Die API-Aufrufhistorie ermöglicht Ihnen die vollständige Historie aller vorgenommenen Aufrufe mit folgenden Informationen:
- Datum der Analyse
- Verifizierter Dokumenttyp
- Herunterladen des Berichts im PDF-/JSON-/XML-Format
- Löschen der Analyse und der zugehörigen Daten
Tool „Dokument prüfen“
Mit dem Tool „Dokument prüfen“ können Sie Dokumente direkt über die Web-Oberfläche zur Prüfung einreichen.
Die Anzahl der Dateien pro Einreichung variiert je nach Dokumenttyp:
- Einkommensteuerbescheid: 1 Datei
- Gehaltsabrechnung für Beamte: 1 Datei
- CAF-Zahlungsbescheinigung: mehrere Dateien
Die Ergebnisse stehen anschließend im Verlauf zur Verfügung und können als PDF-, JSON- oder XML-Bericht heruntergeladen werden.
Mögliche Fehler
Dokument nicht erkannt
Dieser Fehler bedeutet, dass das Dokument nicht erkannt werden konnte.
Bitte prüfen Sie:
- Ist das Format gemäß Dokumentation?
- Handelt es sich um einen unterstützten Dokumenttyp?
- Ist das Dokument gut lesbar?
Keine Credits mehr verfügbar
Dieser Fehler weist darauf hin, dass keine Credits mehr verfügbar sind.
Sie müssen dann ein neues Abonnement abschließen oder zusätzliche Prüfungen per Einmalzahlung erwerben.
Prüfungen pro Dokumenttyp
Nachfolgend finden Sie die Liste und Beschreibung der verschiedenen Felder und Prüfungen für jeden mit unseren Produkten unterstützten Ausweisdokumenttyp.
Einkommensteuerbescheid
Einkommensteuerbescheid
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentInfos | – | – |
| publicationDate | String | Veröffentlichungsdatum (kann null sein) |
| signatureDate | String | Unterschriftsdatum des Dokuments |
| taxableIncomeReference | String | Steuerlicher Referenzbetrag |
| sharesNumber | String | Anzahl der Steueranteile |
| noticeReference | String | Mitteilungsreferenz |
| incomeYear | String | Jahr der Einkünfte |
| declarant1 | String | Erklärender 1 |
| taxNumberDeclarant1 | String | Steuernummer Erklärender 1 |
| declarant2 | String | Erklärender 2 |
| taxNumberDeclarant2 | String | Steuernummer Erklärender 2 |
| collectionDate | String | Zahlungsdatum |
| certificate | – | – |
| validityStartDate | String | Gültigkeitsbeginn des digitalen Zertifikats |
| validityEndDate | String | Gültigkeitsende des digitalen Zertifikats |
| issuerReference | String | Ausstellerreferenz des Zertifikats |
| issuerName | String | Name des Zertifikatausstellers |
| subjectReference | String | Subjektreferenz des Zertifikats |
| issuer | String | Aussteller des Zertifikats |
| datesConsistency | Boolean | Konsistenz von Zertifikats- und Dokumentdaten? |
| digitalSignature | Boolean | Ist die digitale Signatur gültig? |
Gehaltsabrechnung für Beamte
Gehaltsabrechnung für Beamte
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentInfos | – | – |
| fullName | String | Vollständiger Name des Empfängers |
| employerSiret | String | SIRET der Behörde |
| periodStartDate | String | Beginn des Abrechnungszeitraums |
| periodEndDate | String | Ende des Abrechnungszeitraums |
| contractStartDate | Array | Vertragsbeginn (sofern vorhanden) |
| netTaxableSalary | String | Netto-Monatsgehalt |
| netTaxableAccumulatedSalary | String | Jahresnetto kumuliert |
| certificate | – | – |
| validityStartDate | String | Beginn der Zertifikatsgültigkeit |
| validityEndDate | String | Ende der Zertifikatsgültigkeit |
| issuerReference | String | Ausstellerreferenz des Zertifikats |
| issuerName | String | Name des Zertifikatausstellers |
| subjectReference | String | Subjektreferenz des Zertifikats |
| issuer | String | Aussteller des Zertifikats |
| datesConsistency | Boolean | Konsistenz von Zertifikats- und Dokumentdaten? |
| digitalSignature | Boolean | Ist die digitale Signatur gültig? |
CAF-Zahlungsnachweis (einzelne Datei)
CAF-Zahlungsnachweis (einzelne Datei)
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentInfos | – | – |
| documentDate | String | Dokumentdatum |
| dateOfBirth | String | Geburtsdatum des Empfängers |
| numberOfPages | String | Anzahl der Seiten |
| beneficiaryNumberHeader | String | Leistungsnummer in der Kopfzeile |
| dateHourFooter | String | Datum und Uhrzeit in der Fußzeile |
| barcodeNumber | String | Nummer unter dem Barcode |
| barcodeNumberDecoded | String | Dekodierte Barcode-Nummer |
| documentInfosValidation | – | – |
| datesHeaderFooterValid | Boolean | Übereinstimmung Kopf-/Fußzeilen-Datum? |
| beneficiaryNumberHeaderFooterValid | Boolean | Nummer Kopf-/Fußzeile konsistent? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Konsistenz Leistungsnummer vs. Barcode? |
| barcodeNumberBarcodeValid | Boolean | Barcode vs. dekodierte Nummer übereinstimmend? |
| datesHeaderMetasValid | Boolean | Übereinstimmung Kopfzeile vs. Metadaten-Datum? |
| datesFooterMetasValid | Boolean | Übereinstimmung Fußzeile vs. Metadaten-Datum? |
CAF-Zahlungsnachweis (mehrere Dateien)
CAF-Zahlungsnachweis (mehrere Dateien)
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentInfos | – | – |
| documentDate | String | Dokumentdatum |
| dateOfBirth | String | Geburtsdatum des Empfängers |
| numberOfPages | String | Anzahl der Seiten |
| beneficiaryNumberHeader | String | Leistungsnummer in der Kopfzeile |
| dateHourFooter | String | Datum und Uhrzeit in der Fußzeile |
| barcodeNumber | String | Nummer unter dem Barcode |
| barcodeNumberDecoded | String | Dekodierte Barcode-Nummer |
| documentInfosValidation | – | – |
| datesHeaderFooterValid | Boolean | Übereinstimmung Kopf-/Fußzeilen-Datum? |
| beneficiaryNumberHeaderFooterValid | Boolean | Konsistenz Leistungsnummer Kopf-/Fußzeile? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Konsistenz Leistungsnummer vs. Barcode? |
| barcodeNumberBarcodeValid | Boolean | Barcode vs. dekodierte Nummer übereinstimmend? |
| datesHeaderMetasValid | Boolean | Übereinstimmung Kopfzeile vs. Metadaten-Datum? |
| datesFooterMetasValid | Boolean | Übereinstimmung Fußzeile vs. Metadaten-Datum? |
| documentsValidation | – | – |
| datesOfBirthValid | Boolean | Geburtsdaten zwischen Dateien konsistent? |
| datesHeaderFooterValid | Boolean | Kopf-/Fußzeilanwendungen konsistent? |
| beneficiaryNumberHeaderFooterValid | Boolean | Leistungsnummern Kopf-/Fußzeile konsistent? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Leistungsnummer vs. Barcode konsistent? |
| barcodeNumberBarcodeValid | Boolean | Barcode vs. dekodierte Nummer konsistent? |
| datesHeaderMetasValid | Boolean | Kopfzeile vs. Metadaten konsistent? |
| datesFooterMetasValid | Boolean | Fußzeile vs. Metadaten konsistent? |
| modificationDateMetasValid | Boolean | Metadaten-Änderungsdatum null? |
CAF-Zahlungsnachweis (mehrere Dateien)
CAF-Zahlungsnachweis (mehrere Dateien)
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentInfos | – | – |
| documentDate | String | Dokumentdatum |
| dateOfBirth | String | Geburtsdatum des Empfängers |
| numberOfPages | String | Anzahl der Seiten der Datei |
| beneficiaryNumberHeader | String | Leistungsnummer in der Kopfzeile |
| dateHourFooter | String | Datum und Uhrzeit in der Fußzeile |
| barcodeNumber | String | Nummer unter dem Barcode |
| barcodeNumberDecoded | String | Dekodierte Barcode-Nummer |
| documentInfosValidation | – | – |
| datesHeaderFooterValid | Boolean | Sind Kopf- und Fußzeilendaten konsistent? |
| beneficiaryNumberHeaderFooterValid | Boolean | Ist die Leistungsnummer zwischen Kopf- und Fußzeile konsistent? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Übereinstimmung Leistungsnummer und Barcode? |
| barcodeNumberBarcodeValid | Boolean | Barcode und dekodierte Nummer übereinstimmend? |
| datesHeaderMetasValid | Boolean | Sind Kopfzeilendatum und Metadatendatum konsistent? |
| datesFooterMetasValid | Boolean | Sind Fußzeilendatum und Metadatendatum konsistent? |
| documentsValidation | – | – |
| datesOfBirthValid | Boolean | Sind alle Geburtsdaten über die Dateien hinweg konsistent? |
| datesHeaderFooterValid | Boolean | Sind Kopf- und Fußzeilendaten über die Dateien hinweg konsistent? |
| beneficiaryNumberHeaderFooterValid | Boolean | Sind Leistungsnummern Kopf-/Fußzeile über die Dateien hinweg konsistent? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Ist die Leistungsnummer vs. Barcode über die Dateien hinweg konsistent? |
| barcodeNumberBarcodeValid | Boolean | Sind Barcode und dekodierte Nummer über die Dateien hinweg konsistent? |
| datesHeaderMetasValid | Boolean | Sind Kopfzeile vs. Metadaten über die Dateien hinweg konsistent? |
| datesFooterMetasValid | Boolean | Sind Fußzeile vs. Metadaten über die Dateien hinweg konsistent? |
| modificationDateMetasValid | Boolean | Ist das Änderungsdatum der PDF-Metadaten leer? |