Partager via


PaySpace (éditeur indépendant) (préversion)

Notre solution puissante vous permet d’accéder aux données de vos employés afin d’utiliser dans votre environnement métier. Tous les points de terminaison pris en charge en un seul endroit et prêts à être intégrés à votre solution.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge de Mint PaySpace
URL https://za.mintgroup.net/
Messagerie électronique payspace.support@mintgroup.net
Métadonnées du connecteur
Éditeur Technologies de gestion de menthe
Site internet https://www.payspace.com
Politique de confidentialité https://www.payspace.com/privacy-policy/
Catégories Ressources humaines

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Créer un enregistrement de détail bancaire unique

Créez un enregistrement de détails bancaires d’employé unique pour le Numéro d’employé spécifié.

Créer un enregistrement de pièce jointe d’un seul employé

Créez un enregistrement de pièce jointe unique pour le EmployeeNumber spécifié.

Créer un enregistrement de position unique

Créez un enregistrement de position d’employé unique pour le EmployeeNumber spécifié.

Créer un enregistrement d’état d’emploi unique

Créez un enregistrement d’état d’emploi d’employé unique pour le Numéro d’employé spécifié.

Créer un enregistrement Employé unique

Créez un enregistrement d’employé unique pour le EmployeeNumber spécifié.

Mettre à jour un enregistrement de détail bancaire unique

Mettez à jour un enregistrement de détail bancaire unique en fonction du BankdetailId spécifié.

Mettre à jour un enregistrement de pièce jointe d’un seul employé

Mettez à jour un enregistrement de pièce jointe unique en fonction du AttachmentId spécifié.

Mettre à jour un enregistrement de position unique

Mettez à jour un enregistrement de position d’employé unique en fonction de l’EmployeePositionId spécifié.

Mettre à jour un enregistrement d’employé unique

Mettez à jour un enregistrement d’employé unique en fonction de l’EmployeeId spécifié.

Obtenir un enregistrement de détail bancaire unique

Récupère les informations détaillées de la banque des employés en fonction du BankDetailId spécifié.

Obtenir un enregistrement de pièce jointe d’un seul employé

Récupère les informations de pièce jointe de l’employé en fonction de l’Id de pièce jointe spécifié.

Obtenir un enregistrement de position unique

Récupère les enregistrements de position des employés en fonction de l’EmployeePositionId spécifié.

Obtenir un enregistrement d’employé unique

Récupère les informations d’employé en fonction de l’EmployeeId spécifié.

Obtenir une collection de positions

Récupère une liste des enregistrements de poste des employés à la date du jour et en fonction de la company_id spécifiée.

Obtenir une collection de positions à partir d’une date effective

Récupère une liste des enregistrements de poste des employés à partir de la date d’effet spécifiée et en fonction de la company_id spécifiée.

Obtenir une collection de tous les états d’emploi

Récupère une liste de tous les états d’emploi des employés en fonction de l’ID d’entreprise spécifié.

Obtenir une collection d’employés

Récupère une liste des détails biographiques des employés actifs à partir de la date du jour et en fonction de l’ID d’entreprise spécifié.

Obtenir une collection d’employés à compter d’une date d’effet

Récupère la liste des détails biographiques des employés actifs à partir de la date d’effet spécifiée et en fonction de l’ID d’entreprise spécifié.

Obtenir une collection d’enregistrements de détails bancaires

Récupère la liste des détails bancaires des employés en fonction de la company_id spécifiée.

Obtenir une collection d’enregistrements de pièces jointes Employee

Récupère une liste d’enregistrements de pièces jointes d’employés actifs en fonction de la company_id spécifiée.

Obtenir une collection d’états d’emploi

Récupère une liste des états actuels de l’emploi des employés actifs en fonction de l’ID d’entreprise spécifié.

Supprimer un enregistrement de détail bancaire unique

Récupère les informations détaillées de la banque des employés en fonction du BankDetailId spécifié.

Supprimer un enregistrement de pièce jointe d’un seul employé

Supprimez un enregistrement de pièce jointe d’employé unique en fonction de l’Id de pièce jointe spécifié.

Télécharger la photo de l’employé

Récupère une photo d’employé unique en fonction de l’EmployeeId spécifié.

Télécharger la photo de l’employé

Mettez à jour une photo d’employé unique en fonction de l’EmployeeId spécifié.

Créer un enregistrement de détail bancaire unique

Créez un enregistrement de détails bancaires d’employé unique pour le Numéro d’employé spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

body
body True string
Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

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

Montant
Amount integer

Montant

Commentaires
Comments string

Commentaires

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Créer un enregistrement de pièce jointe d’un seul employé

Créez un enregistrement de pièce jointe unique pour le EmployeeNumber spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

Classification
Classification string

Classification

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Pièce jointe
Attachment string

Pièce jointe

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Étiquette
CustomFields.Label string

Étiquette

Valeur
CustomFields.Value string

Valeur

Créer un enregistrement de position unique

Créez un enregistrement de position d’employé unique pour le EmployeeNumber spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

EmployeePositionId
EmployeePositionId integer

EmployeePositionId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

DateEffet
EffectiveDate string

DateEffet

OrganizationPosition
OrganizationPosition string

OrganizationPosition

OrganizationPositionWithCode
OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
PositionType string

PositionType

Grade
Grade string

Grade

OccupationalLevel
OccupationalLevel string

OccupationalLevel

DirectReportsPositionOverride
DirectlyReportsPositionOverride string

DirectReportsPositionOverride

DirectReportsPosition
DirectlyReportsPosition string

DirectReportsPosition

OrganizationGroup
OrganizationGroup string

OrganizationGroup

OrganizationGroups
OrganizationGroups array of

OrganizationGroups

OrganizationRegion
OrganizationRegion string

OrganizationRegion

PayPoint
PayPoint string

PayPoint

DirectReportsEmployee
DirectlyReportsEmployee string

DirectReportsEmployee

DirectReportsEmployeeNumber
DirectlyReportsEmployeeNumber string

DirectReportsEmployeeNumber

Catégorie d’emploi
EmploymentCategory string

Catégorie d’emploi

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

Job
Job string

Job

Commentaires
Comments string

Commentaires

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

Étiquette
CustomFields.Label string

Étiquette

Valeur
CustomFields.Value string

Valeur

Créer un enregistrement d’état d’emploi unique

Créez un enregistrement d’état d’emploi d’employé unique pour le Numéro d’employé spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

EmploymentStatusId
EmploymentStatusId integer

EmploymentStatusId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

GroupJoinDate
GroupJoinDate string

GroupJoinDate

EmploymentDate
EmploymentDate string

EmploymentDate

TerminationDate
TerminationDate string

TerminationDate

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

IdNumber
IdNumber string

IdNumber

PassportNumber
PassportNumber string

PassportNumber

PourcentageAmount
PercentageAmount string

PourcentageAmount

Montant
Amount integer

Montant

Pourcentage
Percentage integer

Pourcentage

DeemedMonthlyRemuneration
DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Jugé75Indicator
Deemed75Indicator boolean

Jugé75Indicator

DeemedRecoveryMonthly
DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

En encoderLeave
EncashLeave boolean

En encoderLeave

Irp30
Irp30 boolean

Irp30

FinaliseIssueTaxCert
FinalizeIssueTaxCert boolean

FinaliseIssueTaxCert

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

Créer un enregistrement Employé unique

Créez un enregistrement d’employé unique pour le EmployeeNumber spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

Titre
Title string

Titre

Prénom
FirstName string

Prénom

nom de famille
LastName string

nom de famille

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

MiddleName
MiddleName string

MiddleName

Initials
Initials string

Initials

Messagerie électronique
Email string

Messagerie électronique

Date de naissance
Birthday string

Date de naissance

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Gender
Gender string

Gender

MaritalStatus
MaritalStatus string

MaritalStatus

Course
Race string

Course

Nationalité
Nationality string

Nationalité

Citoyenneté
Citizenship string

Citoyenneté

DisabledType
DisabledType string

DisabledType

ForeignNational
ForeignNational boolean

ForeignNational

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

Étiquette
CustomFields.Label string

Étiquette

Valeur
CustomFields.Value string

Valeur

Adresse
Address array of object

Adresse

AddressId
Address.AddressId integer

AddressId

AddressType
Address.AddressType string

AddressType

EmployeeNumber
Address.EmployeeNumber string

EmployeeNumber

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

Province
Address.Province string

Province

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

Mettre à jour un enregistrement de détail bancaire unique

Mettez à jour un enregistrement de détail bancaire unique en fonction du BankdetailId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} The BankDetailId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

response
object

Mettre à jour un enregistrement de pièce jointe d’un seul employé

Mettez à jour un enregistrement de pièce jointe unique en fonction du AttachmentId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

AttachmentId
AttachmentId True integer

{{AttachmentId}} The AttachmentId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

response
object

Mettre à jour un enregistrement de position unique

Mettez à jour un enregistrement de position d’employé unique en fonction de l’EmployeePositionId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{EmployeePositionId}}
EmployeePositionId True integer

{{EmployeePositionId}} The EmployeePositionId

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

response
object

Mettre à jour un enregistrement d’employé unique

Mettez à jour un enregistrement d’employé unique en fonction de l’EmployeeId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True string

{{company-id}} ID d’entreprise

{{EmployeeId}}
EmployeeId True string

{{EmployeeId}} The EmployeeId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

body
body True string

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Obtenir un enregistrement de détail bancaire unique

Récupère les informations détaillées de la banque des employés en fonction du BankDetailId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{BankDetailId}}
BankDetailId True integer

The BankDetailId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

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

Montant
Amount integer

Montant

Commentaires
Comments string

Commentaires

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Obtenir un enregistrement de pièce jointe d’un seul employé

Récupère les informations de pièce jointe de l’employé en fonction de l’Id de pièce jointe spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{AttachmentId}}
AttachmentId True integer

The AttachmentId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

Classification
Classification string

Classification

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Pièce jointe
Attachment string

Pièce jointe

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Étiquette
CustomFields.Label string

Étiquette

Valeur
CustomFields.Value string

Valeur

Obtenir un enregistrement de position unique

Récupère les enregistrements de position des employés en fonction de l’EmployeePositionId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{EmployeePositionId}}
EmployeePositionId True integer

The EmployeePositionId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

FullName
value.FullName string

FullName

DateEffet
value.EffectiveDate string

DateEffet

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

OccupationalLevel
value.OccupationalLevel string

OccupationalLevel

DirectReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectReportsPositionOverride

DirectReportsPosition
value.DirectlyReportsPosition string

DirectReportsPosition

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

Descriptif
value.OrganizationGroups.Description string

Descriptif

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

InactifDate
value.OrganizationGroups.InactiveDate string

InactifDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirectReportsEmployee
value.DirectlyReportsEmployee string

DirectReportsEmployee

DirectReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectReportsEmployeeNumber

Catégorie d’emploi
value.EmploymentCategory string

Catégorie d’emploi

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

Job
value.Job string

Job

Commentaires
value.Comments string

Commentaires

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Obtenir un enregistrement d’employé unique

Récupère les informations d’employé en fonction de l’EmployeeId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{EmployeeId}}
EmployeeId True integer

The EmployeeId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

EmployeeNumber
EmployeeNumber string

EmployeeNumber

Titre
Title string

Titre

Prénom
FirstName string

Prénom

nom de famille
LastName string

nom de famille

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

MiddleName
MiddleName string

MiddleName

Initials
Initials string

Initials

Messagerie électronique
Email string

Messagerie électronique

Date de naissance
Birthday string

Date de naissance

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Gender
Gender string

Gender

MaritalStatus
MaritalStatus string

MaritalStatus

Course
Race string

Course

Nationalité
Nationality string

Nationalité

Citoyenneté
Citizenship string

Citoyenneté

DisabledType
DisabledType string

DisabledType

ForeignNational
ForeignNational boolean

ForeignNational

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

Étiquette
CustomFields.Label string

Étiquette

Valeur
CustomFields.Value string

Valeur

Adresse
Address array of object

Adresse

AddressId
Address.AddressId integer

AddressId

AddressType
Address.AddressType string

AddressType

EmployeeNumber
Address.EmployeeNumber string

EmployeeNumber

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

Province
Address.Province string

Province

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

Obtenir une collection de positions

Récupère une liste des enregistrements de poste des employés à la date du jour et en fonction de la company_id spécifiée.

Paramètres

Nom Clé Obligatoire Type Description
$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

$expand facultatif
$expand True string

Facultatif : pour retourner les données de champ OrganizationGroups, utilisez la valeur « OrganizationGroups »

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

FullName
value.FullName string

FullName

DateEffet
value.EffectiveDate string

DateEffet

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

OccupationalLevel
value.OccupationalLevel string

OccupationalLevel

DirectReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectReportsPositionOverride

DirectReportsPosition
value.DirectlyReportsPosition string

DirectReportsPosition

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

Descriptif
value.OrganizationGroups.Description string

Descriptif

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

InactifDate
value.OrganizationGroups.InactiveDate string

InactifDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirectReportsEmployee
value.DirectlyReportsEmployee string

DirectReportsEmployee

DirectReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectReportsEmployeeNumber

Catégorie d’emploi
value.EmploymentCategory string

Catégorie d’emploi

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

Job
value.Job string

Job

Commentaires
value.Comments string

Commentaires

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Obtenir une collection de positions à partir d’une date effective

Récupère une liste des enregistrements de poste des employés à partir de la date d’effet spécifiée et en fonction de la company_id spécifiée.

Paramètres

Nom Clé Obligatoire Type Description
{{$employee-field}}
$orderby True string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$expand facultatif
$expand True string

Facultatif : pour retourner les données de champ OrganizationGroups, utilisez la valeur « OrganizationGroups »

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

{{company-id}} ID d’entreprise

effectivedate
effectivedate True string

Date d’effet mise en forme dans AAAA-MM-DD. Eg. 2022-01-15

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

FullName
value.FullName string

FullName

DateEffet
value.EffectiveDate string

DateEffet

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

OccupationalLevel
value.OccupationalLevel string

OccupationalLevel

DirectReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectReportsPositionOverride

DirectReportsPosition
value.DirectlyReportsPosition string

DirectReportsPosition

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

Descriptif
value.OrganizationGroups.Description string

Descriptif

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

InactifDate
value.OrganizationGroups.InactiveDate string

InactifDate

OrganizationRegion
value.OrganizationRegion string

OrganizationRegion

PayPoint
value.PayPoint string

PayPoint

DirectReportsEmployee
value.DirectlyReportsEmployee string

DirectReportsEmployee

DirectReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectReportsEmployeeNumber

Catégorie d’emploi
value.EmploymentCategory string

Catégorie d’emploi

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

Job
value.Job string

Job

Commentaires
value.Comments string

Commentaires

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Obtenir une collection de tous les états d’emploi

Récupère une liste de tous les états d’emploi des employés en fonction de l’ID d’entreprise spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{$employee-field}}
$orderby string

Facultatif (chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

EmploymentDate
value.EmploymentDate string

EmploymentDate

TerminationDate
value.TerminationDate string

TerminationDate

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

IdNumber
value.IdNumber string

IdNumber

PassportNumber
value.PassportNumber string

PassportNumber

PourcentageAmount
value.PercentageAmount string

PourcentageAmount

Montant
value.Amount integer

Montant

Pourcentage
value.Percentage integer

Pourcentage

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Jugé75Indicator
value.Deemed75Indicator boolean

Jugé75Indicator

DeemedRecoveryMonthly
value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

En encoderLeave
value.EncashLeave boolean

En encoderLeave

Irp30
value.Irp30 boolean

Irp30

FinaliseIssueTaxCert
value.FinalizeIssueTaxCert boolean

FinaliseIssueTaxCert

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Obtenir une collection d’employés

Récupère une liste des détails biographiques des employés actifs à partir de la date du jour et en fonction de l’ID d’entreprise spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

Facultatif par {{$employee-field}}
$orderby string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Facultatif : filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

$select facultatif
$select string

Facultatif (chaîne) : retourne uniquement les champs spécifiés

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

Titre
value.Title string

Titre

Prénom
value.FirstName string

Prénom

nom de famille
value.LastName string

nom de famille

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

MiddleName
value.MiddleName string

MiddleName

Initials
value.Initials string

Initials

Messagerie électronique
value.Email string

Messagerie électronique

Date de naissance
value.Birthday string

Date de naissance

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

Gender
value.Gender string

Gender

MaritalStatus
value.MaritalStatus string

MaritalStatus

Course
value.Race string

Course

Nationalité
value.Nationality string

Nationalité

Citoyenneté
value.Citizenship string

Citoyenneté

DisabledType
value.DisabledType string

DisabledType

ForeignNational
value.ForeignNational boolean

ForeignNational

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Adresse
value.Address array of object

Adresse

AddressId
value.Address.AddressId integer

AddressId

AddressType
value.Address.AddressType string

AddressType

EmployeeNumber
value.Address.EmployeeNumber string

EmployeeNumber

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

Province
value.Address.Province string

Province

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

Obtenir une collection d’employés à compter d’une date d’effet

Récupère la liste des détails biographiques des employés actifs à partir de la date d’effet spécifiée et en fonction de l’ID d’entreprise spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

effectivedate
effectivedate True string

Date d’effet mise en forme dans AAAA-MM-DD. Eg. 2022-01-15

Facultatif par {{$employee-field}}
$orderby string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string
  • Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »
Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

Titre
value.Title string

Titre

Prénom
value.FirstName string

Prénom

nom de famille
value.LastName string

nom de famille

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

MiddleName
value.MiddleName string

MiddleName

Initials
value.Initials string

Initials

Messagerie électronique
value.Email string

Messagerie électronique

Date de naissance
value.Birthday string

Date de naissance

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

Gender
value.Gender string

Gender

MaritalStatus
value.MaritalStatus string

MaritalStatus

Course
value.Race string

Course

Nationalité
value.Nationality string

Nationalité

Citoyenneté
value.Citizenship string

Citoyenneté

TaxRefNumber
value.TaxRefNumber string

TaxRefNumber

Disabled
value.Disabled boolean

Disabled

DisabledType
value.DisabledType string

DisabledType

EthnicGroup
value.EthnicGroup string

EthnicGroup

ForeignNational
value.ForeignNational boolean

ForeignNational

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Adresse
value.Address array of object

Adresse

AddressId
value.Address.AddressId integer

AddressId

AddressType
value.Address.AddressType string

AddressType

EmployeeNumber
value.Address.EmployeeNumber string

EmployeeNumber

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

Province
value.Address.Province string

Province

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

Obtenir une collection d’enregistrements de détails bancaires

Récupère la liste des détails bancaires des employés en fonction de la company_id spécifiée.

Paramètres

Nom Clé Obligatoire Type Description
Facultatif par {{$bank-detail-field}}
$orderby True string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top string

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True string

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

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

Montant
value.Amount integer

Montant

Commentaires
value.Comments string

Commentaires

SwiftCode
value.SwiftCode string

SwiftCode

RoutingCode
value.RoutingCode string

RoutingCode

ComponentId
value.ComponentId integer

ComponentId

Obtenir une collection d’enregistrements de pièces jointes Employee

Récupère une liste d’enregistrements de pièces jointes d’employés actifs en fonction de la company_id spécifiée.

Paramètres

Nom Clé Obligatoire Type Description
Facultatif par {{$attachment-field}}
$orderby string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

Classification
value.Classification string

Classification

AttachmentDescription
value.AttachmentDescription string

AttachmentDescription

AttachmentName
value.AttachmentName string

AttachmentName

AttachmentUrl
value.AttachmentUrl string

AttachmentUrl

Pièce jointe
value.Attachment string

Pièce jointe

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Obtenir une collection d’états d’emploi

Récupère une liste des états actuels de l’emploi des employés actifs en fonction de l’ID d’entreprise spécifié.

Paramètres

Nom Clé Obligatoire Type Description
Facultatif par {{$employee-field}}
$orderby string

(chaîne) : spécifie l’ordre dans lequel les éléments sont retournés

$top facultatif
$top integer

(integer($int 32)) : limite le nombre d’éléments retournés par une collection

$skip facultatif
$skip True integer

(integer($int 32)) : exclut le nombre spécifié d’éléments de la collection interrogée à partir du résultat

$count facultatif
$count True string

(true/false) - Nombre total de retours en réponse

$filter facultatif
$filter string

Filtrer par champ, par exemple. « EmployeeNumber eq 'Emp01' »

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

{{company-id}} ID d’entreprise

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@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

EmployeeNumber
value.EmployeeNumber string

EmployeeNumber

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

EmploymentDate
value.EmploymentDate string

EmploymentDate

TerminationDate
value.TerminationDate string

TerminationDate

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

IdNumber
value.IdNumber string

IdNumber

PassportNumber
value.PassportNumber string

PassportNumber

PourcentageAmount
value.PercentageAmount string

PourcentageAmount

Montant
value.Amount integer

Montant

Pourcentage
value.Percentage integer

Pourcentage

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Jugé75Indicator
value.Deemed75Indicator boolean

Jugé75Indicator

DeemedRecoveryMonthly
value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly

En encoderLeave
value.EncashLeave boolean

En encoderLeave

Irp30
value.Irp30 boolean

Irp30

FinaliseIssueTaxCert
value.FinalizeIssueTaxCert boolean

FinaliseIssueTaxCert

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

Étiquette
value.CustomFields.Label string

Étiquette

Valeur
value.CustomFields.Value string

Valeur

Supprimer un enregistrement de détail bancaire unique

Récupère les informations détaillées de la banque des employés en fonction du BankDetailId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} The BankDetailId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

response
object

Supprimer un enregistrement de pièce jointe d’un seul employé

Supprimez un enregistrement de pièce jointe d’employé unique en fonction de l’Id de pièce jointe spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

AttachmentId
AttachmentId True integer

{{AttachmentId}} The AttachmentId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

response
object

Télécharger la photo de l’employé

Récupère une photo d’employé unique en fonction de l’EmployeeId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{EmployeeId}}
EmployeeId True integer

The EmployeeId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Télécharger la photo de l’employé

Mettez à jour une photo d’employé unique en fonction de l’EmployeeId spécifié.

Paramètres

Nom Clé Obligatoire Type Description
{{company-id}}
company-id True integer

{{company-id}} ID d’entreprise

{{EmployeeId}}
EmployeeId True integer

The EmployeeId

Jeton du porteur
CustomAuthHeader True string

Valeur du jeton du porteur (sans porteur de mot clé)

Variable d’environnement
CustomEnvironmentHeader True string

Variable qui est api (pour PROD) ou apistaging (pour STAGING)

Retours

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Définitions

objet

Il s’agit du type 'object'.