Freigeben über


PaySpace (Unabhängiger Herausgeber) (Vorschau)

Mit unserer leistungsstarken Lösung können Sie auf Ihre Mitarbeiterdaten zugreifen, um sie in Ihrer Geschäftsumgebung nutzen zu können. Alle unterstützten Endpunkte an einem Zentralen Ort und können in Ihre Lösung integriert werden.

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 Mint PaySpace-Unterstützung
URL https://za.mintgroup.net/
Email payspace.support@mintgroup.net
Connectormetadaten
Herausgeber Mint Management Technologies
Webseite https://www.payspace.com
Datenschutzrichtlinie https://www.payspace.com/privacy-policy/
Kategorien Personalabteilung

Drosselungsgrenzwerte

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

Aktionen

Abrufen einer Sammlung aller Beschäftigungsstatus

Ruft eine Liste aller Beschäftigungsstatus aller Mitarbeiter basierend auf der angegebenen Firmen-ID ab.

Abrufen einer Sammlung von Anlagendatensätzen für Mitarbeiter

Ruft eine Liste der Datensätze aktiver Mitarbeiteranlagen basierend auf dem angegebenen company_id ab.

Abrufen einer Sammlung von Bankdetailsdatensätzen

Ruft eine Liste der Mitarbeiter-Bankdetails basierend auf dem angegebenen company_id ab.

Abrufen einer Sammlung von Beschäftigungsstatus

Ruft eine Liste der aktuellen aktiven Mitarbeiterbeschäftigungsstatus basierend auf der angegebenen Firmen-ID ab.

Abrufen einer Sammlung von Mitarbeitern

Ruft eine Liste der aktiven mitarbeiterbiografischen Details ab dem heutigen Datum und basierend auf der angegebenen Firmen-ID ab.

Abrufen einer Sammlung von Mitarbeitern ab einem Gültigen Datum

Ruft eine Liste der aktiven mitarbeiterbiografischen Details ab dem angegebenen Gültigkeitsdatum und basierend auf der angegebenen Firmen-ID ab.

Abrufen einer Sammlung von Positionen

Ruft eine Liste der Mitarbeiterpositionsdatensätze ab dem heutigen Datum ab und basiert auf dem angegebenen company_id.

Abrufen einer Sammlung von Positionen ab einem effektiven Datum

Ruft eine Liste der Mitarbeiterpositionsdatensätze ab dem angegebenen Gültigkeitsdatum und basierend auf dem angegebenen company_id ab.

Abrufen eines datensatzes für einen einzelnen Mitarbeiteranlagen

Ruft Informationen zur Anlagenanlage von Mitarbeitern basierend auf der angegebenen AttachmentId ab.

Abrufen eines einzelnen Bankdetaildatensatzes

Ruft Informationen zur Mitarbeiterbankdetails basierend auf der angegebenen BankDetailId ab.

Abrufen eines einzelnen Mitarbeiterdatensatzes

Ruft Mitarbeiterinformationen basierend auf der angegebenen EmployeeId ab.

Abrufen eines einzelnen Positionsdatensatzes

Ruft Mitarbeiterpositionsdatensätze basierend auf der angegebenen EmployeePositionId ab.

Aktualisieren eines Datensatzes einer einzelnen Mitarbeiteranlage

Aktualisieren Eines einzelnen Anlagendatensatzes basierend auf der angegebenen AttachmentId.

Aktualisieren eines einzelnen Bankdetaildatensatzes

Aktualisieren Sie einen einzelnen Bankdetaildatensatz basierend auf der angegebenen BankdetailId.

Aktualisieren eines einzelnen Mitarbeiterdatensatzes

Aktualisieren Sie einen einzelnen Mitarbeiterdatensatz basierend auf der angegebenen EmployeeId.

Aktualisieren eines einzelnen Positionsdatensatzes

Aktualisieren Sie einen einzelnen Mitarbeiterpositionsdatensatz basierend auf der angegebenen EmployeePositionId.

Erstellen eines datensatzes einer einzelnen Mitarbeiteranlage

Erstellen Sie einen einzelnen Anlagendatensatz für die angegebene EmployeeNumber.

Erstellen eines einzelnen Bankdetaildatensatzes

Erstellen Sie einen einzelnen Mitarbeiter-Bankdetailsdatensatz für die angegebene EmployeeNumber.Create a single employee details record for the specified EmployeeNumber.

Erstellen eines einzelnen Beschäftigungsstatusdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterstatusdatensatz für die angegebene EmployeeNumber.

Erstellen eines einzelnen Mitarbeiterdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterdatensatz für die angegebene EmployeeNumber.

Erstellen eines einzelnen Positionsdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterpositionsdatensatz für die angegebene EmployeeNumber.

Hochladen eines Mitarbeiterfotos

Aktualisieren Sie ein einzelnes Mitarbeiterfoto basierend auf der angegebenen EmployeeId.

Löschen eines datensatzes für einen einzelnen Mitarbeiteranlagen

Löschen Sie einen einzelnen Anlagendatensatz für Mitarbeiter basierend auf der angegebenen AttachmentId.

Löschen eines einzelnen Bankdetaildatensatzes

Ruft Informationen zur Mitarbeiterbankdetails basierend auf der angegebenen BankDetailId ab.

Mitarbeiterfoto herunterladen

Ruft ein einzelnes Mitarbeiterfoto basierend auf der angegebenen EmployeeId ab.

Abrufen einer Sammlung aller Beschäftigungsstatus

Ruft eine Liste aller Beschäftigungsstatus aller Mitarbeiter basierend auf der angegebenen Firmen-ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{$employee-field}}
$orderby string

Optional (Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmploymentStatusId
value.EmploymentStatusId integer

EmploymentStatusId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

Beschäftigungsdatum
value.EmploymentDate string

Beschäftigungsdatum

Kündigungsdatum
value.TerminationDate string

Kündigungsdatum

TerminationReason
value.TerminationReason string

TerminationReason

TaxStatus
value.TaxStatus string

TaxStatus

TaxReferenceNumber
value.TaxReferenceNumber string

TaxReferenceNumber

NatureOfPerson
value.NatureOfPerson string

NatureOfPerson

TaxOffice
value.TaxOffice integer

TaxOffice

TaxDirectiveNumber
value.TaxDirectiveNumber string

TaxDirectiveNumber

IT3AReason
value.IT3AReason integer

IT3AReason

EmploymentAction
value.EmploymentAction string

EmploymentAction

TerminationCompanyRun
value.TerminationCompanyRun string

TerminationCompanyRun

IdentityType
value.IdentityType string

IdentityType

Id-Nummer
value.IdNumber string

Id-Nummer

PassportNumber
value.PassportNumber string

PassportNumber

PercentageAmount
value.PercentageAmount string

PercentageAmount

Betrag
value.Amount integer

Betrag

Prozentsatz
value.Percentage integer

Prozentsatz

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Deemed75Indicator
value.Deemed75Indicator boolean

Deemed75Indicator

DeemedRecoveryMonthly
value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

EnaveLeave
value.EncashLeave boolean

EnaveLeave

Irp30
value.Irp30 boolean

Irp30

FinalizeIssueTaxCert
value.FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert

PassportCountry
value.PassportCountry boolean

PassportCountry

PassportIssued
value.PassportIssued string

PassportIssued

PassportExpiry
value.PassportExpiry string

PassportExpiry

PermitIssued
value.PermitIssued string

PermitIssued

PermitExpiry
value.PermitExpiry string

PermitExpiry

AdditionalDate
value.AdditionalDate string

AdditionalDate

EmploymentCaptureDate
value.EmploymentCaptureDate string

EmploymentCaptureDate

TerminationCaptureDate
value.TerminationCaptureDate string

TerminationCaptureDate

TempWorker
value.TempWorker boolean

TempWorker

AdditionalDate1
value.AdditionalDate1 string

AdditionalDate1

NotReEmployable
value.NotReEmployable boolean

NotReEmployable

ReferenceNumber
value.ReferenceNumber string

ReferenceNumber

OldEmployeeId
value.OldEmployeeId integer

OldEmployeeId

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Abrufen einer Sammlung von Anlagendatensätzen für Mitarbeiter

Ruft eine Liste der Datensätze aktiver Mitarbeiteranlagen basierend auf dem angegebenen company_id ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Optional von {{$attachment-field}}
$orderby string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

AttachmentId
value.AttachmentId integer

AttachmentId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

Klassifizierung
value.Classification string

Klassifizierung

AttachmentDescription
value.AttachmentDescription string

AttachmentDescription

AttachmentName
value.AttachmentName string

AttachmentName

AttachmentUrl
value.AttachmentUrl string

AttachmentUrl

Attachment
value.Attachment string

Attachment

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Abrufen einer Sammlung von Bankdetailsdatensätzen

Ruft eine Liste der Mitarbeiter-Bankdetails basierend auf dem angegebenen company_id ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Optional von {{$bank-detail-field}}
$orderby True string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top string

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True string

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

BankDetailId
value.BankDetailId integer

BankDetailId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

PaymentMethod
value.PaymentMethod string

PaymentMethod

SplitType
value.SplitType string

SplitType

BankAccountOwner
value.BankAccountOwner string

BankAccountOwner

BankAccountOwnerName
value.BankAccountOwnerName string

BankAccountOwnerName

AccountType
value.AccountType string

AccountType

BankName
value.BankName string

BankName

BankBranchNo
value.BankBranchNo string

BankBranchNo

BankAccountNo
value.BankAccountNo string

BankAccountNo

Reference
value.Reference string

Reference

IsMainAccount
value.IsMainAccount boolean

IsMainAccount

Betrag
value.Amount integer

Betrag

Kommentare
value.Comments string

Kommentare

SwiftCode
value.SwiftCode string

SwiftCode

RoutingCode
value.RoutingCode string

RoutingCode

ComponentId
value.ComponentId integer

ComponentId

Abrufen einer Sammlung von Beschäftigungsstatus

Ruft eine Liste der aktuellen aktiven Mitarbeiterbeschäftigungsstatus basierend auf der angegebenen Firmen-ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Optional von {{$employee-field}}
$orderby string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmploymentStatusId
value.EmploymentStatusId integer

EmploymentStatusId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

Beschäftigungsdatum
value.EmploymentDate string

Beschäftigungsdatum

Kündigungsdatum
value.TerminationDate string

Kündigungsdatum

TerminationReason
value.TerminationReason string

TerminationReason

TaxStatus
value.TaxStatus string

TaxStatus

TaxReferenceNumber
value.TaxReferenceNumber string

TaxReferenceNumber

NatureOfPerson
value.NatureOfPerson string

NatureOfPerson

TaxOffice
value.TaxOffice integer

TaxOffice

TaxDirectiveNumber
value.TaxDirectiveNumber string

TaxDirectiveNumber

IT3AReason
value.IT3AReason integer

IT3AReason

EmploymentAction
value.EmploymentAction string

EmploymentAction

TerminationCompanyRun
value.TerminationCompanyRun string

TerminationCompanyRun

IdentityType
value.IdentityType string

IdentityType

Id-Nummer
value.IdNumber string

Id-Nummer

PassportNumber
value.PassportNumber string

PassportNumber

PercentageAmount
value.PercentageAmount string

PercentageAmount

Betrag
value.Amount integer

Betrag

Prozentsatz
value.Percentage integer

Prozentsatz

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Deemed75Indicator
value.Deemed75Indicator boolean

Deemed75Indicator

DeemedRecoveryMonthly
value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

EnaveLeave
value.EncashLeave boolean

EnaveLeave

Irp30
value.Irp30 boolean

Irp30

FinalizeIssueTaxCert
value.FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert

PassportCountry
value.PassportCountry boolean

PassportCountry

PassportIssued
value.PassportIssued string

PassportIssued

PassportExpiry
value.PassportExpiry string

PassportExpiry

PermitIssued
value.PermitIssued string

PermitIssued

PermitExpiry
value.PermitExpiry string

PermitExpiry

AdditionalDate
value.AdditionalDate string

AdditionalDate

EmploymentCaptureDate
value.EmploymentCaptureDate string

EmploymentCaptureDate

TerminationCaptureDate
value.TerminationCaptureDate string

TerminationCaptureDate

TempWorker
value.TempWorker boolean

TempWorker

AdditionalDate1
value.AdditionalDate1 string

AdditionalDate1

NotReEmployable
value.NotReEmployable boolean

NotReEmployable

ReferenceNumber
value.ReferenceNumber string

ReferenceNumber

OldEmployeeId
value.OldEmployeeId integer

OldEmployeeId

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Abrufen einer Sammlung von Mitarbeitern

Ruft eine Liste der aktiven mitarbeiterbiografischen Details ab dem heutigen Datum und basierend auf der angegebenen Firmen-ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Optional von {{$employee-field}}
$orderby string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Optional – Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

Optionale $select
$select string

Optional (Zeichenfolge) – Gibt nur die angegebenen Felder zurück.

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmployeeId
value.EmployeeId integer

EmployeeId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

Title
value.Title string

Title

Vorname
value.FirstName string

Vorname

Nachname
value.LastName string

Nachname

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

MiddleName
value.MiddleName string

MiddleName

Initials
value.Initials string

Initials

Email
value.Email string

Email

Geburtstag
value.Birthday string

Geburtstag

HomeNumber
value.HomeNumber string

HomeNumber

WorkNumber
value.WorkNumber string

WorkNumber

CellNumber
value.CellNumber string

CellNumber

WorkExtension
value.WorkExtension string

WorkExtension

Language
value.Language string

Language

Geschlecht
value.Gender string

Geschlecht

MaritalStatus
value.MaritalStatus string

MaritalStatus

Rennen
value.Race string

Rennen

Nationality
value.Nationality string

Nationality

Staatsbürgerschaft
value.Citizenship string

Staatsbürgerschaft

DisabledType
value.DisabledType string

DisabledType

Auslandsnational
value.ForeignNational boolean

Auslandsnational

DateCreated
value.DateCreated string

DateCreated

EmergencyContactName
value.EmergencyContactName string

EmergencyContactName

EmergencyContactNumber
value.EmergencyContactNumber string

EmergencyContactNumber

EmergencyContactAddress
value.EmergencyContactAddress string

EmergencyContactAddress

IsRetired
value.IsRetired boolean

IsRetired

CustomFieldValue
value.CustomFieldValue string

CustomFieldValue

CustomFieldValue2
value.CustomFieldValue2 string

CustomFieldValue2

UifExemption
value.UifExemption string

UifExemption

SdlExemption
value.SdlExemption string

SdlExemption

EtiExempt
value.EtiExempt boolean

EtiExempt

ImageDownloadUrl
value.ImageDownloadUrl string

ImageDownloadUrl

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Adresse
value.Address array of object

Adresse

AddressId
value.Address.AddressId integer

AddressId

Adresstyp
value.Address.AddressType string

Adresstyp

Mitarbeiternummer
value.Address.EmployeeNumber string

Mitarbeiternummer

AddressLine1
value.Address.AddressLine1 string

AddressLine1

AddressLine2
value.Address.AddressLine2 string

AddressLine2

AddressLine3
value.Address.AddressLine3 string

AddressLine3

AddressCode
value.Address.AddressCode string

AddressCode

AddressCountry
value.Address.AddressCountry string

AddressCountry

Provinz
value.Address.Province string

Provinz

UnitNumber
value.Address.UnitNumber string

UnitNumber

Complex
value.Address.Complex string

Complex

StreetNumber
value.Address.StreetNumber string

StreetNumber

SameAsPhysical
value.Address.SameAsPhysical boolean

SameAsPhysical

IsCareofAddress
value.Address.IsCareofAddress boolean

IsCareofAddress

CareOfIntermediary
value.Address.CareOfIntermediary string

CareOfIntermediary

SpecialServices
value.Address.SpecialServices string

SpecialServices

Abrufen einer Sammlung von Mitarbeitern ab einem Gültigen Datum

Ruft eine Liste der aktiven mitarbeiterbiografischen Details ab dem angegebenen Gültigkeitsdatum und basierend auf der angegebenen Firmen-ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

effectivedate
effectivedate True string

Effektives Datum, das in JJJJ-MM-TT formatiert ist. Zb. 2022-01-15

Optional von {{$employee-field}}
$orderby string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string
  • Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"
Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmployeeId
value.EmployeeId integer

EmployeeId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

Title
value.Title string

Title

Vorname
value.FirstName string

Vorname

Nachname
value.LastName string

Nachname

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

MiddleName
value.MiddleName string

MiddleName

Initials
value.Initials string

Initials

Email
value.Email string

Email

Geburtstag
value.Birthday string

Geburtstag

HomeNumber
value.HomeNumber string

HomeNumber

WorkNumber
value.WorkNumber string

WorkNumber

CellNumber
value.CellNumber string

CellNumber

WorkExtension
value.WorkExtension string

WorkExtension

Language
value.Language string

Language

Geschlecht
value.Gender string

Geschlecht

MaritalStatus
value.MaritalStatus string

MaritalStatus

Rennen
value.Race string

Rennen

Nationality
value.Nationality string

Nationality

Staatsbürgerschaft
value.Citizenship string

Staatsbürgerschaft

TaxRefNumber
value.TaxRefNumber string

TaxRefNumber

Disabled
value.Disabled boolean

Disabled

DisabledType
value.DisabledType string

DisabledType

Ethnische Gruppe
value.EthnicGroup string

Ethnische Gruppe

Auslandsnational
value.ForeignNational boolean

Auslandsnational

GroupDate
value.GroupDate string

GroupDate

DateCreated
value.DateCreated string

DateCreated

EmergencyContactName
value.EmergencyContactName string

EmergencyContactName

EmergencyContactNumber
value.EmergencyContactNumber string

EmergencyContactNumber

EmergencyContactAddress
value.EmergencyContactAddress string

EmergencyContactAddress

IsMockEmployee
value.IsMockEmployee boolean

IsMockEmployee

IsRetired
value.IsRetired boolean

IsRetired

CustomFieldValue
value.CustomFieldValue string

CustomFieldValue

CustomFieldValue2
value.CustomFieldValue2 string

CustomFieldValue2

UifExemption
value.UifExemption string

UifExemption

SdlExemption
value.SdlExemption string

SdlExemption

EtiExempt
value.EtiExempt boolean

EtiExempt

ImageDownloadUrl
value.ImageDownloadUrl string

ImageDownloadUrl

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Adresse
value.Address array of object

Adresse

AddressId
value.Address.AddressId integer

AddressId

Adresstyp
value.Address.AddressType string

Adresstyp

Mitarbeiternummer
value.Address.EmployeeNumber string

Mitarbeiternummer

AddressLine1
value.Address.AddressLine1 string

AddressLine1

AddressLine2
value.Address.AddressLine2 string

AddressLine2

AddressLine3
value.Address.AddressLine3 string

AddressLine3

AddressCode
value.Address.AddressCode string

AddressCode

AddressCountry
value.Address.AddressCountry string

AddressCountry

Provinz
value.Address.Province string

Provinz

UnitNumber
value.Address.UnitNumber string

UnitNumber

Complex
value.Address.Complex string

Complex

StreetNumber
value.Address.StreetNumber string

StreetNumber

SameAsPhysical
value.Address.SameAsPhysical boolean

SameAsPhysical

IsCareofAddress
value.Address.IsCareofAddress boolean

IsCareofAddress

CareOfIntermediary
value.Address.CareOfIntermediary string

CareOfIntermediary

SpecialServices
value.Address.SpecialServices string

SpecialServices

Abrufen einer Sammlung von Positionen

Ruft eine Liste der Mitarbeiterpositionsdatensätze ab dem heutigen Datum ab und basiert auf dem angegebenen company_id.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $filter
$filter string

Filtern nach Feld z. B. "EmployeeNumber eq 'Emp01'"

Optionale $expand
$expand True string

Optional – Verwenden Sie den Wert "OrganizationGroups", um die OrganisationsGruppen-Felddaten zurückzugeben.

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

FullName
value.FullName string

FullName

EffectiveDate
value.EffectiveDate string

EffectiveDate

OrganizationPosition
value.OrganizationPosition string

OrganizationPosition

OrganizationPositionId
value.OrganizationPositionId integer

OrganizationPositionId

OrganizationPositionWithCode
value.OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
value.PositionType string

PositionType

Grade
value.Grade string

Grade

Berufsstufe
value.OccupationalLevel string

Berufsstufe

DirektReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirektReportsPositionOverride

DirektReportsPosition
value.DirectlyReportsPosition string

DirektReportsPosition

OrganizationGroup
value.OrganizationGroup string

OrganizationGroup

OrganizationGroupDescription
value.OrganizationGroupDescription string

OrganizationGroupDescription

OrganizationGroups
value.OrganizationGroups array of object

OrganizationGroups

OrganizationUnitId
value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId

ParentOrganizationUnitId
value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId

UploadCode
value.OrganizationGroups.UploadCode string

UploadCode

Description
value.OrganizationGroups.Description string

Description

CostCentre
value.OrganizationGroups.CostCentre boolean

CostCentre

OrganizationLevel
value.OrganizationGroups.OrganizationLevel string

OrganizationLevel

GroupGlKey
value.OrganizationGroups.GroupGlKey string

GroupGlKey

Budget
value.OrganizationGroups.Budget integer

Budget

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirektReportsEmployee
value.DirectlyReportsEmployee string

DirektReportsEmployee

DirektReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirektReportsEmployeeNumber

EmploymentCategory
value.EmploymentCategory string

EmploymentCategory

EmploymentSubCategory
value.EmploymentSubCategory string

EmploymentSubCategory

Administrator
value.Administrator string

Administrator

AdministratorEmployeeNumber
value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber

WorkflowRole
value.WorkflowRole string

WorkflowRole

GeneralLedger
value.GeneralLedger string

GeneralLedger

TradeUnion
value.TradeUnion string

TradeUnion

IsPromotion
value.IsPromotion boolean

IsPromotion

Liste
value.Roster string

Liste

Beruf
value.Job string

Beruf

Kommentare
value.Comments string

Kommentare

AltPositionName
value.AltPositionName string

AltPositionName

DateAdded
value.DateAdded string

DateAdded

PositionEffectiveDate
value.PositionEffectiveDate string

PositionEffectiveDate

CustomTradeUnion
value.CustomTradeUnion string

CustomTradeUnion

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Abrufen einer Sammlung von Positionen ab einem effektiven Datum

Ruft eine Liste der Mitarbeiterpositionsdatensätze ab dem angegebenen Gültigkeitsdatum und basierend auf dem angegebenen company_id ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{$employee-field}}
$orderby True string

(Zeichenfolge) – Gibt die Reihenfolge an, in der Elemente zurückgegeben werden.

Optionale $top
$top integer

(integer($int 32)) – Beschränkt die Anzahl der elemente, die aus einer Auflistung zurückgegeben werden.

Optionale $skip
$skip True integer

(integer($int 32)) – Schließt die angegebene Anzahl der Elemente der abgefragten Auflistung aus dem Ergebnis aus.

Optionale $count
$count True string

(true/false) – Gesamtanzahl in Antwort zurückgeben

Optionale $expand
$expand True string

Optional – Verwenden Sie den Wert "OrganizationGroups", um die OrganisationsGruppen-Felddaten zurückzugeben.

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

effectivedate
effectivedate True string

Effektives Datum, das in JJJJ-MM-TT formatiert ist. Zb. 2022-01-15

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

FullName
value.FullName string

FullName

EffectiveDate
value.EffectiveDate string

EffectiveDate

OrganizationPosition
value.OrganizationPosition string

OrganizationPosition

OrganizationPositionId
value.OrganizationPositionId integer

OrganizationPositionId

OrganizationPositionWithCode
value.OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
value.PositionType string

PositionType

Grade
value.Grade string

Grade

Berufsstufe
value.OccupationalLevel string

Berufsstufe

DirektReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirektReportsPositionOverride

DirektReportsPosition
value.DirectlyReportsPosition string

DirektReportsPosition

OrganizationGroup
value.OrganizationGroup string

OrganizationGroup

OrganizationGroupDescription
value.OrganizationGroupDescription string

OrganizationGroupDescription

OrganizationGroups
value.OrganizationGroups array of object

OrganizationGroups

OrganizationUnitId
value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId

ParentOrganizationUnitId
value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId

UploadCode
value.OrganizationGroups.UploadCode string

UploadCode

Description
value.OrganizationGroups.Description string

Description

CostCentre
value.OrganizationGroups.CostCentre boolean

CostCentre

OrganizationLevel
value.OrganizationGroups.OrganizationLevel string

OrganizationLevel

GroupGlKey
value.OrganizationGroups.GroupGlKey string

GroupGlKey

Budget
value.OrganizationGroups.Budget integer

Budget

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirektReportsEmployee
value.DirectlyReportsEmployee string

DirektReportsEmployee

DirektReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirektReportsEmployeeNumber

EmploymentCategory
value.EmploymentCategory string

EmploymentCategory

EmploymentSubCategory
value.EmploymentSubCategory string

EmploymentSubCategory

Administrator
value.Administrator string

Administrator

AdministratorEmployeeNumber
value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber

WorkflowRole
value.WorkflowRole string

WorkflowRole

GeneralLedger
value.GeneralLedger string

GeneralLedger

TradeUnion
value.TradeUnion string

TradeUnion

IsPromotion
value.IsPromotion boolean

IsPromotion

Liste
value.Roster string

Liste

Beruf
value.Job string

Beruf

Kommentare
value.Comments string

Kommentare

AltPositionName
value.AltPositionName string

AltPositionName

DateAdded
value.DateAdded string

DateAdded

PositionEffectiveDate
value.PositionEffectiveDate string

PositionEffectiveDate

CustomTradeUnion
value.CustomTradeUnion string

CustomTradeUnion

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Abrufen eines datensatzes für einen einzelnen Mitarbeiteranlagen

Ruft Informationen zur Anlagenanlage von Mitarbeitern basierend auf der angegebenen AttachmentId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{AttachmentId}}
AttachmentId True integer

Die AttachmentId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

Klassifizierung
Classification string

Klassifizierung

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Attachment
Attachment string

Attachment

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etikett
CustomFields.Label string

Etikett

Wert
CustomFields.Value string

Wert

Abrufen eines einzelnen Bankdetaildatensatzes

Ruft Informationen zur Mitarbeiterbankdetails basierend auf der angegebenen BankDetailId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{BankDetailId}}
BankDetailId True integer

Die BankDetailId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

PaymentMethod
PaymentMethod string

PaymentMethod

SplitType
SplitType string

SplitType

BankAccountOwner
BankAccountOwner string

BankAccountOwner

BankAccountOwnerName
BankAccountOwnerName string

BankAccountOwnerName

AccountType
AccountType string

AccountType

BankName
BankName string

BankName

BankBranchNo
BankBranchNo string

BankBranchNo

BankAccountNo
BankAccountNo string

BankAccountNo

Reference
Reference string

Reference

IsMainAccount
IsMainAccount boolean

IsMainAccount

Betrag
Amount integer

Betrag

Kommentare
Comments string

Kommentare

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Abrufen eines einzelnen Mitarbeiterdatensatzes

Ruft Mitarbeiterinformationen basierend auf der angegebenen EmployeeId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{EmployeeId}}
EmployeeId True integer

Die EmployeeId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

Title
Title string

Title

Vorname
FirstName string

Vorname

Nachname
LastName string

Nachname

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

MiddleName
MiddleName string

MiddleName

Initials
Initials string

Initials

Email
Email string

Email

Geburtstag
Birthday string

Geburtstag

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Geschlecht
Gender string

Geschlecht

MaritalStatus
MaritalStatus string

MaritalStatus

Rennen
Race string

Rennen

Nationality
Nationality string

Nationality

Staatsbürgerschaft
Citizenship string

Staatsbürgerschaft

DisabledType
DisabledType string

DisabledType

Auslandsnational
ForeignNational boolean

Auslandsnational

DateCreated
DateCreated string

DateCreated

EmergencyContactName
EmergencyContactName string

EmergencyContactName

EmergencyContactNumber
EmergencyContactNumber string

EmergencyContactNumber

EmergencyContactAddress
EmergencyContactAddress string

EmergencyContactAddress

IsRetired
IsRetired boolean

IsRetired

CustomFieldValue
CustomFieldValue string

CustomFieldValue

CustomFieldValue2
CustomFieldValue2 string

CustomFieldValue2

UifExemption
UifExemption string

UifExemption

SdlExemption
SdlExemption string

SdlExemption

EtiExempt
EtiExempt boolean

EtiExempt

ImageDownloadUrl
ImageDownloadUrl string

ImageDownloadUrl

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etikett
CustomFields.Label string

Etikett

Wert
CustomFields.Value string

Wert

Adresse
Address array of object

Adresse

AddressId
Address.AddressId integer

AddressId

Adresstyp
Address.AddressType string

Adresstyp

Mitarbeiternummer
Address.EmployeeNumber string

Mitarbeiternummer

AddressLine1
Address.AddressLine1 string

AddressLine1

AddressLine2
Address.AddressLine2 string

AddressLine2

AddressLine3
Address.AddressLine3 string

AddressLine3

AddressCode
Address.AddressCode string

AddressCode

AddressCountry
Address.AddressCountry string

AddressCountry

Provinz
Address.Province string

Provinz

UnitNumber
Address.UnitNumber string

UnitNumber

Complex
Address.Complex string

Complex

StreetNumber
Address.StreetNumber string

StreetNumber

SameAsPhysical
Address.SameAsPhysical boolean

SameAsPhysical

IsCareofAddress
Address.IsCareofAddress boolean

IsCareofAddress

CareOfIntermediary
Address.CareOfIntermediary string

CareOfIntermediary

SpecialServices
Address.SpecialServices string

SpecialServices

Abrufen eines einzelnen Positionsdatensatzes

Ruft Mitarbeiterpositionsdatensätze basierend auf der angegebenen EmployeePositionId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{EmployeePositionId}}
EmployeePositionId True integer

The EmployeePositionId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

value
value array of object

value

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Mitarbeiternummer
value.EmployeeNumber string

Mitarbeiternummer

FullName
value.FullName string

FullName

EffectiveDate
value.EffectiveDate string

EffectiveDate

OrganizationPosition
value.OrganizationPosition string

OrganizationPosition

OrganizationPositionId
value.OrganizationPositionId integer

OrganizationPositionId

OrganizationPositionWithCode
value.OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
value.PositionType string

PositionType

Grade
value.Grade string

Grade

Berufsstufe
value.OccupationalLevel string

Berufsstufe

DirektReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirektReportsPositionOverride

DirektReportsPosition
value.DirectlyReportsPosition string

DirektReportsPosition

OrganizationGroup
value.OrganizationGroup string

OrganizationGroup

OrganizationGroupDescription
value.OrganizationGroupDescription string

OrganizationGroupDescription

OrganizationGroups
value.OrganizationGroups array of object

OrganizationGroups

OrganizationUnitId
value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId

ParentOrganizationUnitId
value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId

UploadCode
value.OrganizationGroups.UploadCode string

UploadCode

Description
value.OrganizationGroups.Description string

Description

CostCentre
value.OrganizationGroups.CostCentre boolean

CostCentre

OrganizationLevel
value.OrganizationGroups.OrganizationLevel string

OrganizationLevel

GroupGlKey
value.OrganizationGroups.GroupGlKey string

GroupGlKey

Budget
value.OrganizationGroups.Budget integer

Budget

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirektReportsEmployee
value.DirectlyReportsEmployee string

DirektReportsEmployee

DirektReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirektReportsEmployeeNumber

EmploymentCategory
value.EmploymentCategory string

EmploymentCategory

EmploymentSubCategory
value.EmploymentSubCategory string

EmploymentSubCategory

Administrator
value.Administrator string

Administrator

AdministratorEmployeeNumber
value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber

WorkflowRole
value.WorkflowRole string

WorkflowRole

GeneralLedger
value.GeneralLedger string

GeneralLedger

TradeUnion
value.TradeUnion string

TradeUnion

IsPromotion
value.IsPromotion boolean

IsPromotion

Liste
value.Roster string

Liste

Beruf
value.Job string

Beruf

Kommentare
value.Comments string

Kommentare

AltPositionName
value.AltPositionName string

AltPositionName

DateAdded
value.DateAdded string

DateAdded

PositionEffectiveDate
value.PositionEffectiveDate string

PositionEffectiveDate

CustomTradeUnion
value.CustomTradeUnion string

CustomTradeUnion

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etikett
value.CustomFields.Label string

Etikett

Wert
value.CustomFields.Value string

Wert

Aktualisieren eines Datensatzes einer einzelnen Mitarbeiteranlage

Aktualisieren Eines einzelnen Anlagendatensatzes basierend auf der angegebenen AttachmentId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

AttachmentId
AttachmentId True integer

{{AttachmentId}} Die AttachmentId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

response
object

Aktualisieren eines einzelnen Bankdetaildatensatzes

Aktualisieren Sie einen einzelnen Bankdetaildatensatz basierend auf der angegebenen BankdetailId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} Die BankDetailId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

response
object

Aktualisieren eines einzelnen Mitarbeiterdatensatzes

Aktualisieren Sie einen einzelnen Mitarbeiterdatensatz basierend auf der angegebenen EmployeeId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True string

{{company-id}} Die Firmen-ID

{{EmployeeId}}
EmployeeId True string

{{EmployeeId}} Die EmployeeId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Aktualisieren eines einzelnen Positionsdatensatzes

Aktualisieren Sie einen einzelnen Mitarbeiterpositionsdatensatz basierend auf der angegebenen EmployeePositionId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{EmployeePositionId}}
EmployeePositionId True integer

{{EmployeePositionId}} The EmployeePositionId

{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

response
object

Erstellen eines datensatzes einer einzelnen Mitarbeiteranlage

Erstellen Sie einen einzelnen Anlagendatensatz für die angegebene EmployeeNumber.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

Klassifizierung
Classification string

Klassifizierung

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Attachment
Attachment string

Attachment

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etikett
CustomFields.Label string

Etikett

Wert
CustomFields.Value string

Wert

Erstellen eines einzelnen Bankdetaildatensatzes

Erstellen Sie einen einzelnen Mitarbeiter-Bankdetailsdatensatz für die angegebene EmployeeNumber.Create a single employee details record for the specified EmployeeNumber.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

body
body True string
Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

PaymentMethod
PaymentMethod string

PaymentMethod

SplitType
SplitType string

SplitType

BankAccountOwner
BankAccountOwner string

BankAccountOwner

BankAccountOwnerName
BankAccountOwnerName string

BankAccountOwnerName

AccountType
AccountType string

AccountType

BankName
BankName string

BankName

BankBranchNo
BankBranchNo string

BankBranchNo

BankAccountNo
BankAccountNo string

BankAccountNo

Reference
Reference string

Reference

IsMainAccount
IsMainAccount boolean

IsMainAccount

Betrag
Amount integer

Betrag

Kommentare
Comments string

Kommentare

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Erstellen eines einzelnen Beschäftigungsstatusdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterstatusdatensatz für die angegebene EmployeeNumber.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

EmploymentStatusId
EmploymentStatusId integer

EmploymentStatusId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

GroupJoinDate
GroupJoinDate string

GroupJoinDate

Beschäftigungsdatum
EmploymentDate string

Beschäftigungsdatum

Kündigungsdatum
TerminationDate string

Kündigungsdatum

TerminationReason
TerminationReason string

TerminationReason

TaxStatus
TaxStatus string

TaxStatus

TaxReferenceNumber
TaxReferenceNumber string

TaxReferenceNumber

NatureOfPerson
NatureOfPerson string

NatureOfPerson

TaxOffice
TaxOffice integer

TaxOffice

TaxDirectiveNumber
TaxDirectiveNumber string

TaxDirectiveNumber

IT3AReason
IT3AReason integer

IT3AReason

EmploymentAction
EmploymentAction string

EmploymentAction

TerminationCompanyRun
TerminationCompanyRun string

TerminationCompanyRun

IdentityType
IdentityType string

IdentityType

Id-Nummer
IdNumber string

Id-Nummer

PassportNumber
PassportNumber string

PassportNumber

PercentageAmount
PercentageAmount string

PercentageAmount

Betrag
Amount integer

Betrag

Prozentsatz
Percentage integer

Prozentsatz

DeemedMonthlyRemuneration
DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Deemed75Indicator
Deemed75Indicator boolean

Deemed75Indicator

DeemedRecoveryMonthly
DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

EnaveLeave
EncashLeave boolean

EnaveLeave

Irp30
Irp30 boolean

Irp30

FinalizeIssueTaxCert
FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert

PassportCountry
PassportCountry boolean

PassportCountry

PassportIssued
PassportIssued string

PassportIssued

PassportExpiry
PassportExpiry string

PassportExpiry

PermitIssued
PermitIssued string

PermitIssued

PermitExpiry
PermitExpiry string

PermitExpiry

AdditionalDate
AdditionalDate string

AdditionalDate

EmploymentCaptureDate
EmploymentCaptureDate string

EmploymentCaptureDate

TerminationCaptureDate
TerminationCaptureDate string

TerminationCaptureDate

TempWorker
TempWorker boolean

TempWorker

AdditionalDate1
AdditionalDate1 string

AdditionalDate1

NotReEmployable
NotReEmployable boolean

NotReEmployable

ReferenceNumber
ReferenceNumber string

ReferenceNumber

OldEmployeeId
OldEmployeeId integer

OldEmployeeId

Erstellen eines einzelnen Mitarbeiterdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterdatensatz für die angegebene EmployeeNumber.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

Title
Title string

Title

Vorname
FirstName string

Vorname

Nachname
LastName string

Nachname

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

MiddleName
MiddleName string

MiddleName

Initials
Initials string

Initials

Email
Email string

Email

Geburtstag
Birthday string

Geburtstag

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Geschlecht
Gender string

Geschlecht

MaritalStatus
MaritalStatus string

MaritalStatus

Rennen
Race string

Rennen

Nationality
Nationality string

Nationality

Staatsbürgerschaft
Citizenship string

Staatsbürgerschaft

DisabledType
DisabledType string

DisabledType

Auslandsnational
ForeignNational boolean

Auslandsnational

DateCreated
DateCreated string

DateCreated

EmergencyContactName
EmergencyContactName string

EmergencyContactName

EmergencyContactNumber
EmergencyContactNumber string

EmergencyContactNumber

EmergencyContactAddress
EmergencyContactAddress string

EmergencyContactAddress

IsRetired
IsRetired boolean

IsRetired

CustomFieldValue
CustomFieldValue string

CustomFieldValue

CustomFieldValue2
CustomFieldValue2 string

CustomFieldValue2

UifExemption
UifExemption string

UifExemption

SdlExemption
SdlExemption string

SdlExemption

EtiExempt
EtiExempt boolean

EtiExempt

ImageDownloadUrl
ImageDownloadUrl string

ImageDownloadUrl

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etikett
CustomFields.Label string

Etikett

Wert
CustomFields.Value string

Wert

Adresse
Address array of object

Adresse

AddressId
Address.AddressId integer

AddressId

Adresstyp
Address.AddressType string

Adresstyp

Mitarbeiternummer
Address.EmployeeNumber string

Mitarbeiternummer

AddressLine1
Address.AddressLine1 string

AddressLine1

AddressLine2
Address.AddressLine2 string

AddressLine2

AddressLine3
Address.AddressLine3 string

AddressLine3

AddressCode
Address.AddressCode string

AddressCode

AddressCountry
Address.AddressCountry string

AddressCountry

Provinz
Address.Province string

Provinz

UnitNumber
Address.UnitNumber string

UnitNumber

Complex
Address.Complex string

Complex

StreetNumber
Address.StreetNumber string

StreetNumber

SameAsPhysical
Address.SameAsPhysical boolean

SameAsPhysical

IsCareofAddress
Address.IsCareofAddress boolean

IsCareofAddress

CareOfIntermediary
Address.CareOfIntermediary string

CareOfIntermediary

SpecialServices
Address.SpecialServices string

SpecialServices

Erstellen eines einzelnen Positionsdatensatzes

Erstellen Sie einen einzelnen Mitarbeiterpositionsdatensatz für die angegebene EmployeeNumber.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

body
body True string

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

EmployeePositionId
EmployeePositionId integer

EmployeePositionId

Mitarbeiternummer
EmployeeNumber string

Mitarbeiternummer

EffectiveDate
EffectiveDate string

EffectiveDate

OrganizationPosition
OrganizationPosition string

OrganizationPosition

OrganizationPositionWithCode
OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
PositionType string

PositionType

Grade
Grade string

Grade

Berufsstufe
OccupationalLevel string

Berufsstufe

DirektReportsPositionOverride
DirectlyReportsPositionOverride string

DirektReportsPositionOverride

DirektReportsPosition
DirectlyReportsPosition string

DirektReportsPosition

OrganizationGroup
OrganizationGroup string

OrganizationGroup

OrganizationGroups
OrganizationGroups array of

OrganizationGroups

OrganizationRegion
OrganizationRegion string

OrganizationRegion

PayPoint
PayPoint string

PayPoint

DirektReportsEmployee
DirectlyReportsEmployee string

DirektReportsEmployee

DirektReportsEmployeeNumber
DirectlyReportsEmployeeNumber string

DirektReportsEmployeeNumber

EmploymentCategory
EmploymentCategory string

EmploymentCategory

EmploymentSubCategory
EmploymentSubCategory string

EmploymentSubCategory

Administrator
Administrator string

Administrator

AdministratorEmployeeNumber
AdministratorEmployeeNumber string

AdministratorEmployeeNumber

WorkflowRole
WorkflowRole string

WorkflowRole

GeneralLedger
GeneralLedger string

GeneralLedger

TradeUnion
TradeUnion string

TradeUnion

IsPromotion
IsPromotion boolean

IsPromotion

Liste
Roster string

Liste

Beruf
Job string

Beruf

Kommentare
Comments string

Kommentare

AltPositionName
AltPositionName string

AltPositionName

DateAdded
DateAdded string

DateAdded

PositionEffectiveDate
PositionEffectiveDate string

PositionEffectiveDate

CustomTradeUnion
CustomTradeUnion string

CustomTradeUnion

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etikett
CustomFields.Label string

Etikett

Wert
CustomFields.Value string

Wert

Hochladen eines Mitarbeiterfotos

Aktualisieren Sie ein einzelnes Mitarbeiterfoto basierend auf der angegebenen EmployeeId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{EmployeeId}}
EmployeeId True integer

Die EmployeeId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Löschen eines datensatzes für einen einzelnen Mitarbeiteranlagen

Löschen Sie einen einzelnen Anlagendatensatz für Mitarbeiter basierend auf der angegebenen AttachmentId.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

AttachmentId
AttachmentId True integer

{{AttachmentId}} Die AttachmentId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

response
object

Löschen eines einzelnen Bankdetaildatensatzes

Ruft Informationen zur Mitarbeiterbankdetails basierend auf der angegebenen BankDetailId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} Die BankDetailId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

response
object

Mitarbeiterfoto herunterladen

Ruft ein einzelnes Mitarbeiterfoto basierend auf der angegebenen EmployeeId ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
{{company-id}}
company-id True integer

{{company-id}} Die Firmen-ID

{{EmployeeId}}
EmployeeId True integer

Die EmployeeId

Bearertoken
CustomAuthHeader True string

Bearer-Tokenwert (ohne das Schlüsselwort Bearer)

Umgebungsvariable
CustomEnvironmentHeader True string

Variable, die entweder API (für PROD) oder APIstaging (für STAGING) ist

Gibt zurück

Name Pfad Typ Beschreibung
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Definitionen

Objekt

Dies ist der Typ 'object'.