Release Notes Public API 1.3

Swagger Dokumentation

• Die aktuelle Swagger Dokumentation finden Sie hier:
  https://app.paychexplus.de/publicapi/v1.3/

Geplante Änderungen

• Neuer Endpunkt: 

  • /companies/{company_uid}/tax-data/

• Zusätzliche Adressfelder: 

  • /companies/{company_uid}/employing-companies/{uid}/:

• Zusätzliche Validierung:

  • /companies/{company_uid}/employees/{employee_uid}/salary-components/
    Es erfolgt eine Überprüfung und Fehlermeldung, wenn die Freigrenze für den Sachbezug überschritten wird (analog zur Frontend). 

2026-04-24

• Fehlerbehebung Geldbetrag: 

  • Im Endpunkt /companies/{company_uid}/employees/{employee_uid}/absence/,  
    Anfrageklasse  MaternityLeaceAbsenceRequest ,
    Feld net_of_other_employments
    wurde bisher der Betrag falsch in Euro übermitttelt. 
    Richtig ist aber (wie alle bei allen Geldbeträgen) Eurocent. 
    Dies wurde nun auf Eurocent umgestellt.
     

• Umbenennung der Billing Transaction Beschreibung

  • Im Endpunkt /companies/{company_uid}/billing/,
    Anfrageklasse transaction_description
    wurden die Beschreibungen von "Paychex Plus" auf "Paychex Europe Payroll" geändert.
     

• Änderungen in der Dokumenten Kategorie UV Jahresmeldungen

  • Alt:

    • UV Jahresmeldungen (mit Personalbezug) (ohne Personalbezug) 

  • Neu:

    • UV Jahresmeldungen (mit Personalbezug) (ohne Personalbezug) 

    • UV Jahresmeldungen gesamt (ohne Personalbezug) 

  • Hinweis zu einem Breaking Change in der nächsten API Version: 
    Ab der nächsten API Version wird UV Jahresmeldungen nur noch mit Personalbezug nutzbar sein. Für Dokumente ohne Personalbezug muss dann UV Jahresmeldungen gesamt genutzt werden.
     

  • Änderungen in der Dokumenten Kategorie Lohnkonten

    • Alt:

      • Lohnkonten (mit Personalbezug) (ohne Personalbezug) 

    • Neu:

      • Lohnkonten (mit Personalbezug) (ohne Personalbezug) 

      • Lohnkonten gesamt (ohne Personalbezug) 

    • Hinweis zu einem Breaking Change in der nächsten API Version: 
      Ab der nächsten API Version wird Lohnkonten nur noch mit Personalbezug nutzbar sein. Für Dokumente ohne Personalbezug muss dann Lohnkonten gesamt genutzt werden.
       

    • Änderungen in der Dokumenten Kategorie Sonstige Auswertungen

      • Alt:

        • Sonstige Auswertungen (mit Personalbezug) (ohne Personalbezug) 

      • Neu:

        • Sonstige Auswertungen (mit Personalbezug) (ohne Personalbezug) 

        • Sonstige Auswertungen gesamt (ohne Personalbezug) 

      • Hinweis zu einem Breaking Change in der nächsten API Version: 
        Ab der nächsten API Version wird Sonstige Auswertungen nur noch mit Personalbezug nutzbar sein. Für Dokumente ohne Personalbezug muss dann Sonstige Auswertungen gesamt genutzt werden.
         

    • Änderungen in der Dokumenten Kategorie Bescheinigungen

      • Alt:

        • Bescheinigungen (mit Personalbezug) 

      • Neu:

        • Bescheinigungen (mit Personalbezug) 

        • Bescheinigungen gesamt (ohne Personalbezug) 
           

2026-01-30

• Die Personalnummer wird auf maximal 9 Zeichen begrenzt.

  • Im Frontend ist die Personalnummer auf 9 Zeichen begrenzt. Dies wurde in den beiden Endpunkten 
    - PUT /companies/{company_uid}/employees/{employee_uid}/contract/
    - PATCH /companies/{company_uid}/employees/{employee_uid}/contract/
    nun ebenfalls eingeführt

• Die Personalnummer muss innerhalb einer Firma eindeutig sein.

  • Im Frontend gibt es bereits die Validierung, dass eine Personalnummer innerhalb einer Firma eindeutig ist. Dies wurde nun im Endpunkt
    - /companies/{company_uid}/employees/{employee_uid}/contract/
    ebenfalls eingeführt.

2025-11-03

• Erstellung der Version 1.3 der Public API

  • Die Versionierung von den API-Schnittstellen gewährleistet Stabilität und unterstützt eine klare Struktur für die Integration und Nutzung durch externe Nutzer. Durch die Versionierung wird sichergestellt, dass bestehende Integrationen und Anwendungen weiterhin mit der API arbeiten können, auch wenn neue Funktionen oder Änderungen hinzugefügt werden.

  • Wir empfehlen die Umstellung und Nutzung dieser Version 1.3