Freigeben über


intelliHR (Vorschau)

intelliHR ist eine cloudbasierte Personenverwaltungsplattform mit erweiterten Analysefunktionen. Stellen Sie eine Verbindung mit Ihrem intelliHR-Mandanten her, um personenorientierte Workflows (z. B. Onboarding) und Datenexporte zu automatisieren.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Kundensupport
URL https://intellihr.zendesk.com/hc/en-us
Email support@intellihr.co
Connectormetadaten
Herausgeber intelliHR
Webseite https://www.intellihr.com
Datenschutzrichtlinie https://intellihr.co/privacy-policy/
Kategorien Personalabteilung; Business Intelligence

intelliHR ist eine benutzerfreundliche Personalverwaltungs- und Analyseplattform für zentrales Leistungsmanagement, Mitarbeiterbindung, zentrale Personalprozesse und HR-Analysen an einem zentralen Ort. Erstellen Sie geplante Aufgaben und automatisierte Workflows mit Ihren Personendaten in Power Automate, Office 365, SharePoint, Microsoft Dynamics 365 und anderen Diensten ohne Code mit dem IntelliHR-Connector.

Voraussetzungen

Um diesen Connector verwenden zu können, müssen Sie über einen intelliHR-Mandanten verfügen. Wenn ein Mandant für Ihre Gruppe oder Organisation bereitgestellt werden soll, besuchen Sie diese Seite.

So erhalten Sie Anmeldeinformationen

Zum Konfigurieren des Connectors benötigen Sie einen API-Schlüssel und Ihren Mandantennamen.

Ihr Mandantname entspricht Ihrer Kontounterdomäne (z. B. https://this-is-your-tenant-name.intellihr.net).

So erstellen Sie einen API-Schlüssel:

  1. Melden Sie sich mit einem Administratorkonto bei Ihrem Mandanten an.
  2. Navigieren zur Seite "Einstellungen"
  3. Suchen Sie nach "API", und klicken Sie auf "Öffentliche API-Zugriffsschlüssel".
  4. Folgen Sie den Anweisungen auf dieser Seite, um einen Schlüssel zu erstellen.

Sie finden auch die richtige Schnittstelle unter https://your-tenant.intellihr.net/spa/settings/access-keys

Erste Schritte mit Ihrem Connector

Beim Hinzufügen des IntelliHR-Connectors werden Sie aufgefordert, Ihren Mandantennamen und DEN API-Schlüssel sowie einen Anzeigenamen für die Verbindung einzugeben.

Wichtig: Stellen Sie beim Eingeben des API-Schlüssels sicher, dass sie dem Schlüssel "Bearer" vorangestellt wird, sodass die Eingabe "Bearer xyz123" lauten sollte. Wenn Dies nicht der Fehler ist, führt dies zu Fehlern des ungültigen API-Schlüssels.

Bekannte Probleme und Einschränkungen

Der IntelliHR-Connector ist eine Übersetzung der öffentlichen INTELLIHR-API und erbt die gleichen Einschränkungen und erfordert die gleiche Überprüfung auf Anforderungen.

Häufige Fehler und Abhilfemaßnahmen

Da der IntelliHR-Connector Anforderungen an die öffentliche API von IntelliHR übergibt, können die meisten Probleme durch Verweisen auf die dokumentation der öffentlichen API problematisch sein.

Wenn ein Teil der Anforderung unangemessen ist, wird ein 400-Bereichsfehler zurückgegeben, der von einer Meldung begleitet wird, die das Problem beschreibt. Das häufigste Problem besteht darin, dass der Connector ohne "Bearer" in der API-Schlüsseleingabe konfiguriert wurde.

Eine Verbindung wird erstellt

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für diese API, dem "Bearer" vorangestellt Richtig
Tenant Schnur Ihr intelliHR-Mandantname Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Aktualisieren einer Geschäftseinheit nach ID

Gibt die aktualisierte Geschäftseinheit zurück.

Aktualisieren einer Person nach ID

Aktualisieren einer Person

Aktualisieren eines Dokuments anhand der ID

Aktualisieren eines Dokuments

Aktualisieren eines Schulungsdatensatzes nach ID

Aktualisieren eines Schulungsdatensatzes

Alle Arbeitsklassen auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitsklassen zurück.

Alle Arbeitsrechte auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitsrechte zurück.

Alle Arbeitstypen auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitstypen zurück.

Alle Aufträge auflisten

Gibt eine Liste aller Auftragsentitätseinträge ab dem aktuellen Datum zurück.

Alle Geschäftseinheiten auflisten

Gibt eine Liste aller im System aufgezeichneten Geschäftseinheiten zurück.

Alle Geschäftsentitäten auflisten

Gibt eine Liste aller Geschäftsentitäten zurück.

Alle Personen auflisten

Gibt eine Liste aller Personen am aktuellen Datum zurück.

Alle Schulungen auflisten

Gibt eine Liste aller Schulungsdatensätze zurück.

Alle Schulungsanbieter auflisten

Gibt eine Liste aller Schulungsanbieter zurück.

Alle Schulungstypen auflisten

Gibt eine Liste aller Schulungstypen zurück.

Alle Speicherorte auflisten

Gibt eine Liste aller Speicherorte zurück.

Alle Standardvergütungskomponenten auflisten

Gibt eine Liste aller im System erfassten Standardvergütungskomponenten zurück.

Auflisten aller benutzerdefinierten Felddefinitionen

Gibt eine Liste aller benutzerdefinierten Felddefinitionen zurück.

Auflisten aller Beschäftigungsbedingungen

Gibt eine Liste aller Beschäftigungsbedingungen zurück.

Auflisten aller Lohnnoten

Gibt eine Liste aller Lohnnoten zurück.

Auflisten aller Rekrutierungsquellen

Gibt eine Liste aller Einstellungsquellen zurück.

Erstellen einer neuen Geschäftseinheit

Gibt die erstellte Geschäftseinheit zurück.

Erstellen einer vorsignierten Upload-URL

Erstellen einer vorsignierten Upload-URL

Erstellen eines neuen Auftrags

Erstellen Sie einen neuen Auftragsdatensatz mit den bereitgestellten Daten.

Erstellen eines neuen Personendatensatzes

Erstellen einer Person

Erstellen eines Schulungsdatensatzes

Erstellen eines neuen Schulungsdatensatzes

Festlegen des Enddatums für einen Auftrag

Festlegen des Enddatums für einen Auftrag

Löschen einer Geschäftseinheit nach ID

Löschen Sie eine Geschäftseinheit anhand der angegebenen ID.

Löschen eines Schulungsdatensatzes nach ID

Löscht den bereitgestellten Schulungsdatensatz.

Löschen eines Webhooks nach ID

Löscht den bereitgestellten Webhook.

Patchen eines vorhandenen Auftrags

Patchattribute eines vorhandenen Auftragsdatensatzes mit den bereitgestellten Daten.

Suchen einer Arbeit direkt nach ID

Gibt eine einzelne Arbeit rechts zurück.

Suchen einer Arbeitsklasse nach ID

Gibt eine einzelne Arbeitsklasse zurück.

Suchen einer benutzerdefinierten Felddefinition nach ID

Gibt eine einzelne benutzerdefinierte Felddefinition zurück.

Suchen einer Beschäftigungsbedingung nach ID

Gibt eine einzelne Beschäftigungsbedingung zurück.

Suchen einer Geschäftseinheit nach ID

Gibt eine einzelne Geschäftseinheit zurück.

Suchen einer Geschäftsentität nach ID

Gibt eine einzelne Geschäftsentität anhand des Bezeichners zurück.

Suchen einer Pay Grade nach ID

Gibt eine einzelne Lohnnote zurück.

Suchen einer Person nach ID

Rufen Sie einen einzelnen Personendatensatz anhand des UUIDv4-Bezeichners ab.

Suchen einer Rekrutierungsquelle nach ID

Gibt eine einzelne Rekrutierungsquelle zurück.

Suchen einer Standardvergütungskomponente nach ID

Gibt eine einzelne Standardvergütungskomponente zurück.

Suchen eines Arbeitstyps nach ID

Gibt einen einzelnen Arbeitstyp zurück.

Suchen eines Auftrags nach ID

Rufen Sie einen einzelnen Auftragsdatensatz anhand des UUIDv4-Bezeichners ab.

Suchen eines Schulungsanbieters nach ID

Gibt einen einzelnen Schulungsanbieter zurück.

Suchen eines Schulungsdatensatzes nach ID

Gibt einen einzelnen Schulungsdatensatz zurück.

Suchen eines Schulungstyps nach ID

Gibt einen einzelnen Schulungstyp zurück.

Suchen eines Speicherorts nach ID

Gibt eine einzelne Position zurück.

Suchen eines Webhook-Ereignisses nach ID

Gibt ein einzelnes Webhook-Ereignis zurück.

Suchen eines Webhooks nach ID

Gibt einen einzelnen Webhook zurück.

UpdateAWebhook

Patchen eines Webhooks

Aktualisieren einer Geschäftseinheit nach ID

Gibt die aktualisierte Geschäftseinheit zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Geschäftseinheit
id True string

Die Zeichenfolge des Ressourcenbezeichners

identifier
identifier string

Optionaler Bezeichner, der für administrative Aufgaben verwendet werden kann.

name
name True string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

Notizen
notes string

An eine Geschäftseinheit angefügte Notizen

parentId
parentId string

Die Bezeichnerzeichenfolge für die übergeordnete Geschäftseinheit oder NULL, wenn kein übergeordnetes Element vorhanden ist (dies ist eine Geschäftseinheit der obersten Ebene).

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Geschäftseinheit in Dropdowns auswählen können.

Gibt zurück

Antwort
Response

Aktualisieren einer Person nach ID

Aktualisieren einer Person

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Personendatensatzes
id True string

Die Zeichenfolge des Ressourcenbezeichners

Vorname
firstName string

Vorname der Person .

MiddleName
middleName string

Der zweite Vorname der Person .

lastName
lastName string

Der Nachname der Person .

preferredName
preferredName string

Der bevorzugte Name der Person . Kann in der Regel von Mitarbeitern selbst konfiguriert werden.

dateOfBirth
dateOfBirth string

Geburtsdatum (JJJJ-MM-DD).

gender
gender string

Menschlichen lesbare Zeichenfolge für das Geschlecht der Person , z. B. Male. Die Suche erfolgt ohne Beachtung der Groß-/Kleinschreibung und "beginnt mit" z. B. die Übergabe male mit einem Geschlecht namens "Männlich" wie "m" oder "M". Wenn mehrere Geschlechter übereinstimmen, wird der erste ausgewählt.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

title
title string

Der Titel, der auf diese Person verweist, z. B. "Herr". Dies ist null, wenn sie nicht angegeben wird und die Groß-/Kleinschreibung nicht beachtet wird.

name
name string

Der Name des Notfallkontakts.

Beziehung
relationship string

Die Beziehung, die dieser Notfallkontakt mit der Person hat.

phone
phone string

Telefonnummer des Notfallkontakts.

E-Mail
email string

E-Mail des Notfallkontakts.

E-Mail
email string

Die E-Mail-Adresse, die dieser Person zugeordnet ist.

isPersonal
isPersonal boolean

Gibt an, ob es sich bei dieser E-Mail um persönliche oder geschäftliche E-Mails handelt.

isPrimär
isPrimary boolean

Gibt an, ob es sich bei dieser E-Mail um die primäre Kontakt-E-Mail handelt.

number
number string

Die Telefonnummer. Diese Zahl kann einer Vorwahl vorangestellt werden. In diesem Fall versucht das System automatisch, das Herkunftsland für die Telefonnummer zu ermitteln.

isPersonal
isPersonal boolean

Gibt an, ob es sich bei diesem Telefon um eine persönliche oder geschäftliche Telefonnummer handelt.

isPrimär
isPrimary boolean

Gibt an, ob es sich bei diesem Telefon um die primäre Kontaktnummer handelt.

addressType
addressType string

Enumeration: Home, Postal. Der Adresstyp.

fullAddress
fullAddress string

Die vollständige lesbare Adresse, abzüglich der Postleitzahl und des Landes

country
country string

Das Land, in dem sich die Adresse befindet.

Postleitzahl
postcode string

Die Postleitzahl der Adresse.

Staat
state string

Der Zustand, in dem sich die Adresse befindet. Dies ist australienspezifisch und kann nicht immer bereitgestellt werden.

Straße
street string

Die Straße, auf der sich die Adresse befindet. Dies ist australienspezifisch und kann nicht immer bereitgestellt werden.

Vorort
suburb string

Der Vorort, in dem sich die Adresse befindet. Dies ist australienspezifisch und kann nicht immer bereitgestellt werden.

customFields
customFields object

Die Werte des benutzerdefinierten Felds für diese Person

id
id string

Die Id-Zeichenfolge für das Arbeitsrecht , zu dem diese Person gehört.

name
name string

Der Name des Arbeitsrechts.

workRightExpiryDate
workRightExpiryDate string

Das Datum, an dem dieses Arbeitsrecht für diese Person abläuft (JJJJ-MM-DD).

Gibt zurück

Einzelperson
SinglePerson

Aktualisieren eines Dokuments anhand der ID

Aktualisieren eines Dokuments

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Dokuments
id True string

Die Zeichenfolge des Ressourcenbezeichners

personId
personId True string

Die Id-Zeichenfolge für die Person , zu der dieses Dokument gehört.

uploadStatus
uploadStatus True string

Der Uploadstatus dieses Dokuments. Enumeration: SUCCESS, PENDING, FAILED.

Gibt zurück

PatchaPersonDocument
PatchaPersonDocument

Aktualisieren eines Schulungsdatensatzes nach ID

Aktualisieren eines Schulungsdatensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Schulungsdatensatzes
id True string

Die Zeichenfolge des Ressourcenbezeichners

id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

FertigstellungDatum
completionDate string

Der Zeitstempel der Schulung wurde abgeschlossen. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

kosten
cost string

Die Kosten für diese Schulung.

Währung
currency string

Die währung, die für diese Schulung verwendet wird. Standardmäßig wird die Standardwährung des Mandanten verwendet, wenn sie nicht angegeben wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

Stunden
hours string

Wie viele Stunden für diese Schulung aufgewendet wurden

id
id string

Die Bezeichnerzeichenfolge für den Auftrag , für den diese Schulung abgeschlossen wurde.

name
name string

Benutzerfreundlicher Name, der dieser Schulung zugewiesen wird, um ihn im System zu identifizieren.

id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

id
id string

Die Id-Zeichenfolge für den Schulungsanbieter der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungsanbieter der Schulung zugewiesen wird.

id
id string

Die Bezeichnerzeichenfolge für den Schulungstyp der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungstyp der Schulung zugewiesen wird.

customFields
customFields

Die Werte des benutzerdefinierten Felds für diese Schulung

Gibt zurück

SingleTraining
SingleTraining

Alle Arbeitsklassen auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitsklassen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListWorkClasses
ListWorkClasses

Alle Arbeitsrechte auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitsrechte zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofWorkRights
ListofWorkRights

Alle Arbeitstypen auflisten

Gibt eine Liste aller im System aufgezeichneten Arbeitstypen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListWorkTypes
ListWorkTypes

Alle Aufträge auflisten

Gibt eine Liste aller Auftragsentitätseinträge ab dem aktuellen Datum zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Filter, die auf die Abfrage angewendet werden sollen
filters string

Filter können in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten einzuschränken. Filter werden im Format filters[<filter_name>][<operation_type>]=<filter_value>bereitgestellt. Ein Filter zum Abrufen von Elementen, die einer bestimmten ID entsprechen, wäre filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9beispielsweise .

Sortierreihenfolge, die auf die Abfrage angewendet werden soll
sort string

Die Sortierung kann in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten zu sortieren. Die Sortierung kann mit einem Minus versehen werden, um die Daten in absteigender Reihenfolge (-) zurückzugeben. Beispielsweise wäre -createdAteine Sortierung, um die neuesten Datensätze zuerst abzurufen.

Gibt zurück

ListJobs
ListJobs

Alle Geschäftseinheiten auflisten

Gibt eine Liste aller im System aufgezeichneten Geschäftseinheiten zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofBusinessUnits
ListofBusinessUnits

Alle Geschäftsentitäten auflisten

Gibt eine Liste aller Geschäftsentitäten zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofBusinessEntities
ListofBusinessEntities

Alle Personen auflisten

Gibt eine Liste aller Personen am aktuellen Datum zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Filter, die auf die Abfrage angewendet werden sollen
filters string

Filter können in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten einzuschränken. Filter werden im Format filters[<filter_name>][<operation_type>]=<filter_value>bereitgestellt. Ein Filter zum Abrufen von Elementen, die einer bestimmten ID entsprechen, wäre filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9beispielsweise .

Sortierreihenfolge, die auf die Abfrage angewendet werden soll
sort string

Die Sortierung kann in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten zu sortieren. Die Sortierung kann mit einem Minus versehen werden, um die Daten in absteigender Reihenfolge (-) zurückzugeben. Beispielsweise wäre -createdAteine Sortierung, um die neuesten Datensätze zuerst abzurufen.

Gibt zurück

ListPeople
ListPeople

Alle Schulungen auflisten

Gibt eine Liste aller Schulungsdatensätze zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Filter, die auf die Abfrage angewendet werden sollen
filters string

Filter können in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten einzuschränken. Filter werden im Format filters[<filter_name>][<operation_type>]=<filter_value>bereitgestellt. Ein Filter zum Abrufen von Elementen, die einer bestimmten ID entsprechen, wäre filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9beispielsweise .

Sortierreihenfolge, die auf die Abfrage angewendet werden soll
sort string

Die Sortierung kann in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten zu sortieren. Die Sortierung kann mit einem Minus versehen werden, um die Daten in absteigender Reihenfolge (-) zurückzugeben. Beispielsweise wäre -createdAteine Sortierung, um die neuesten Datensätze zuerst abzurufen.

Gibt zurück

ListofTrainings
ListofTrainings

Alle Schulungsanbieter auflisten

Gibt eine Liste aller Schulungsanbieter zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListallTrainingProviders
ListallTrainingProviders

Alle Schulungstypen auflisten

Gibt eine Liste aller Schulungstypen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListallTrainingTypes
ListallTrainingTypes

Alle Speicherorte auflisten

Gibt eine Liste aller Speicherorte zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

Listlocations
Listlocations

Alle Standardvergütungskomponenten auflisten

Gibt eine Liste aller im System erfassten Standardvergütungskomponenten zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofDefaultRemunerationComponents
ListofDefaultRemunerationComponents

Auflisten aller benutzerdefinierten Felddefinitionen

Gibt eine Liste aller benutzerdefinierten Felddefinitionen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Filter, die auf die Abfrage angewendet werden sollen
filters string

Filter können in der Abfragezeichenfolge angewendet werden, um die von diesem Endpunkt zurückgegebenen Daten einzuschränken. Filter werden im Format filters[<filter_name>][<operation_type>]=<filter_value>bereitgestellt. Ein Filter zum Abrufen von Elementen, die einer bestimmten ID entsprechen, wäre filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9beispielsweise .

Gibt zurück

ListofCustomFieldDefinitions
ListofCustomFieldDefinitions

Auflisten aller Beschäftigungsbedingungen

Gibt eine Liste aller Beschäftigungsbedingungen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofEmploymentConditions
ListofEmploymentConditions

Auflisten aller Lohnnoten

Gibt eine Liste aller Lohnnoten zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofPayGrades
ListofPayGrades

Auflisten aller Rekrutierungsquellen

Gibt eine Liste aller Einstellungsquellen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Anzahl der Elemente pro Seite
limit integer

Die Anzahl der Elemente pro Seite

Die Seitenzahl
page integer

Die Seitenzahl

Gibt zurück

ListofRecruitmentSources
ListofRecruitmentSources

Erstellen einer neuen Geschäftseinheit

Gibt die erstellte Geschäftseinheit zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
identifier
identifier string

Optionaler Bezeichner, der für administrative Aufgaben verwendet werden kann.

name
name True string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

Notizen
notes string

An eine Geschäftseinheit angefügte Notizen

parentId
parentId string

Die Bezeichnerzeichenfolge für die übergeordnete Geschäftseinheit oder NULL, wenn kein übergeordnetes Element vorhanden ist (dies ist eine Geschäftseinheit der obersten Ebene).

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Geschäftseinheit in Dropdowns auswählen können.

Gibt zurück

Antwort
Response

Erstellen einer vorsignierten Upload-URL

Erstellen einer vorsignierten Upload-URL

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

filename
filename True string

Der ursprüngliche Dateiname des Dokuments. Dies wird für den Anzeigenamen verwendet. Umfasst die Erweiterung.

Mime-Kunst
mime True string

Der MIME-Typ des Dokuments

size
size True integer

Die geschätzte Größe des Dokuments in Byte

Erweiterung
extension True string

Die Erweiterung des Dokuments, nicht einschließlich des Punkts

Gibt zurück

SinglePersonDocument
SinglePersonDocument

Erstellen eines neuen Auftrags

Erstellen Sie einen neuen Auftragsdatensatz mit den bereitgestellten Daten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

companyStartDate
companyStartDate True string

Das Datum, an dem dieser Auftrag begonnen hat oder innerhalb der Organisation beginnt. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

companyEndDate
companyEndDate string

Das Datum, an dem dieser Auftrag endet oder innerhalb der Organisation endet. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

name
name True string

Der zu erstellende Auftragsname

id
id string

Die Id-Zeichenfolge für die Geschäftsentität , zu der dieser Auftrag gehört.

name
name string

Name, der dieser Geschäftsentität zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

legalName
legalName string

Juristischer Name der Geschäftsentität. Wird in der Regel für Administrative Aufgaben verwendet.

number
number string

Rechtlich registrierte Geschäftsentitätsnummer , z. B. in Australien, kann dies der ABN oder in Amerika die RN sein.

id
id string

Die Id-Zeichenfolge für die Geschäftseinheit , zu der dieser Auftrag gehört.

name
name string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

id
id string

Die Zeichenfolge des Bezeichners für den Auftrag desSupervisors.

name
name string

Der Name/positionstitel des Vorgesetzten.

id
id string

Die Id-Zeichenfolge für den Speicherort.

name
name string

Name, der diesem Speicherort zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

address
address string

Die Adresse dieses Speicherorts.

id
id string

Die Id-Zeichenfolge für die Arbeitsklasse , zu der dieser Auftrag gehört.

name
name string

Der Name der Arbeitsklasse.

id
id string

Die Bezeichnerzeichenfolge für den Arbeitstyp , zu dem dieser Auftrag gehört.

name
name string

Der Name des Arbeitstyps. Enumeration: Permanent, , Fixed Contract, UnpaidTemporary/Casual, . Independent Contract

fte
fte string

Das Vollzeitäquivalent dieses Auftrags. Gibt die Arbeitsauslastung eines Mitarbeiters an, der in verschiedenen Kontexten vergleichbar sein kann. Dies ist null für Personen ohne FTE.

id
id string

Die Id-Zeichenfolge für die Pay Grade.

Code
code string

Administrativer, kurzer Code, der der Pay Grade zugeordnet ist.

name
name string

Benutzerfreundlicher Name, der der Pay Grade zugewiesen wird.

type
type string

Die Methode, in der dieser Vergütungsplan gezahlt wird. Enumeration: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

Der Zyklus, für den der Job bezahlt wird. Enumeration: Weekly, Fortnightly, Monthly.

Währung
currency string

Die Währung, in der die Basis und die Summen, in denen dieser Auftrag gezahlt wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Beschäftigungsbedingung dieses Vergütungszeitplans.

name
name string

Name, der dieser Beschäftigungsbedingung zugewiesen wird.

awardName
awardName string

Der Preisname kann sich von dem Namen unterscheiden, der einem Benutzer präsentiert wird. Wird in der Regel für den rechtlichen Namen des Preises verwendet.

hoursPerCycle
hoursPerCycle True double

Wie viele Stunden pro payCycle gearbeitet haben.

BaseAnnualSalary
baseAnnualSalary double

Das jahresbezahlte Basisgehalt ist nur erforderlich, wenn der Vergütungsplantyp "Jahresgehalt" lautet.

baseHourlyRate
baseHourlyRate double

Der Stundensatz, der stundenweise bezahlt wird, ist dies nur erforderlich, wenn der Vergütungsplantyp "Stündliche Rate" lautet.

name
name True string

Der Name dieser Ergänzung.

type
type True string

Wie diese Addition berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Standardvergütungskomponente.

name
name string

Name der Standardvergütungskomponente.

name
name True string

Der Name dieser Ergänzung.

type
type True string

Wie diese Addition berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

name
name True string

Der Name dieser Aufschlüsselungen.

type
type True string

Wie diese Aufschlüsselung berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Aufschlüsselung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Standardvergütungskomponente.

name
name string

Name der Standardvergütungskomponente.

id
id string

Die Id-Zeichenfolge für die Rekrutierungsquelle.

name
name string

Der Name, der dieser Rekrutierungsquelle gegeben wird.

kosten
cost double

Die Kosten für die Einstellung.

Währung
currency string

Die Währung, die zum Rekrutieren dieses Auftrags verwendet wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

Gibt zurück

SingleJob
SingleJob

Erstellen eines neuen Personendatensatzes

Erstellen einer Person

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorname
firstName string

Vorname der Person .

MiddleName
middleName string

Der zweite Vorname der Person .

lastName
lastName True string

Der Nachname der Person .

preferredName
preferredName string

Der bevorzugte Name der Person . Kann in der Regel von Mitarbeitern selbst konfiguriert werden.

dateOfBirth
dateOfBirth string

Geburtsdatum (JJJJ-MM-DD).

gender
gender string

Menschlichen lesbare Zeichenfolge für das Geschlecht der Person , z. B. Male. Die Suche erfolgt ohne Beachtung der Groß-/Kleinschreibung und "beginnt mit" z. B. die Übergabe male mit einem Geschlecht namens "Männlich" wie "m" oder "M". Wenn mehrere Geschlechter übereinstimmen, wird der erste ausgewählt.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

title
title string

Der Titel, der auf diese Person verweist, z. B. "Herr". Dies ist null, wenn sie nicht angegeben wird und die Groß-/Kleinschreibung nicht beachtet wird.

name
name string

Der Name des Notfallkontakts.

Beziehung
relationship string

Die Beziehung, die dieser Notfallkontakt mit der Person hat.

phone
phone string

Telefonnummer des Notfallkontakts.

E-Mail
email string

E-Mail des Notfallkontakts.

E-Mail
email string

Die tatsächliche E-Mail-Adresse.

isPersonal
isPersonal boolean

Gibt an, ob es sich bei dieser E-Mail um persönliche oder geschäftliche E-Mails handelt.

number
number string

Die tatsächliche Telefonnummer. Diese Zahl kann einer Vorwahl vorangestellt werden. In diesem Fall versucht das System automatisch, das Herkunftsland für die Telefonnummer zu ermitteln.

isPersonal
isPersonal boolean

Gibt an, ob es sich bei diesem Telefon um eine persönliche oder geschäftliche Telefonnummer handelt.

customFields
customFields object

Die Werte des benutzerdefinierten Felds für diese Person

id
id string

Die Id-Zeichenfolge für das Arbeitsrecht , zu dem diese Person gehört.

name
name string

Der Name des Arbeitsrechts.

workRightExpiryDate
workRightExpiryDate string

Das Datum, an dem dieses Arbeitsrecht für diese Person abläuft (JJJJ-MM-DD).

Gibt zurück

Einzelperson
SinglePerson

Erstellen eines Schulungsdatensatzes

Erstellen eines neuen Schulungsdatensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

FertigstellungDatum
completionDate True string

Der Zeitstempel der Schulung wurde abgeschlossen. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

kosten
cost string

Die Kosten für diese Schulung.

Währung
currency string

Die währung, die für diese Schulung verwendet wird. Standardmäßig wird die Standardwährung des Mandanten verwendet, wenn sie nicht angegeben wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

Stunden
hours string

Wie viele Stunden für diese Schulung aufgewendet wurden

id
id string

Die Bezeichnerzeichenfolge für den Auftrag , für den diese Schulung abgeschlossen wurde.

name
name True string

Benutzerfreundlicher Name, der dieser Schulung zugewiesen wird, um ihn im System zu identifizieren.

id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

id
id string

Die Id-Zeichenfolge für den Schulungsanbieter der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungsanbieter der Schulung zugewiesen wird.

id
id string

Die Bezeichnerzeichenfolge für den Schulungstyp der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungstyp der Schulung zugewiesen wird.

customFields
customFields

Die Werte des benutzerdefinierten Felds für diese Schulung

Gibt zurück

SingleTraining
SingleTraining

Festlegen des Enddatums für einen Auftrag

Festlegen des Enddatums für einen Auftrag

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Auftrags bis zum Ende
id True string

Die ID des Auftrags bis zum Ende

Enddatum
endDate True string

Enddatum

turnoverType
turnoverType True string

turnoverType

umsatzReason
turnoverReason string

umsatzReason

Gibt zurück

SingleJob
SingleJob

Löschen einer Geschäftseinheit nach ID

Löschen Sie eine Geschäftseinheit anhand der angegebenen ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Geschäftseinheit
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

response
string

Löschen eines Schulungsdatensatzes nach ID

Löscht den bereitgestellten Schulungsdatensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Schulungsdatensatzes
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

response
string

Löschen eines Webhooks nach ID

Löscht den bereitgestellten Webhook.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Webhooks
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

response
string

Patchen eines vorhandenen Auftrags

Patchattribute eines vorhandenen Auftragsdatensatzes mit den bereitgestellten Daten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Auftrags
id True string

Die Zeichenfolge des Ressourcenbezeichners

effectiveFrom
effectiveFrom True string

Das Datum, an dem dieses Auftragsupdate innerhalb der Organisation wirksam wird. Beachten Sie, dass sich dies nicht auf den Anfangstermin des Gesamtauftrags selbst auswirkt. Ein null Wert gibt an, dass dieses Update ab dem Anfang des Auftrags wirksam ist. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

effectiveTo
effectiveTo string

Das Datum, an dem dieses Auftragsupdate innerhalb der Organisation wirksam ist. Beachten Sie, dass sich dies nicht auf das Enddatum des Gesamtauftrags selbst auswirkt. Dieses Datum folgt dem von RFC3339 definierten Format.

YYYY-MM-DD Datumsformatierung wird ebenfalls unterstützt, obwohl mit diesem Format das Datum als Anfang des Tages in UTC-Zeit gespeichert wird, nicht die anfordernde Mandantenzeitzone.

name
name string

Der Auftragsname, der aktualisiert werden soll

id
id string

Die Id-Zeichenfolge für die Geschäftsentität , zu der dieser Auftrag gehört.

name
name string

Name, der dieser Geschäftsentität zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

legalName
legalName string

Juristischer Name der Geschäftsentität. Wird in der Regel für Administrative Aufgaben verwendet.

number
number string

Rechtlich registrierte Geschäftsentitätsnummer , z. B. in Australien, kann dies der ABN oder in Amerika die RN sein.

id
id string

Die Id-Zeichenfolge für die Geschäftseinheit , zu der dieser Auftrag gehört.

name
name string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

id
id string

Die Id-Zeichenfolge für die Person , die im System gefunden werden soll.

name
name string

Der Name der Person in intelliHR, nach der gesucht werden soll. Beachten Sie, dass die Suchkonten bei Unterschieden in der Namensreihenfolge automatisch auftreten.

primäreE-Mail-Adresse
primaryEmailAddress string

Die E-Mail-Adresse, die als primär für die Person im System gekennzeichnet ist.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId string

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

id
id string

Die Zeichenfolge des Bezeichners für den Auftrag desSupervisors.

name
name string

Der Name/positionstitel des Vorgesetzten.

id
id string

Die Id-Zeichenfolge für den Speicherort.

name
name string

Name, der diesem Speicherort zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

address
address string

Die Adresse dieses Speicherorts.

id
id string

Die Id-Zeichenfolge für die Arbeitsklasse , zu der dieser Auftrag gehört.

name
name string

Der Name der Arbeitsklasse.

id
id string

Die Bezeichnerzeichenfolge für den Arbeitstyp , zu dem dieser Auftrag gehört.

name
name string

Der Name des Arbeitstyps. Enumeration: Permanent, , Fixed Contract, UnpaidTemporary/Casual, . Independent Contract

fte
fte string

Das Vollzeitäquivalent dieses Auftrags. Gibt die Arbeitsauslastung eines Mitarbeiters an, der in verschiedenen Kontexten vergleichbar sein kann. Dies ist null für Personen ohne FTE.

id
id string

Die Id-Zeichenfolge für die Pay Grade.

Code
code string

Administrativer, kurzer Code, der der Pay Grade zugeordnet ist.

name
name string

Benutzerfreundlicher Name, der der Pay Grade zugewiesen wird.

type
type string

Die Methode, in der dieser Vergütungsplan gezahlt wird. Enumeration: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

Der Zyklus, für den der Job bezahlt wird. Enumeration: Weekly, Fortnightly, Monthly.

Währung
currency string

Die Währung, in der die Basis und die Summen, in denen dieser Auftrag gezahlt wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Beschäftigungsbedingung dieses Vergütungszeitplans.

name
name string

Name, der dieser Beschäftigungsbedingung zugewiesen wird.

awardName
awardName string

Der Preisname kann sich von dem Namen unterscheiden, der einem Benutzer präsentiert wird. Wird in der Regel für den rechtlichen Namen des Preises verwendet.

hoursPerCycle
hoursPerCycle True double

Wie viele Stunden pro payCycle gearbeitet haben.

BaseAnnualSalary
baseAnnualSalary double

Das jahresbezahlte Basisgehalt ist nur erforderlich, wenn der Vergütungsplantyp "Jahresgehalt" lautet.

baseHourlyRate
baseHourlyRate double

Der Stundensatz, der stundenweise bezahlt wird, ist dies nur erforderlich, wenn der Vergütungsplantyp "Stündliche Rate" lautet.

name
name True string

Der Name dieser Ergänzung.

type
type True string

Wie diese Addition berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Standardvergütungskomponente.

name
name string

Name der Standardvergütungskomponente.

name
name True string

Der Name dieser Ergänzung.

type
type True string

Wie diese Addition berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

name
name True string

Der Name dieser Aufschlüsselungen.

type
type True string

Wie diese Aufschlüsselung berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann der Summe hinzugefügt, während FixedAmount direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value True string

Bei MultipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während bei festem Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Aufschlüsselung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

id
id string

Die Bezeichnerzeichenfolge für die Standardvergütungskomponente.

name
name string

Name der Standardvergütungskomponente.

Gibt zurück

SingleJob
SingleJob

Suchen einer Arbeit direkt nach ID

Gibt eine einzelne Arbeit rechts zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Arbeitsrechts
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleWorkRight
SingleWorkRight

Suchen einer Arbeitsklasse nach ID

Gibt eine einzelne Arbeitsklasse zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Arbeitsklasse
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleWorkClass
SingleWorkClass

Suchen einer benutzerdefinierten Felddefinition nach ID

Gibt eine einzelne benutzerdefinierte Felddefinition zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des benutzerdefinierten Felds
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleCustomFieldDefinition
SingleCustomFieldDefinition

Suchen einer Beschäftigungsbedingung nach ID

Gibt eine einzelne Beschäftigungsbedingung zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Beschäftigungsbedingungs-ID
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleEmploymentCondition
SingleEmploymentCondition

Suchen einer Geschäftseinheit nach ID

Gibt eine einzelne Geschäftseinheit zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Geschäftseinheit
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

Antwort
Response

Suchen einer Geschäftsentität nach ID

Gibt eine einzelne Geschäftsentität anhand des Bezeichners zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Zeichenfolge des Ressourcenbezeichners
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleBusinessEntity
SingleBusinessEntity

Suchen einer Pay Grade nach ID

Gibt eine einzelne Lohnnote zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Lohnnote
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SinglePayGrade
SinglePayGrade

Suchen einer Person nach ID

Rufen Sie einen einzelnen Personendatensatz anhand des UUIDv4-Bezeichners ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Personendatensatzes
id True string

Die ID des Personendatensatzes

Gibt zurück

Einzelperson
SinglePerson

Suchen einer Rekrutierungsquelle nach ID

Gibt eine einzelne Rekrutierungsquelle zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Rekrutierungsquelle
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleRecruitmentSource
SingleRecruitmentSource

Suchen einer Standardvergütungskomponente nach ID

Gibt eine einzelne Standardvergütungskomponente zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Vergütungskomponenten-ID
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleDefaultRemunerationComponent
SingleDefaultRemunerationComponent

Suchen eines Arbeitstyps nach ID

Gibt einen einzelnen Arbeitstyp zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Arbeitstyps
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleWorkType
SingleWorkType

Suchen eines Auftrags nach ID

Rufen Sie einen einzelnen Auftragsdatensatz anhand des UUIDv4-Bezeichners ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Auftrags, der zurückgegeben werden soll
id True string

Die Zeichenfolge des Ressourcenbezeichners

Genaues Zurückgeben von Daten für den Auftrag an diesem Datum
asAt string

Wird verwendet, um zu konfigurieren, für welches Datum diese Auftragsdaten zurückgegeben werden sollen, als RFC3339 Datetime.

Alle von den Auftragsendpunkten zurückgegebenen Daten stellen die Werte der Auftragsattribute der Person zu einem bestimmten Zeitpunkt dar.

Standardmäßig wird die aktuelle Datetime verwendet, aber dieser Parameter kann verwendet werden, um eine andere Datumszeit zu konfigurieren, um historische Daten anzuzeigen.

Gibt zurück

SingleJob
SingleJob

Suchen eines Schulungsanbieters nach ID

Gibt einen einzelnen Schulungsanbieter zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Schulungsanbieters
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleTrainingProvider
SingleTrainingProvider

Suchen eines Schulungsdatensatzes nach ID

Gibt einen einzelnen Schulungsdatensatz zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Schulungsdatensatzes
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleTraining
SingleTraining

Suchen eines Schulungstyps nach ID

Gibt einen einzelnen Schulungstyp zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die Schulungstyp-ID
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleTrainingTypes
SingleTrainingTypes

Suchen eines Speicherorts nach ID

Gibt eine einzelne Position zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Speicherorts
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleLocation
SingleLocation

Suchen eines Webhook-Ereignisses nach ID

Gibt ein einzelnes Webhook-Ereignis zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Webhook-Ereignisses
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

Single Webhook-Ereignis.

Webhook-Ereignisse
webhook-events

Suchen eines Webhooks nach ID

Gibt einen einzelnen Webhook zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Webhooks
id True string

Die Zeichenfolge des Ressourcenbezeichners

Gibt zurück

SingleWebhook
SingleWebhook

UpdateAWebhook

Patchen eines Webhooks

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID des Webhooks
id True string

Die Zeichenfolge des Ressourcenbezeichners

URL
url string

Der Webhook-Endpunkt , an den die Anforderung gesendet wird, wenn das abonnierte Webhook-Ereignis ausgelöst wird.

webhookEvent
webhookEvent string

Der Strich des Webhook-Ereignisses.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diesen Webhook auswählen können. Wenn dieser Webhook deaktiviert ist, wird dieser Webhook nicht gesendet.

source
source string

Eine anpassbare Zeichenfolge, die verwendet werden kann, um zu identifizieren, welches System diesen Webhook erstellt hat. Webhooks , die über die intelliHR-Anwendung erstellt wurden, weisen die Quelle "custom" auf.

Gibt zurück

SingleWebhook
SingleWebhook

Auslöser

Erstellen eines Webhooks und Abonnieren eines Ereignistyps in Ihrem Mandanten

Erstellen eines Webhooks und Abonnieren eines Ereignistyps in Ihrem Mandanten

Erstellen eines Webhooks und Abonnieren eines Ereignistyps in Ihrem Mandanten

Erstellen eines Webhooks und Abonnieren eines Ereignistyps in Ihrem Mandanten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
webhookEvent
webhookEvent True string

webhookEvent

isEnabled
isEnabled boolean

isEnabled

source
source string

source

Gibt zurück

Name Pfad Typ Beschreibung
id
id string

id

Ereignis
event string

Ereignis

Zeitstempel
timestamp string

Zeitstempel

selbst
links.self string

selbst

Definitionen

SingleBusinessEntity

Name Pfad Typ Beschreibung
BusinessEntity
data BusinessEntity

ListofBusinessEntities

Name Pfad Typ Beschreibung
Daten
data array of BusinessEntity
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

Antwort

Name Pfad Typ Beschreibung
BusinessUnit3
data BusinessUnit3
Meta1
meta Meta1

Enthält verschiedene Metainformationen zur Antwort.

ListofBusinessUnits

Name Pfad Typ Beschreibung
Daten
data array of BusinessUnit3
Meta2
meta Meta2

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleCustomFieldDefinition

Name Pfad Typ Beschreibung
CustomFieldDefinition
data CustomFieldDefinition

ListofCustomFieldDefinitions

Name Pfad Typ Beschreibung
Daten
data array of CustomFieldDefinition
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleDefaultRemunerationComponent

Name Pfad Typ Beschreibung
DefaultRemunerationComponent
data DefaultRemunerationComponent

ListofDefaultRemunerationComponents

Name Pfad Typ Beschreibung
Daten
data array of DefaultRemunerationComponent
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleEmploymentCondition

Name Pfad Typ Beschreibung
EmploymentCondition
data EmploymentCondition

ListofEmploymentConditions

Name Pfad Typ Beschreibung
Daten
data array of EmploymentCondition
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleJob

Name Pfad Typ Beschreibung
Meta1
meta Meta1

Enthält verschiedene Metainformationen zur Antwort.

Beruf
data Job

ListJobs

Name Pfad Typ Beschreibung
Daten
data array of Job
Meta8
meta Meta8

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleLocation

Name Pfad Typ Beschreibung
location5
data location5

Listlocations

Name Pfad Typ Beschreibung
Daten
data array of location5
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SinglePayGrade

Name Pfad Typ Beschreibung
payGrade5
data payGrade5

ListofPayGrades

Name Pfad Typ Beschreibung
Daten
data array of payGrade5
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

ListPeople

Name Pfad Typ Beschreibung
Daten
data array of data1
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

Einzelperson

Name Pfad Typ Beschreibung
Data1
data data1

SinglePersonDocument

Name Pfad Typ Beschreibung
Data3
data Data3

PatchaPersonDocument

Name Pfad Typ Beschreibung
Data4
data Data4

SingleRecruitmentSource

Name Pfad Typ Beschreibung
recruitmentSource
data recruitmentSource

ListofRecruitmentSources

Name Pfad Typ Beschreibung
Daten
data array of recruitmentSource

Details zur Einstellungsquelle.

Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleTrainingProvider

Name Pfad Typ Beschreibung
trainingProviders
data trainingProviders

ListallTrainingProviders

Name Pfad Typ Beschreibung
Daten
data array of trainingProviders
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleTraining

Name Pfad Typ Beschreibung
Ausbildung
data Training

ListofTrainings

Name Pfad Typ Beschreibung
Daten
data array of Training
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleTrainingTypes

Name Pfad Typ Beschreibung
trainingTypes
data trainingTypes

ListallTrainingTypes

Name Pfad Typ Beschreibung
Daten
data array of trainingTypes
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleWorkClass

Name Pfad Typ Beschreibung
WorkClassesSchema
data WorkClassesSchema

ListWorkClasses

Name Pfad Typ Beschreibung
Daten
data array of WorkClassesSchema
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleWorkRight

Name Pfad Typ Beschreibung
WorkRight2
data WorkRight2

ListofWorkRights

Name Pfad Typ Beschreibung
Daten
data array of WorkRight2
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

SingleWorkType

Name Pfad Typ Beschreibung
workType4
data workType4

ListWorkTypes

Name Pfad Typ Beschreibung
Daten
data array of workType4
Meta
meta Meta

Enthält verschiedene Metainformationen zur Antwort.

Links
links Links

Links zu anderen verwandten Ressourcen.

Webhook-Ereignisse

Single Webhook-Ereignis.

Name Pfad Typ Beschreibung
Daten5
data Data5

SingleWebhook

Name Pfad Typ Beschreibung
Data7
data Data7

Ergänzung

Name Pfad Typ Beschreibung
name
name string

Der Name dieser Ergänzung.

type
type string

Wie diese Addition berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann dem Gesamtwert hinzugefügt, während der Festbetrag direkt zur Summe hinzugefügt wird. Enumeration: MultipleOfBase, FixedAmount.

value
value double

Bei multipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während dies für fixen Betrag der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

AdditionsToTotal

Name Pfad Typ Beschreibung
name
name string

Der Name dieser Gesamtzugabe.

type
type string

Wie diese Gesamtzugabe berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann dem Gesamtwert hinzugefügt, während der Festbetrag direkt zum Gesamtwert addiert wird. Enumeration: MultipleOfBase, FixedAmount.

value
value double

Bei multipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während dies für fixen Betrag der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

Adresse

Name Pfad Typ Beschreibung
addressType
addressType string

Der Adresstyp.

fullAddress
fullAddress string

Die vollständige Adresse.

country
country string

Das Land der Adresse.

Postleitzahl
postcode string

Die Postleitzahl für die Adresse.

Staat
state string

Das Bundesland der Adresse.

Straße
street string

Die Straße, auf der sich die Adresse befindet.

Vorort
suburb string

Der Vorort der Adresse.

Panne

Name Pfad Typ Beschreibung
name
name string

Der Name dieser Ergänzung.

type
type string

Wie diese Ergänzung erfasst wird, wird nicht verwendet, um das Gesamtpaket im Gegensatz zu anderen Vergütungskomponenten zu berechnen. Enumeration: MultipleOfBase, FixedAmount.

value
value double

Bei multipleOfBase ist dies der Multiplizierer (z. B. 9 = 9%), während dies für fixen Betrag der Betrag ist, der direkt zur Summe addiert werden soll.

Währung
currency string

Die für diese Ergänzung verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

BusinessEntity

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Geschäftsentität.

name
name string

Name, der dieser Geschäftsentität zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

legalName
legalName string

Der name kann sich von dem Namen unterscheiden, der einem Benutzer angezeigt wird. Wird in der Regel für Administrative Aufgaben verwendet.

number
number string

Rechtlich registrierte Geschäftsentitätsnummer , z. B. in Australien, kann dies der ABN oder in Amerika die RN sein.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Geschäftsentität in Dropdowns auswählen können.

BusinessUnit3

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Geschäftseinheit.

identifier
identifier string

Optionaler Bezeichner, der für administrative Aufgaben verwendet werden kann.

name
name string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

Notizen
notes string

An eine Geschäftseinheit angefügte Notizen

parentId
parentId string

Die Bezeichnerzeichenfolge für die übergeordnete Geschäftseinheit oder NULL, wenn kein übergeordnetes Element vorhanden ist (dies ist eine Geschäftseinheit der obersten Ebene).

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Geschäftseinheit in Dropdowns auswählen können.

BusinessEntity2

Die aktuelle Geschäftsentitätdes Auftrags im System.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Geschäftsentität dieses Auftrags.

name
name string

Name, der dieser Geschäftsentität zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

BusinessUnit4

Die aktuelle Geschäftseinheit des Auftrags im System.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Geschäftseinheit dieses Auftrags.

name
name string

Name, der dieser Geschäftseinheit zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Koordinator

Der Koordinator , der die Schulung durchführte. Diese Daten sind optional und werden null sein, wenn sie nicht gespeichert werden.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Koordinator der Schulung.

Anzeigename
displayName string

Der Name der Person , die das Training koordiniert hat.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId double

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

CustomFieldDefinition

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Definition des benutzerdefinierten Felds.

name
name string

Name, der dieser benutzerdefinierten Felddefinition zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

apiName
apiName string

Der api-Name, der dieser benutzerdefinierten Felddefinition zugewiesen wird. Dieser Name wird verwendet, um das benutzerdefinierte Feld in der API eindeutig zu identifizieren und wird beim Ändern des benutzerdefinierten Felds in einem Datensatz als Schlüssel verwendet.

Beschreibung
description string

Die Beschreibung dieser benutzerdefinierten Felddefinition. Dies wird als QuickInfo auf den Seiten zum Erstellen und Aktualisieren verwendet.

modelType
modelType string

Das Modell, mit dem sich dieses benutzerdefinierte Feld bezieht und an das es angefügt werden kann. Enumeration: TRAINING, PERSON.

type
type string

Der Datentyp, den dieses Feld erfasst. Enumeration: SINGLE_SELECT, , MULTI_SELECT, TEXTNUMBER, . PEOPLE_DROPDOWN

definitions
definitions object

Die Werte dieses Schlüssels ändern sich abhängig vom Schlüssel "typ". Es wird verwendet, um zusätzliche Informationen zu speichern, die für diesen Schlüssel relevant sind. Weitere Informationen zu benutzerdefinierten Feldkonfigurationen finden Sie in unserem Knowledge Base-Artikel zu benutzerdefinierten Feldern.

Data1

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person.

Anzeigename
displayName string

Name, der im gesamten System für diese Person angezeigt werden soll. Im Allgemeinen folgt das Muster preferredName (firstName) lastName, kann jedoch auf mandantenweiter Basis so konfiguriert werden, dass es sich um ein anderes Format handelt.

Vorname
firstName string

Vorname der Person .

MiddleName
middleName string

Der zweite Vorname der Person .

lastName
lastName string

Der Nachname der Person .

preferredName
preferredName string

Der bevorzugte Name der Person . Kann in der Regel von Mitarbeitern selbst konfiguriert werden.

dateOfBirth
dateOfBirth string

Geburtsdatum (JJJJ-MM-DD).

gender
gender string

Menschlichen lesbare Zeichenfolge für das Geschlecht der Person , z. B. Männlich.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId double

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

title
title string

Der Titel, der auf diese Person verweist, z. B. "Herr". Dies ist NULL, wenn nicht angegeben.

E-Mail-Adressen
emailAddresses array of EmailAddress

Ein Array von E-Mail-Adressen, die zu dieser Person gehören.

EmergencyContact
emergencyContact EmergencyContact

Die Details für den Notfallkontakt dieser Person .

employmentStatus
employmentStatus string

Der aktuelle Status dieser Personen innerhalb der Organisation. Enumeration: Current Staff, , Exiting Staff, No Job RecordsPast Staff, , . Returning StaffUpcoming Staff

jobs
jobs array of Job4

Ein Array einfacher Auftragseinträge , die dieser Person zugeordnet sind, in umgekehrter chronologischer Reihenfolge des Startdatums.

WorkRights
workRights WorkRights

Anzeigen der Arbeitsrechte der Person

PrimaryEmailAddress1
primaryEmailAddress PrimaryEmailAddress1

Informationen zur primären E-Mail-Adresse dieser Person oder null, wenn sie keine E-Mail-Informationen enthalten.

PrimaryPhoneNumber1
primaryPhoneNumber PrimaryPhoneNumber1

Informationen zur primären Telefonnummer dieser Person oder null, wenn sie keine Telefonnummern haben.

Adressen
addresses array of Address

Ein Array von Adressen, die zu dieser Person gehören.

Telefonnummern
phoneNumbers array of PhoneNumber

Ein Array von Telefonnummern, die zu dieser Person gehören.

ErstelltAm
createdAt string

Wann dieser Datensatz erstellt wurde. Dieses Datum folgt dem von RFC3339 definierten Format.

updatedAt
updatedAt string

Zeitpunkt der letzten Aktualisierung dieses Datensatzes. Dieses Datum folgt dem von RFC3339 definierten Format.

Data3

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für das Personendokument.

personId
personId string

Die Id-Zeichenfolge für die Person , zu der dieses Dokument gehört.

presignedUploadUrl
presignedUploadUrl string

Die vorsignierte Upload-URL, mit der Sie ein Personendokument auf S3 hochladen können. Dieser Link läuft 20 Minuten nach der Erstellung ab. Anweisungen zum Hochladen eines Objekts mit einer vorsignierten S3-URL finden Sie hier.

Data4

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für das Personendokument.

personId
personId string

Die Id-Zeichenfolge für die Person , zu der dieses Dokument gehört.

uploadStatus
uploadStatus string

Der Uploadstatus dieses Dokuments. Enumeration: SUCCESS, PENDING, FAILED.

Daten5

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für das Webhook-Ereignis.

name
name string

Der lesbare eindeutige Ereignisschlüssel für dieses Webhook-Ereignis.

Ereignis
event string

Der Strich des Webhook-Ereignisses.

examplePayload
examplePayload object

Ein Beispiel für die Nutzlast, die an Webhooks gesendet wird, die dieses bestimmte Webhook-Ereignis abonnieren.

Data7

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für den Webhook.

URL
url string

Der Webhook-Endpunkt , an den die Anforderung gesendet wird, wenn das abonnierte Webhook-Ereignis ausgelöst wird.

WebhookEvent
webhookEvent WebhookEvent

Das Webhook-Ereignis , das diesen Webhook ausgelöst hat.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diesen Webhook auswählen können. Wenn dieser Webhook deaktiviert ist, wird dieser Webhook nicht gesendet.

source
source string

Eine anpassbare Zeichenfolge, die verwendet werden kann, um zu identifizieren, welches System diesen Webhook erstellt hat. Webhooks , die über die intelliHR-Anwendung erstellt wurden, weisen die Quelle "custom" auf.

ErstelltAm
createdAt string

Wann dieser Datensatz erstellt wurde. Dieses Datum folgt dem von RFC3339 definierten Format.

updatedAt
updatedAt string

Zeitpunkt der letzten Aktualisierung dieses Datensatzes. Dieses Datum folgt dem von RFC3339 definierten Format.

Abzug

Name Pfad Typ Beschreibung
name
name string

Der Name dieses Abzugs.

type
type string

Wie dieser Abzug berechnet und auf den Basisbetrag angewendet wird, wird MultipleOfBase mit baseAnnualSalary multipliziert und dann von der Summe abgezogen, während der Festbetrag direkt von der Summe abgezogen wird. Enumeration: MultipleOfBase, FixedAmount.

value
value double

Bei multipleOfBase ist dies der Multiplizierer, während dies für festen Betrag der Betrag ist, der direkt von der Summe abgezogen werden soll.

Währung
currency string

Die währung, die für diesen Abzug verwendet wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

DefaultRemunerationComponent

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Standardvergütungskomponente.

name
name string

Name, der dieser Standardvergütungskomponente zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

value
value string

Der Wert dieser Vergütungskomponente. Bei multipleOfBase ist dies der Multiplizierer, während für festen Betrag dies der Betrag ist, der direkt zur Summe addiert werden soll.

isInUse
isInUse boolean

Ob diese Standardvergütungskomponente als Vergütungskomponenten verwendet wird.

automaticallyAddToJobs
automaticallyAddToJobs boolean

Ob diese Standardvergütungskomponente automatisch zu neu erstellten/aktualisierten Aufträgen hinzugefügt wird.

isEnabled
isEnabled boolean

Wenn diese Standardvergütungskomponente für die Verwendung im System aktiviert ist.

Währung
currency string

Die für diese Standardvergütungskomponente verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

type
type string

Die Art dieser Standardvergütungskomponente. Enumeration: AdditionToBase, , AdditionToTotalDeductionToBase, . Breakdown

valueType
valueType string

Die Art des Werts dieser Standardvergütungskomponente. Enumeration: MultipleOfBase, FixedAmount.

E-Mail-Adresse

Name Pfad Typ Beschreibung
E-Mail
email string

Die tatsächliche E-Mail-Adresse.

isPrimär
isPrimary boolean

Wenn es sich um eine primäre E-Mail-Adresse handelt.

isPersonal
isPersonal boolean

Wenn es sich um eine persönliche E-Mail-Adresse handelt.

EmergencyContact

Die Details für den Notfallkontakt dieser Person .

Name Pfad Typ Beschreibung
name
name string

Der Name des Notfallkontakts.

Beziehung
relationship string

Die Beziehung, die dieser Notfallkontakt mit der Person hat.

phone
phone string

Telefonnummer des Notfallkontakts.

E-Mail
email string

E-Mail des Notfallkontakts.

EmploymentCondition

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Beschäftigungsbedingung.

name
name string

Name, der dieser Beschäftigungsbedingung zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

awardName
awardName string

Der Preisname kann sich von dem Namen unterscheiden, der einem Benutzer präsentiert wird. Wird in der Regel für den rechtlichen Namen des Preises verwendet.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Beschäftigungsbedingung in Dropdowns auswählen können.

EmploymentCondition2

Die Beschäftigungsbedingung , unter der dieser Job bezahlt wird.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Beschäftigungsbedingung dieses Vergütungszeitplans.

name
name string

Name, der dieser Beschäftigungsbedingung zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

awardName
awardName string

Der Preisname kann sich von dem Namen unterscheiden, der einem Benutzer präsentiert wird. Wird in der Regel für den rechtlichen Namen des Preises verwendet.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Beruf

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Auftrag.

Person
person Person

Die Person , zu der dieser Job gehört.

Rekrutierung
recruitment Recruitment

Die für diesen Job gespeicherten Einstellungsdetails.

Standort
location Location

Der geografische Standort dieses Auftrags.

PayGrade
payGrade PayGrade

Die aktuelle Lohnnotedes Auftrags im System.

BusinessUnit4
businessUnit BusinessUnit4

Die aktuelle Geschäftseinheit des Auftrags im System.

BusinessEntity2
businessEntity BusinessEntity2

Die aktuelle Geschäftsentitätdes Auftrags im System.

SupervisorJob
supervisorJob SupervisorJob

Die Stelleninformationen für den Vorgesetzten dieses Auftrags oder null, wenn sie keinen Vorgesetzten haben.

Aufsichtsperson
supervisorPerson SupervisorPerson

Die Personeninformationen für den Vorgesetzten dieser Aufgabe oder null, wenn sie keinen Vorgesetzten haben.

Vergütungsplanung
remunerationSchedule RemunerationSchedule

Die aktuellen Vergütungsdetails für diesen Job, einschließlich Informationen wie Gehalt und Stundenlohn, alle Jobs haben einen Vergütungsplan, aber für unbezahlte Mitarbeiter haben sie einen speziellen No Remuneration Schedule Zeitplan.

name
name string

Der Name/positionstitel dieses Auftrags.

fte
fte number

Das Vollzeitäquivalent dieses Auftrags. Gibt die Arbeitsauslastung eines Mitarbeiters an, der in verschiedenen Kontexten vergleichbar sein kann. Dies ist null für Personen ohne FTE.

workClass
workClass string

Die Arbeitsklasse dieses Auftrags. Dies ist zusätzliche Details zum Arbeitstyp.

workType
workType string

Dies ist die Arbeitsklassifizierung für diesen Job, es wird verwendet, um zwischen Vollzeit- und Teilzeitmitarbeitern und unbezahlten Freiwilligen zu unterscheiden. Enumeration: Permanent, , Fixed Contract, UnpaidTemporary/Casual, . Independent Contract

jobStatus
jobStatus string

Der aktuelle Status dieser Aufgabe innerhalb dieser Organisation. Enumeration: Past Job, , Future JobEnding Job, . Current Job

companyStartDate
companyStartDate string

Das Datum, an dem dieser Auftrag begonnen hat oder innerhalb der Organisation beginnt. Dieses Datum folgt dem von RFC3339 definierten Format.

companyEndDate
companyEndDate string

Das Datum, an dem dieser Auftrag endet oder innerhalb der Organisation endet oder null ist, wenn kein Enddatum vorhanden ist. Dieses Datum folgt dem von RFC3339 definierten Format.

isEndDateConfirmed
isEndDateConfirmed boolean

Ob der Endtermin innerhalb der intelliHR-Anwendung abgeschlossen wurde.

turnoverType
turnoverType string

Die Art des Umsatzes dieses Auftragsendes wird klassifiziert als.

umsatzReason
turnoverReason string

Der Name des Umsatzgrundes.

ErstelltAm
createdAt string

Wann dieser Datensatz erstellt wurde. Dieses Datum folgt dem von RFC3339 definierten Format.

Auftrag4

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Auftrag.

name
name string

Der Name/positionstitel dieses Auftrags.

startDate
startDate string

Das Datum, an dem dieser Auftrag begonnen hat oder innerhalb der Organisation beginnt. Dieses Datum folgt dem von RFC3339 definierten Format.

Enddatum
endDate string

Das Datum, an dem dieser Auftrag endet oder innerhalb der Organisation endet oder null ist, wenn kein Enddatum vorhanden ist. Dieses Datum folgt dem von RFC3339 definierten Format.

jobStatus
jobStatus string

Der aktuelle Status dieser Aufgabe innerhalb dieser Organisation. Enumeration: Past Job, , Future JobEnding Job, . Current Job

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Auftrag7

Die Aufgabe der Person , die die Schulung gemacht hat.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Auftrag der Schulung.

name
name string

Der Name der Personen, die die Ausbildung gemacht haben.

startDate
startDate string

Der effektive Anfangstermin für Aufträge . Dieses Datum folgt dem von RFC3339 definierten Format.

Enddatum
endDate string

Das Effektive Enddatum der Aufträge . Dieses Datum folgt dem von RFC3339 definierten Format.

jobStatus
jobStatus string

Das Statusschema. Enumeration: Past Job, , Future JobEnding Job, . Current Job

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Links zu anderen verwandten Ressourcen.

Name Pfad Typ Beschreibung
selbst
self string

Die aktuelle Seiten-URL

erste
first string

Die URL der ersten Seite

Zurück
prev string

Die URL der vorherigen Seite

nächster
next string

Die URL der nächsten Seite

last
last string

Die letzte Seiten-URL

Standort

Der geografische Standort dieses Auftrags.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Speicherort dieses Auftrags.

name
name string

Name, der diesem Speicherort zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

address
address string

Die Adresse dieses Speicherorts.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

location5

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Speicherort.

parentId
parentId string

Die Bezeichnerzeichenfolge für den übergeordneten Speicherort oder NULL, wenn kein übergeordnetes Element vorhanden ist (dies ist ein Speicherort auf oberster Ebene).

name
name string

Name, der diesem Speicherort zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

address
address string

Die Adresse dieses Speicherorts.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diesen Speicherort in Dropdowns auswählen können.

Meta

Enthält verschiedene Metainformationen zur Antwort.

Name Pfad Typ Beschreibung
Paginierung
pagination Pagination

Enthält Informationen zur Paginierung der Antwort

Meta1

Enthält verschiedene Metainformationen zur Antwort.

Name Pfad Typ Beschreibung
Asat
asAt string

Der Zeitpunkt, für den diese Antwort vorgesehen ist. Dieses Datum folgt dem von RFC3339 definierten Format.

Meta2

Enthält verschiedene Metainformationen zur Antwort.

Name Pfad Typ Beschreibung
Asat
asAt string

Der Zeitpunkt, für den diese Antwort vorgesehen ist. Dieses Datum folgt dem von RFC3339 definierten Format.

Paginierung
pagination Pagination

Enthält Informationen zur Paginierung der Antwort

Meta8

Enthält verschiedene Metainformationen zur Antwort.

Name Pfad Typ Beschreibung
Asat
asAt string

Der Zeitpunkt, zu dem die Daten in dieser Antwort korrekt sind. Dieses Datum folgt dem von RFC3339 definierten Format.

Paginierung
pagination Pagination

Enthält Informationen zur Paginierung der Antwort

Paginierung

Enthält Informationen zur Paginierung der Antwort

Name Pfad Typ Beschreibung
gesamt
total integer

Gesamtzahl der Elemente

count
count integer

Anzahl der Elemente für die aktuelle Seite

per_page
per_page integer

Elemente pro Seitenlimit

current_page
current_page integer

Aktuelle Seite

total_pages
total_pages integer

Gesamtzahl der Seiten

PayGrade

Die aktuelle Lohnnotedes Auftrags im System.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Lohnnote dieses Auftrags.

name
name string

Benutzerfreundlicher Name, der der Pay Grade zugewiesen wird.

Code
code string

Administrativer, kurzer Code, der der Pay Grade zugeordnet ist.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

payGrade5

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Pay Grade.

Code
code string

Administrativer, kurzer Code, der der Pay Grade zugeordnet ist.

name
name string

Benutzerfreundlicher Name, der der Pay Grade zugewiesen wird.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Pay Grade in Dropdowns auswählen können.

Person

Die Person , zu der dieser Job gehört.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person , zu der dieser Auftrag gehört.

Anzeigename
displayName string

Name, der im gesamten System für diese Person angezeigt werden soll. Im Allgemeinen folgt das Muster preferredName (firstName) lastName, kann jedoch auf mandantenweiter Basis so konfiguriert werden, dass es sich um ein anderes Format handelt.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId double

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Person7

Die Person , die die Schulung gemacht hat.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Person der Schulung.

Anzeigename
displayName string

Der Name der Person , die die Schulung gemacht hat.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId double

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Telefonnummer

Name Pfad Typ Beschreibung
number
number string

Die tatsächliche Telefonnummer.

fullNumber
fullNumber string

Die tatsächliche Telefonnummer mit der Vorwahl (sofern registriert).

isPrimär
isPrimary boolean

Wenn dies eine primäre Telefonnummer ist.

isPersonal
isPersonal boolean

Wenn dies eine persönliche Telefonnummer ist.

PrimaryEmailAddress1

Informationen zur primären E-Mail-Adresse dieser Person oder null, wenn sie keine E-Mail-Informationen enthalten.

Name Pfad Typ Beschreibung
E-Mail
email string

Die tatsächliche E-Mail-Adresse.

isPersonal
isPersonal boolean

Gibt an, ob es sich bei dieser E-Mail um persönliche oder geschäftliche E-Mails handelt.

PrimaryPhoneNumber1

Informationen zur primären Telefonnummer dieser Person oder null, wenn sie keine Telefonnummern haben.

Name Pfad Typ Beschreibung
number
number string

Die tatsächliche Telefonnummer.

fullNumber
fullNumber string

Die tatsächliche Telefonnummer mit der Vorwahl (sofern registriert).

isPersonal
isPersonal boolean

Gibt an, ob es sich bei dieser Telefonnummer um eine persönliche oder geschäftliche Nummer handelt.

Provider

Der Schulungsanbieter der Schulung.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Schulungsanbieter der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungsanbieter der Schulung zugewiesen wird.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Rekrutierung

Die für diesen Job gespeicherten Einstellungsdetails.

Name Pfad Typ Beschreibung
kosten
cost number

Die Kosten, um diesen Job zu rekrutieren. Wenn es null ist, wurden die Kosten nicht aufgezeichnet.

Währung
currency string

Die Währung, die zum Rekrutieren dieses Auftrags verwendet wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

Quelle
source Source

Die Rekrutierungsquelle , aus der dieser Job stammt, oder null, wenn er nicht aufgezeichnet wurde.

recruitmentSource

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Rekrutierungsquelle.

name
name string

Der Name, der dieser Rekrutierungsquelle gegeben wird.

parentId
parentId string

Die Id-Zeichenfolge für die übergeordnete Rekrutierungsquelle oder null, wenn kein Elternteil vorhanden ist (dies ist eine Rekrutierungsquelle auf oberster Ebene).

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diese Einstellungsquelle in Dropdowns auswählen können.

Vergütungsplanung

Die aktuellen Vergütungsdetails für diesen Job, einschließlich Informationen wie Gehalt und Stundenlohn, alle Jobs haben einen Vergütungsplan, aber für unbezahlte Mitarbeiter haben sie einen speziellen No Remuneration Schedule Zeitplan.

Name Pfad Typ Beschreibung
type
type string

Die Methode, in der dieser Vergütungsplan gezahlt wird, wenn eine Person unbezahlt ist, lautet No Remuneration Scheduledies . Enumeration: Annual Salary, Hourly Rate, No Remuneration Schedule.

BaseAnnualSalary
baseAnnualSalary double

Das jahresbezahlte Basisgehalt ist dies eine Annäherung, wenn sie stündlich bezahlt werden. Beachten Sie, dass die BaseHourlyRate, wenn sowohl baseAnnualSalary als auch baseHourlyRate in einer Erstellungs- oder Patchanforderung bereitgestellt werden, die baseHourlyRate ignoriert wird.

baseHourlyRate
baseHourlyRate double

Der stundenweise bezahlte Basissatz ist dies eine Annäherung, wenn sie jährlich gezahlt werden. Beachten Sie, dass die BaseHourlyRate, wenn sowohl baseAnnualSalary als auch baseHourlyRate in einer Erstellungs- oder Patchanforderung bereitgestellt werden, die baseHourlyRate ignoriert wird.

Währung
currency string

Die Währung, in der die Basis und die Summen, in denen dieser Auftrag gezahlt wird. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

hoursPerCycle
hoursPerCycle double

Wie viele Stunden pro payCycle gearbeitet haben.

payCycle
payCycle string

Der Zyklus, für den der Job bezahlt wird. Enumeration: Weekly, Fortnightly, Monthly.

annualPackage
annualPackage double

Das Gesamtpaket, das jährlich gezahlt wird, einschließlich Ergänzungen und Abzüge. Dieser Betrag wird berechnet, indem das Jährliche Basisgehalt und die Hinzufügungen abzüglich der Abzüge addiert werden.

stündlichPackage
hourlyPackage double

Das Gesamtpaket, das stündlich bezahlt wird, einschließlich Zuschlägen und Abzüge. Dieser Betrag wird berechnet, indem das Jahrespaket durch die Gesamtzahl der Stunden pro Jahr dividiert wird.

currencyConversionOccurred
currencyConversionOccurred boolean

Wenn bei der Berechnung des Jahrespakets eine Umrechnung zwischen Zusatz- und Abzugswährungen durchgeführt werden muss.

EmploymentCondition2
employmentCondition EmploymentCondition2

Die Beschäftigungsbedingung , unter der dieser Job bezahlt wird.

Ergänzungen
additions array of Addition

Eine Reihe von Ergänzungen für diesen Vergütungsplan.

Abzüge
deductions array of Deduction

Ein Array von Abzugen für diesen Vergütungsplan.

additionsToTotal
additionsToTotal array of AdditionsToTotal

Eine Reihe von Ergänzungen, die auf das Paket nach allen anderen Komponenten für diesen Vergütungsplan angewendet wurden.

Zusammenbrüche
breakdowns array of Breakdown

Eine Reihe von Aufschlüsselungen für diesen Vergütungsplan. Aufschlüsselungen werden nicht zum Berechnen des Gesamtpakets verwendet.

Quelle

Die Rekrutierungsquelle , aus der dieser Job stammt, oder null, wenn er nicht aufgezeichnet wurde.

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für die Rekrutierungsquelle dieses Auftrags.

name
name string

Der Name, der dieser Rekrutierungsquelle gegeben wird.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

SupervisorJob

Die Stelleninformationen für den Vorgesetzten dieses Auftrags oder null, wenn sie keinen Vorgesetzten haben.

Name Pfad Typ Beschreibung
id
id string

Die Zeichenfolge des Bezeichners für den Auftrag desSupervisors.

jobStatus
jobStatus string

Der aktuelle Status dieser Aufgabe innerhalb dieser Organisation. Enumeration: Past Job, , Future JobEnding Job, . Current Job

name
name string

Der Name/positionstitel des Vorgesetzten.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Aufsichtsperson

Die Personeninformationen für den Vorgesetzten dieser Aufgabe oder null, wenn sie keinen Vorgesetzten haben.

Name Pfad Typ Beschreibung
id
id string

Die Zeichenfolge des Bezeichners für die Person des Vorgesetzten dieses Auftrags.

Anzeigename
displayName string

Name, der im gesamten System für diese Person angezeigt werden soll. Im Allgemeinen folgt das Muster preferredName (firstName) lastName, kann jedoch auf mandantenweiter Basis so konfiguriert werden, dass es sich um ein anderes Format handelt.

Mitarbeiternummer
employeeNumber string

Eine manuell eingegebene Mitarbeiternummer, die eine Person in intelliHR identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

autoIncrementIntellihrId
autoIncrementIntellihrId double

Eine automatisch generierte Zahl, die eine Person in intelliHR eindeutig identifiziert. Es kann je nach Konfiguration Ihres Mandanten in der Benutzeroberfläche des Systems ausgeblendet werden.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

Ausbildung

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Schulung.

name
name string

Benutzerfreundlicher Name, der dieser Schulung zugewiesen wird.

Person7
person Person7

Die Person , die die Schulung gemacht hat.

Auftrag7
job Job7

Die Aufgabe der Person , die die Schulung gemacht hat.

Koordinator
coordinator Coordinator

Der Koordinator , der die Schulung durchführte. Diese Daten sind optional und werden null sein, wenn sie nicht gespeichert werden.

Stunden
hours string

Wie viele Stunden wurden für diese Schulung aufgewendet.

Währung
currency string

Die für dieses [Training](#tag/Trainings) verwendete Währung. Ein internationaler Währungscode. In der Regel AUD für australischen Dollar, USD für amerikanischen Dollar usw. Siehe offizielle Liste der Codes.

kosten
cost string

Die Kosten für diese Schulung.

Provider
provider Provider

Der Schulungsanbieter der Schulung.

Typ
type Type

Der Schulungstyp der Schulung.

FertigstellungDatum
completionDate string

Der Zeitstempel der Schulung wurde abgeschlossen. Dieses Datum folgt dem von RFC3339 definierten Format.

ErstelltAm
createdAt string

Wann dieser Datensatz erstellt wurde. Dieses Datum folgt dem von RFC3339 definierten Format.

updatedAt
updatedAt string

Zeitpunkt der letzten Aktualisierung dieses Datensatzes. Dieses Datum folgt dem von RFC3339 definierten Format.

trainingProviders

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für den Schulungsanbieter.

name
name string

Benutzerfreundlicher Name, der dem Schulungsanbieter zugewiesen wird.

isDefault
isDefault boolean

Gibt an, ob dieser Schulungsanbieter beim Erstellen eines Schulungsdatensatzes als Standard verwendet wird.

trainingTypes

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für den Schulungstyp.

name
name string

Benutzerfreundlicher Name, der dem Schulungstyp zugewiesen wird.

isDefault
isDefault boolean

Gibt an, ob dieser Schulungstyp beim Erstellen eines Schulungsdatensatzes als Standard verwendet wird.

Typ

Der Schulungstyp der Schulung.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für den Schulungstyp der Schulung.

name
name string

Benutzerfreundlicher Name, der dem Schulungstyp der Schulung zugewiesen wird.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

WebhookEvent

Das Webhook-Ereignis , das diesen Webhook ausgelöst hat.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für das Webhook-Ereignis.

name
name string

Der lesbare eindeutige Ereignisschlüssel für dieses Webhook-Ereignis.

Ereignis
event string

Der Strich des Webhook-Ereignisses.

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

WorkClassesSchema

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für die Arbeitsklasse.

name
name string

Name, der dieser Arbeitsklasse zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

WorkType2
workType WorkType2

Der übergeordnete Arbeitstyp dieser Arbeitsklasse.

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diesen Arbeitstyp in Dropdowns auswählen können.

WorkRight2

Name Pfad Typ Beschreibung
id
id string

Die Id-Zeichenfolge für das Arbeitsrecht.

name
name string

Name, der diesem Arbeitsrecht zugewiesen wird. Dieser Name wird benutzern des Systems normalerweise angezeigt.

countryId
countryId string

Die Id-Zeichenfolge für das Land.

country
country string

Der Namenswert des zugewiesenen Landes.

WorkRights

Anzeigen der Arbeitsrechte der Person

Name Pfad Typ Beschreibung
name
name string

Die Art der Arbeitsrechte

country
country string

Das Land, in dem die Arbeitsrechte gültig sind

Ablaufdatum
expirationDate string

Das Datum, an dem die Arbeitsrechte ablaufen

WorkType2

Der übergeordnete Arbeitstyp dieser Arbeitsklasse.

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für den Arbeitstyp dieser Arbeitsklasse.

name
name string

Der Name des Arbeitstyps. Enumeration: Permanent, , Fixed Contract, UnpaidTemporary/Casual, . Independent Contract

link
link string

Link zur öffentlichen API, um weitere Informationen zu diesem Datenabschnitt zu erhalten.

workType4

Name Pfad Typ Beschreibung
id
id string

Die Bezeichnerzeichenfolge für den Arbeitstyp.

name
name string

Der Name des Arbeitstyps. Enumeration: Permanent, , Fixed Contract, UnpaidTemporary/Casual, . Independent Contract

isEnabled
isEnabled boolean

Gibt an, ob Benutzer diesen Arbeitstyp in Dropdowns auswählen können.

Schnur

Dies ist der grundlegende Datentyp "string".