Über dieses Handbuch
Zusammenfassung
Mit der Direct Deposit-Anwendungsprogrammierschnittstelle (API) kann Ihre Anwendung das Direct Deposit-Setup eines Mitarbeiters verwalten.
Was ist neu in diesem Handbuch?
In diesem Abschnitt werden wir alle neuen Überarbeitungen der Direct Deposit API und dieses Handbuchs ankündigen.
April 2020
Die folgenden Informationen wurden in diesem Handbuch überarbeitet:
- In Kapitel 2 – Anwendungsfall: Abrufen der direkten Einzahlung eines Mitarbeiters Im Antwortabschnitt wurde ein Testfall mit GitHub-Links für einen Mitarbeiter mit mehreren Positionen hinzugefügt.
- In Kapitel 3 – Anwendungsfall: Aktualisieren der direkten Einzahlung eines Mitarbeiters wurden im Antwortabschnitt die folgenden Testfälle mit GitHub-Links hinzugefügt:
- Eine direkte Einzahlung mit dem Status Inaktiv hinzugefügt.
- Aktualisiert einen direkten Einzahlungsstatus von Inaktiv zu Aktiv.
- Aktualisiert einen direkten Einzahlungsstatus von Aktiv auf Inaktiv.
- Es wurde eine direkte Einzahlung für eine nicht primäre Position hinzugefügt.
- Aktualisiert eine direkte Einzahlung für eine nicht-primäre Position.
- Aktualisiert die Anfrage und Antwort für die unten
- In Kapitel 3 – Anwendungsfall: Aktualisieren der Direkteinzahlung eines Mitarbeiters wurde im Antwortabschnitt eine Direkteinzahlung hinzugefügt, wenn ein Verteilungsbetrag leer ist.
- In Kapitel 6 – Bekannte Probleme und Einschränkungen wurden die folgenden bekannten Probleme und Einschränkungen entfernt, da Verbesserungen vorgenommen wurden:
- US1293781: API gibt eine 200-Antwort aus, wenn ein leerer Datensatz für einen Verteilungsbetrag übergeben wird
- US1331908: Falsche Ressource im Meta für Prenote-Optionscode
- US1331919: Fehlende Validierung für benutzerdefiniertes Prenote-Datumsfeld
- US1221928: Aktivieren einer inaktiven Direkteinzahlung
Unterstützte Produktversion und Kundenstamm
Die Direct Deposit API ist für ADP Workforce Now-Kunden in den USA und Kanada mit Payroll-Funktionen verfügbar.
Process Overview
Typical B2B Application Integration Flow
|
|
Actor |
Task Description |
|---|---|---|
|
1 |
Payroll Practitioner |
Setup Direct Deposit konten in ADP Workforce Jetzt. |
|
2 |
Ihre Anwendung |
Verwenden Sie die Worker Management API, um Mitarbeiterdaten zwischen ADP Workforce Now und Ihrer Anwendung. |
|
3 |
Payroll Practitioner |
Wählen Sie in Ihrer Anwendung einen Mitarbeiter aus und eine Aktion zum Anzeigen direkter Einzahlungen. |
|
4 |
Ihre Anwendung |
Verwenden Sie die Direct Deposit API, um Direct Deposit setup-Daten für den ausgewählten Mitarbeiter. |
|
5 |
Payroll Practitioner |
Zeigen Sie in Ihrer Anwendung die Daten hinterlegen. |
|
6 |
Payroll Practitioner |
Aktualisieren Sie in Ihrer Anwendung die Daten hinterlegen. |
|
7 |
Ihre Anwendung |
Verwenden Sie die Direct Deposit API, um Direct Deposit setup-Daten für den ausgewählten Mitarbeiter. |
Nach erfolgreicher Lohn- und Gehaltsabrechnung verteilt ADP automatisch Geld vom Lohn des Mitarbeiters auf sein Direkteinzahlungskonto gemäß der Direkteinzahlungskonfiguration.
Typical B2C Application Integration Flow
|
|
Actor |
Task Description |
|---|---|---|
|
1 |
User |
Login to your application. |
|
2 |
Benutzer |
Authentifizieren Sie sich mit dem vom Arbeitgeber ausgestellten ADP anmeldeinformationen und Zustimmung, damit Ihre Anwendung die von ADP verwalteten Direkteinzahlungsdaten der Person für diesen Arbeitgeber abrufen kann. |
|
3 |
Ihre Anwendung |
Verwenden Sie die Direct Deposit API, um die * Direkte Einzahlung Setup-Daten. |
|
4 |
User |
In your application, view Direct Deposit setup data. |
|
5 |
User |
In your application, update Direct Deposit setup data. |
|
6 |
Ihre Anwendung |
Verwenden Sie die Direct Deposit API, um Direct Deposit setup-Daten für den Benutzer unter dem Arbeitgeber. |
Nach erfolgreicher Lohn- und Gehaltsabrechnung verteilt ADP automatisch Geld vom Lohn des Mitarbeiters auf sein Direkteinzahlungskonto gemäß der Direkteinzahlungskonfiguration.
Erforderliche Einrichtungsschritte
In ADP Workforce Now ist die direkte Einzahlung eine Art Abzug. Die Direct Deposit API unterstützt alle von Kunden konfigurierten Direct Deposit Codes. Kunden müssen sicherstellen, dass die von Ihrer Anwendung verwendeten Codes in der Benutzeroberfläche von ADP Workforce Now hinzugefügt und konfiguriert werden, indem sie Setup > Tools > Validierungstabellen > Payroll > Abzüge und Einzahlungen > Einlagen.
Postman Collection
Mit Postman können Sie eine Sammlung von APIs importieren, die von anderen erstellt wurden, damit Sie sie ausprobieren können. Weitere Informationen zu Postman finden Sie unter Erstellen Ihres ersten API-Aufrufs mit Postman.
Um API-Sammlungen für die Worker Management API aus der ADP GitHub-Bibliothek herunterzuladen und in Postman zu importieren, gehen Sie zu:
Direct Deposit API Collection.
Über Direct Deposit
Direct Deposit ist eine Bankfunktion, mit der Ihre Mitarbeiter ihre gesamten Gehaltsschecks oder einen Teil ihrer Gehaltsschecks automatisch auf ein oder mehrere Bankkonten einzahlen können. Zum Beispiel Konten wie Ersparnisse, Schecks, Geldmärkte, IRAs und andere. Das Setup eines Unternehmens steuert, wie viele direkte Einzahlungen für einen Mitarbeiter konfiguriert werden können. Zum Beispiel kann das Setup eines Unternehmens es Mitarbeitern ermöglichen, bis zu drei direkte Einzahlungen oder bis zu 500 direkte Einzahlungen hinzuzufügen.
Über Prenotification
Prenotification (oder Prenote) ist, wenn eine Bank neue direkte Einlagenkonten testet, bevor tatsächliche Einlagen getätigt werden. Dies soll sicherstellen, dass die Gelder auf das richtige Konto eingezahlt werden. Prenote dauert in der Regel 10 Tage. Während der Prenote benachrichtigt die Bank den Arbeitgeber, wenn eine ungültige Routing-Nummer oder Kontonummer verwendet wurde. Die Mitarbeiter erhalten während der Prenote weiterhin einen verhandelbaren (Live-) Gehaltsscheck. Nach Prenote werden direkte Einzahlungen automatisch vorgenommen. Aufgrund des Prenote-Prozesses benötigen Änderungen an einer Direkteinzahlung normalerweise ein oder zwei Abrechnungszyklen, um ausgeführt zu werden.
Wenn die Bankinformationen eines Mitarbeiters aktualisiert werden, wird prenote neu gestartet, normalerweise für fünf Tage. Der Mitarbeiter erhält in dieser Zeit einen verhandelbaren Gehaltsscheck.
In ADP Workforce Jetzt kann ein Client konfigurieren prenote für die direkte Einzahlung. Nach der Konfiguration kann ein Benutzer auswählen, ob die Prenote mit einer der folgenden Optionen ausgeführt werden soll:
- Company Default – Verwenden Sie das Standard-Prenote-Enddatum Ihres Unternehmens.
- No Prenote – Überspringen Sie Prenote und machen Sie die direkte Einzahlung so schnell wie möglich.
- Benutzerdefiniert – Wählen Sie ein Enddatum aus dem Kalender aus.
Die Option prenote ist nur für die angeforderten Clients aktiviert. Wenden Sie sich an ADP, um die Prenote-Option für einen bestimmten Client zu aktivieren.
Leave a Reply