Delen via


PaySpace (onafhankelijke uitgever) (preview)

Met onze krachtige oplossing hebt u toegang tot uw werknemersgegevens om deze in uw bedrijfsomgeving te kunnen gebruiken. Alle ondersteunde eindpunten op één plaats en klaar om te worden geïntegreerd in uw oplossing.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Ondersteuning voor Mint PaySpace
URL https://za.mintgroup.net/
E-mailen payspace.support@mintgroup.net
Connectormetagegevens
Uitgever Mint Management Technologies
Webpagina https://www.payspace.com
Privacybeleid https://www.payspace.com/privacy-policy/
Categorieën Personeel

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Een record met één positie bijwerken

Werk één werknemerspositierecord bij op basis van de opgegeven EmployeePositionId.

Een record met één positie maken

Maak één werknemerspositierecord voor het opgegeven EmployeeNumber.

Een record met één positie ophalen

Hiermee worden positierecords van werknemers opgehaald op basis van de opgegeven EmployeePositionId.

Een verzameling bankgegevensrecords ophalen

Hiermee wordt een lijst met bankgegevens van werknemers opgehaald op basis van de opgegeven company_id.

Een verzameling bijlagerecords van werknemers ophalen

Hiermee wordt een lijst met actieve bijlagerecords van werknemers opgehaald op basis van de opgegeven company_id.

Een verzameling posities ophalen

Haalt een lijst met werknemerspositierecords op vanaf de datum van vandaag en op basis van de opgegeven company_id.

Een verzameling posities ophalen vanaf een ingangsdatum

Haalt een lijst met werknemerspositierecords op vanaf de opgegeven ingangsdatum en op basis van de opgegeven company_id.

Een verzameling van alle arbeidsstatussen ophalen

Hiermee wordt een lijst opgehaald met alle werknemersstatussen op basis van de opgegeven bedrijfs-id.

Een verzameling werkgelegenheidsstatussen ophalen

Hiermee wordt een lijst opgehaald met de huidige actieve werknemersstatussen op basis van de opgegeven bedrijfs-id.

Een verzameling werknemers ophalen

Haalt een lijst met actieve werknemers biografische gegevens op vanaf de datum van vandaag en op basis van de opgegeven bedrijfs-id.

Een verzameling werknemers ophalen vanaf een ingangsdatum

Haalt een lijst met actieve werknemers biografische gegevens op vanaf de opgegeven ingangsdatum en op basis van de opgegeven bedrijfs-id.

Eén bankgegevensrecord bijwerken

Werk één bankgegevensrecord bij op basis van de opgegeven BankdetailId.

Eén bankgegevensrecord maken

Maak één bankgegevensrecord voor één werknemer voor het opgegeven EmployeeNumber.

Eén bankgegevensrecord ophalen

Hiermee haalt u gegevens van de bankgegevens van werknemers op op basis van de opgegeven BankDetailId.

Eén bankgegevensrecord verwijderen

Hiermee haalt u gegevens van de bankgegevens van werknemers op op basis van de opgegeven BankDetailId.

Eén bijlagerecord voor werknemers bijwerken

Werk één bijlagerecord bij op basis van de opgegeven AttachmentId.

Eén bijlagerecord voor werknemers maken

Maak één bijlagerecord voor het opgegeven EmployeeNumber.

Eén bijlagerecord voor werknemers ophalen

Hiermee haalt u gegevens van werknemersbijlagen op op basis van de opgegeven AttachmentId.

Eén bijlagerecord voor werknemers verwijderen

Eén bijlagerecord voor werknemers verwijderen op basis van de opgegeven AttachmentId.

Eén record voor de status van de werkgelegenheid maken

Maak één werknemerstatusrecord voor het opgegeven EmployeeNumber.

Eén werknemerrecord maken

Maak één werknemerrecord voor het opgegeven EmployeeNumber.

Eén werknemersrecord bijwerken

Werk één werknemerrecord bij op basis van de opgegeven EmployeeId.

Eén werknemersrecord ophalen

Hiermee worden werknemersgegevens opgehaald op basis van de opgegeven EmployeeId.

Foto van werknemer uploaden

Werk één werknemersfoto bij op basis van de opgegeven EmployeeId.

Werknemersfoto downloaden

Haalt één werknemersfoto op op basis van de opgegeven EmployeeId.

Een record met één positie bijwerken

Werk één werknemerspositierecord bij op basis van de opgegeven EmployeePositionId.

Parameters

Name Sleutel Vereist Type Description
{{EmployeePositionId}}
EmployeePositionId True integer

{{EmployeePositionId}} De EmployeePositionId

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

response
object

Een record met één positie maken

Maak één werknemerspositierecord voor het opgegeven EmployeeNumber.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

EmployeePositionId
EmployeePositionId integer

EmployeePositionId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

Ingangsdatum
EffectiveDate string

Ingangsdatum

OrganizationPosition
OrganizationPosition string

OrganizationPosition

OrganizationPositionWithCode
OrganizationPositionWithCode string

OrganizationPositionWithCode

PositionType
PositionType string

PositionType

Grade
Grade string

Grade

Beroepsniveau
OccupationalLevel string

Beroepsniveau

DirectlyReportsPositionOverride
DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride

DirectlyReportsPosition
DirectlyReportsPosition string

DirectlyReportsPosition

OrganizationGroup
OrganizationGroup string

OrganizationGroup

OrganizationGroups
OrganizationGroups array of

OrganizationGroups

Organisatieregio
OrganizationRegion string

Organisatieregio

PayPoint
PayPoint string

PayPoint

DirectlyReportsEmployee
DirectlyReportsEmployee string

DirectlyReportsEmployee

DirectlyReportsEmployeeNumber
DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber

Werkgelegenheidscategorie
EmploymentCategory string

Werkgelegenheidscategorie

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

Rooster
Roster string

Rooster

Job
Job string

Job

Comments
Comments string

Comments

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

Etiket
CustomFields.Label string

Etiket

Waarde
CustomFields.Value string

Waarde

Een record met één positie ophalen

Hiermee worden positierecords van werknemers opgehaald op basis van de opgegeven EmployeePositionId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{EmployeePositionId}}
EmployeePositionId True integer

De EmployeePositionId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

FullName
value.FullName string

FullName

Ingangsdatum
value.EffectiveDate string

Ingangsdatum

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

Beroepsniveau
value.OccupationalLevel string

Beroepsniveau

DirectlyReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride

DirectlyReportsPosition
value.DirectlyReportsPosition string

DirectlyReportsPosition

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

Begroting
value.OrganizationGroups.Budget integer

Begroting

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

Organisatieregio
value.OrganizationRegion string

Organisatieregio

PayPoint
value.PayPoint string

PayPoint

DirectlyReportsEmployee
value.DirectlyReportsEmployee string

DirectlyReportsEmployee

DirectlyReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber

Werkgelegenheidscategorie
value.EmploymentCategory string

Werkgelegenheidscategorie

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

Rooster
value.Roster string

Rooster

Job
value.Job string

Job

Comments
value.Comments string

Comments

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

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling bankgegevensrecords ophalen

Hiermee wordt een lijst met bankgegevens van werknemers opgehaald op basis van de opgegeven company_id.

Parameters

Name Sleutel Vereist Type Description
Optioneel op {{$bank-detail-field}}
$orderby True string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top string

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True string

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

BankDetailId
value.BankDetailId integer

BankDetailId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

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

Banknaam
value.BankName string

Banknaam

BankBranchNo
value.BankBranchNo string

BankBranchNo

BankAccountNo
value.BankAccountNo string

BankAccountNo

Reference
value.Reference string

Reference

IsMainAccount
value.IsMainAccount boolean

IsMainAccount

Aantal
value.Amount integer

Aantal

Comments
value.Comments string

Comments

SwiftCode
value.SwiftCode string

SwiftCode

RoutingCode
value.RoutingCode string

RoutingCode

ComponentId
value.ComponentId integer

ComponentId

Een verzameling bijlagerecords van werknemers ophalen

Hiermee wordt een lijst met actieve bijlagerecords van werknemers opgehaald op basis van de opgegeven company_id.

Parameters

Name Sleutel Vereist Type Description
Optioneel op {{$attachment-field}}
$orderby string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

AttachmentId
value.AttachmentId integer

AttachmentId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

Classification
value.Classification string

Classification

AttachmentDescription
value.AttachmentDescription string

AttachmentDescription

AttachmentName
value.AttachmentName string

AttachmentName

AttachmentUrl
value.AttachmentUrl string

AttachmentUrl

Bijlage
value.Attachment string

Bijlage

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling posities ophalen

Haalt een lijst met werknemerspositierecords op vanaf de datum van vandaag en op basis van de opgegeven company_id.

Parameters

Name Sleutel Vereist Type Description
Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

Optionele $expand
$expand True string

Optioneel: als u de veldgegevens OrganizationGroups wilt retourneren, gebruikt u de waarde 'OrganizationGroups'

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

FullName
value.FullName string

FullName

Ingangsdatum
value.EffectiveDate string

Ingangsdatum

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

Beroepsniveau
value.OccupationalLevel string

Beroepsniveau

DirectlyReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride

DirectlyReportsPosition
value.DirectlyReportsPosition string

DirectlyReportsPosition

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

Begroting
value.OrganizationGroups.Budget integer

Begroting

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

Organisatieregio
value.OrganizationRegion string

Organisatieregio

PayPoint
value.PayPoint string

PayPoint

DirectlyReportsEmployee
value.DirectlyReportsEmployee string

DirectlyReportsEmployee

DirectlyReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber

Werkgelegenheidscategorie
value.EmploymentCategory string

Werkgelegenheidscategorie

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

Rooster
value.Roster string

Rooster

Job
value.Job string

Job

Comments
value.Comments string

Comments

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

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling posities ophalen vanaf een ingangsdatum

Haalt een lijst met werknemerspositierecords op vanaf de opgegeven ingangsdatum en op basis van de opgegeven company_id.

Parameters

Name Sleutel Vereist Type Description
{{$employee-field}}
$orderby True string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $expand
$expand True string

Optioneel: als u de veldgegevens OrganizationGroups wilt retourneren, gebruikt u de waarde 'OrganizationGroups'

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

{{company-id}} De bedrijfs-id

effectivedate
effectivedate True string

Datum die is opgemaakt in JJJJ-MM-DD. bijvoorbeeld 2022-01-15

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmployeePositionId
value.EmployeePositionId integer

EmployeePositionId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

FullName
value.FullName string

FullName

Ingangsdatum
value.EffectiveDate string

Ingangsdatum

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

Beroepsniveau
value.OccupationalLevel string

Beroepsniveau

DirectlyReportsPositionOverride
value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride

DirectlyReportsPosition
value.DirectlyReportsPosition string

DirectlyReportsPosition

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

Begroting
value.OrganizationGroups.Budget integer

Begroting

Reference
value.OrganizationGroups.Reference string

Reference

ManagerEmployeeNumber
value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber

InactiveDate
value.OrganizationGroups.InactiveDate string

InactiveDate

Organisatieregio
value.OrganizationRegion string

Organisatieregio

PayPoint
value.PayPoint string

PayPoint

DirectlyReportsEmployee
value.DirectlyReportsEmployee string

DirectlyReportsEmployee

DirectlyReportsEmployeeNumber
value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber

Werkgelegenheidscategorie
value.EmploymentCategory string

Werkgelegenheidscategorie

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

Rooster
value.Roster string

Rooster

Job
value.Job string

Job

Comments
value.Comments string

Comments

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

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling van alle arbeidsstatussen ophalen

Hiermee wordt een lijst opgehaald met alle werknemersstatussen op basis van de opgegeven bedrijfs-id.

Parameters

Name Sleutel Vereist Type Description
{{$employee-field}}
$orderby string

Optioneel (tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmploymentStatusId
value.EmploymentStatusId integer

EmploymentStatusId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

EmploymentDate
value.EmploymentDate string

EmploymentDate

Beëindigingdatum
value.TerminationDate string

Beëindigingdatum

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

BeëindigingBedrijfRun
value.TerminationCompanyRun string

BeëindigingBedrijfRun

IdentityType
value.IdentityType string

IdentityType

Identificatienummer
value.IdNumber string

Identificatienummer

PassportNumber
value.PassportNumber string

PassportNumber

PercentageAmount
value.PercentageAmount string

PercentageAmount

Aantal
value.Amount integer

Aantal

Procent
value.Percentage integer

Procent

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Geachte 75Indicator
value.Deemed75Indicator boolean

Geachte 75Indicator

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

NotRePloyable
value.NotReEmployable boolean

NotRePloyable

ReferenceNumber
value.ReferenceNumber string

ReferenceNumber

OldEmployeeId
value.OldEmployeeId integer

OldEmployeeId

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling werkgelegenheidsstatussen ophalen

Hiermee wordt een lijst opgehaald met de huidige actieve werknemersstatussen op basis van de opgegeven bedrijfs-id.

Parameters

Name Sleutel Vereist Type Description
Optioneel per {{$employee-field}}
$orderby string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

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

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmploymentStatusId
value.EmploymentStatusId integer

EmploymentStatusId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

GroupJoinDate
value.GroupJoinDate string

GroupJoinDate

EmploymentDate
value.EmploymentDate string

EmploymentDate

Beëindigingdatum
value.TerminationDate string

Beëindigingdatum

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

BeëindigingBedrijfRun
value.TerminationCompanyRun string

BeëindigingBedrijfRun

IdentityType
value.IdentityType string

IdentityType

Identificatienummer
value.IdNumber string

Identificatienummer

PassportNumber
value.PassportNumber string

PassportNumber

PercentageAmount
value.PercentageAmount string

PercentageAmount

Aantal
value.Amount integer

Aantal

Procent
value.Percentage integer

Procent

DeemedMonthlyRemuneration
value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Geachte 75Indicator
value.Deemed75Indicator boolean

Geachte 75Indicator

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

NotRePloyable
value.NotReEmployable boolean

NotRePloyable

ReferenceNumber
value.ReferenceNumber string

ReferenceNumber

OldEmployeeId
value.OldEmployeeId integer

OldEmployeeId

CustomFields
value.CustomFields array of object

CustomFields

Code
value.CustomFields.Code string

Code

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Een verzameling werknemers ophalen

Haalt een lijst met actieve werknemers biografische gegevens op vanaf de datum van vandaag en op basis van de opgegeven bedrijfs-id.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

Optioneel per {{$employee-field}}
$orderby string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string

Optioneel - Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"

Optionele $select
$select string

Optioneel (tekenreeks): retourneert alleen de opgegeven velden

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmployeeId
value.EmployeeId integer

EmployeeId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

Title
value.Title string

Title

Voornaam
value.FirstName string

Voornaam

Achternaam
value.LastName string

Achternaam

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

Middelste naam
value.MiddleName string

Middelste naam

Initialen
value.Initials string

Initialen

E-mailen
value.Email string

E-mailen

Verjaardag
value.Birthday string

Verjaardag

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

Geslacht
value.Gender string

Geslacht

MaritalStatus
value.MaritalStatus string

MaritalStatus

Ras
value.Race string

Ras

Nationality
value.Nationality string

Nationality

Burgerschap
value.Citizenship string

Burgerschap

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

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Adres
value.Address array of object

Adres

AddressId
value.Address.AddressId integer

AddressId

AddressType
value.Address.AddressType string

AddressType

Medewerkernummer
value.Address.EmployeeNumber string

Medewerkernummer

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

Provincie
value.Address.Province string

Provincie

UnitNumber
value.Address.UnitNumber string

UnitNumber

Ingewikkeld
value.Address.Complex string

Ingewikkeld

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

Een verzameling werknemers ophalen vanaf een ingangsdatum

Haalt een lijst met actieve werknemers biografische gegevens op vanaf de opgegeven ingangsdatum en op basis van de opgegeven bedrijfs-id.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

effectivedate
effectivedate True string

Datum die is opgemaakt in JJJJ-MM-DD. bijvoorbeeld 2022-01-15

Optioneel per {{$employee-field}}
$orderby string

(tekenreeks) - Hiermee geeft u de volgorde op waarin items worden geretourneerd

Optionele $top
$top integer

(integer($int 32)) - Beperkt het aantal items dat wordt geretourneerd uit een verzameling

Optionele $skip
$skip True integer

(integer($int 32)) - Hiermee wordt het opgegeven aantal items van de opgevraagde verzameling uitgesloten van het resultaat

Optionele $count
$count True string

(waar/onwaar) - Totaalaantal in antwoord retourneren

Optionele $filter
$filter string
  • Filteren op veld bijvoorbeeld "EmployeeNumber eq 'Emp01'"
Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

@odata.count
@odata.count integer

@odata.count

waarde
value array of object

waarde

EmployeeId
value.EmployeeId integer

EmployeeId

Medewerkernummer
value.EmployeeNumber string

Medewerkernummer

Title
value.Title string

Title

Voornaam
value.FirstName string

Voornaam

Achternaam
value.LastName string

Achternaam

PreferredName
value.PreferredName string

PreferredName

MaidenName
value.MaidenName string

MaidenName

Middelste naam
value.MiddleName string

Middelste naam

Initialen
value.Initials string

Initialen

E-mailen
value.Email string

E-mailen

Verjaardag
value.Birthday string

Verjaardag

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

Geslacht
value.Gender string

Geslacht

MaritalStatus
value.MaritalStatus string

MaritalStatus

Ras
value.Race string

Ras

Nationality
value.Nationality string

Nationality

Burgerschap
value.Citizenship string

Burgerschap

TaxRefNumber
value.TaxRefNumber string

TaxRefNumber

Disabled
value.Disabled boolean

Disabled

DisabledType
value.DisabledType string

DisabledType

Etnische groep
value.EthnicGroup string

Etnische groep

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

Etiket
value.CustomFields.Label string

Etiket

Waarde
value.CustomFields.Value string

Waarde

Adres
value.Address array of object

Adres

AddressId
value.Address.AddressId integer

AddressId

AddressType
value.Address.AddressType string

AddressType

Medewerkernummer
value.Address.EmployeeNumber string

Medewerkernummer

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

Provincie
value.Address.Province string

Provincie

UnitNumber
value.Address.UnitNumber string

UnitNumber

Ingewikkeld
value.Address.Complex string

Ingewikkeld

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

Eén bankgegevensrecord bijwerken

Werk één bankgegevensrecord bij op basis van de opgegeven BankdetailId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} De BankDetailId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

response
object

Eén bankgegevensrecord maken

Maak één bankgegevensrecord voor één werknemer voor het opgegeven EmployeeNumber.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

body
body True string
Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

PaymentMethod
PaymentMethod string

PaymentMethod

SplitType
SplitType string

SplitType

BankAccountOwner
BankAccountOwner string

BankAccountOwner

BankAccountOwnerName
BankAccountOwnerName string

BankAccountOwnerName

AccountType
AccountType string

AccountType

Banknaam
BankName string

Banknaam

BankBranchNo
BankBranchNo string

BankBranchNo

BankAccountNo
BankAccountNo string

BankAccountNo

Reference
Reference string

Reference

IsMainAccount
IsMainAccount boolean

IsMainAccount

Aantal
Amount integer

Aantal

Comments
Comments string

Comments

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Eén bankgegevensrecord ophalen

Hiermee haalt u gegevens van de bankgegevens van werknemers op op basis van de opgegeven BankDetailId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{BankDetailId}}
BankDetailId True integer

De BankDetailId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

BankDetailId
BankDetailId integer

BankDetailId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

PaymentMethod
PaymentMethod string

PaymentMethod

SplitType
SplitType string

SplitType

BankAccountOwner
BankAccountOwner string

BankAccountOwner

BankAccountOwnerName
BankAccountOwnerName string

BankAccountOwnerName

AccountType
AccountType string

AccountType

Banknaam
BankName string

Banknaam

BankBranchNo
BankBranchNo string

BankBranchNo

BankAccountNo
BankAccountNo string

BankAccountNo

Reference
Reference string

Reference

IsMainAccount
IsMainAccount boolean

IsMainAccount

Aantal
Amount integer

Aantal

Comments
Comments string

Comments

SwiftCode
SwiftCode string

SwiftCode

RoutingCode
RoutingCode string

RoutingCode

ComponentId
ComponentId integer

ComponentId

Eén bankgegevensrecord verwijderen

Hiermee haalt u gegevens van de bankgegevens van werknemers op op basis van de opgegeven BankDetailId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{BankDetailId}}
BankDetailId True integer

{{BankDetailId}} De BankDetailId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

response
object

Eén bijlagerecord voor werknemers bijwerken

Werk één bijlagerecord bij op basis van de opgegeven AttachmentId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

AttachmentId
AttachmentId True integer

{{AttachmentId}} De AttachmentId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

response
object

Eén bijlagerecord voor werknemers maken

Maak één bijlagerecord voor het opgegeven EmployeeNumber.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

Classification
Classification string

Classification

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Bijlage
Attachment string

Bijlage

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etiket
CustomFields.Label string

Etiket

Waarde
CustomFields.Value string

Waarde

Eén bijlagerecord voor werknemers ophalen

Hiermee haalt u gegevens van werknemersbijlagen op op basis van de opgegeven AttachmentId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{AttachmentId}}
AttachmentId True integer

De AttachmentId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

AttachmentId
AttachmentId integer

AttachmentId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

Classification
Classification string

Classification

AttachmentDescription
AttachmentDescription string

AttachmentDescription

AttachmentName
AttachmentName string

AttachmentName

AttachmentUrl
AttachmentUrl string

AttachmentUrl

Bijlage
Attachment string

Bijlage

CustomFields
CustomFields array of object

CustomFields

Code
CustomFields.Code string

Code

Etiket
CustomFields.Label string

Etiket

Waarde
CustomFields.Value string

Waarde

Eén bijlagerecord voor werknemers verwijderen

Eén bijlagerecord voor werknemers verwijderen op basis van de opgegeven AttachmentId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

AttachmentId
AttachmentId True integer

{{AttachmentId}} De AttachmentId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

response
object

Eén record voor de status van de werkgelegenheid maken

Maak één werknemerstatusrecord voor het opgegeven EmployeeNumber.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

EmploymentStatusId
EmploymentStatusId integer

EmploymentStatusId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

GroupJoinDate
GroupJoinDate string

GroupJoinDate

EmploymentDate
EmploymentDate string

EmploymentDate

Beëindigingdatum
TerminationDate string

Beëindigingdatum

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

BeëindigingBedrijfRun
TerminationCompanyRun string

BeëindigingBedrijfRun

IdentityType
IdentityType string

IdentityType

Identificatienummer
IdNumber string

Identificatienummer

PassportNumber
PassportNumber string

PassportNumber

PercentageAmount
PercentageAmount string

PercentageAmount

Aantal
Amount integer

Aantal

Procent
Percentage integer

Procent

DeemedMonthlyRemuneration
DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration

Geachte 75Indicator
Deemed75Indicator boolean

Geachte 75Indicator

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

NotRePloyable
NotReEmployable boolean

NotRePloyable

ReferenceNumber
ReferenceNumber string

ReferenceNumber

OldEmployeeId
OldEmployeeId integer

OldEmployeeId

Eén werknemerrecord maken

Maak één werknemerrecord voor het opgegeven EmployeeNumber.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

Title
Title string

Title

Voornaam
FirstName string

Voornaam

Achternaam
LastName string

Achternaam

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

Middelste naam
MiddleName string

Middelste naam

Initialen
Initials string

Initialen

E-mailen
Email string

E-mailen

Verjaardag
Birthday string

Verjaardag

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Geslacht
Gender string

Geslacht

MaritalStatus
MaritalStatus string

MaritalStatus

Ras
Race string

Ras

Nationality
Nationality string

Nationality

Burgerschap
Citizenship string

Burgerschap

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

Etiket
CustomFields.Label string

Etiket

Waarde
CustomFields.Value string

Waarde

Adres
Address array of object

Adres

AddressId
Address.AddressId integer

AddressId

AddressType
Address.AddressType string

AddressType

Medewerkernummer
Address.EmployeeNumber string

Medewerkernummer

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

Provincie
Address.Province string

Provincie

UnitNumber
Address.UnitNumber string

UnitNumber

Ingewikkeld
Address.Complex string

Ingewikkeld

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

Eén werknemersrecord bijwerken

Werk één werknemerrecord bij op basis van de opgegeven EmployeeId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True string

{{company-id}} De bedrijfs-id

{{EmployeeId}}
EmployeeId True string

{{EmployeeId}} De EmployeeId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

body
body True string

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Eén werknemersrecord ophalen

Hiermee worden werknemersgegevens opgehaald op basis van de opgegeven EmployeeId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{EmployeeId}}
EmployeeId True integer

De EmployeeId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

EmployeeId
EmployeeId integer

EmployeeId

Medewerkernummer
EmployeeNumber string

Medewerkernummer

Title
Title string

Title

Voornaam
FirstName string

Voornaam

Achternaam
LastName string

Achternaam

PreferredName
PreferredName string

PreferredName

MaidenName
MaidenName string

MaidenName

Middelste naam
MiddleName string

Middelste naam

Initialen
Initials string

Initialen

E-mailen
Email string

E-mailen

Verjaardag
Birthday string

Verjaardag

HomeNumber
HomeNumber string

HomeNumber

WorkNumber
WorkNumber string

WorkNumber

CellNumber
CellNumber string

CellNumber

WorkExtension
WorkExtension string

WorkExtension

Language
Language string

Language

Geslacht
Gender string

Geslacht

MaritalStatus
MaritalStatus string

MaritalStatus

Ras
Race string

Ras

Nationality
Nationality string

Nationality

Burgerschap
Citizenship string

Burgerschap

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

Etiket
CustomFields.Label string

Etiket

Waarde
CustomFields.Value string

Waarde

Adres
Address array of object

Adres

AddressId
Address.AddressId integer

AddressId

AddressType
Address.AddressType string

AddressType

Medewerkernummer
Address.EmployeeNumber string

Medewerkernummer

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

Provincie
Address.Province string

Provincie

UnitNumber
Address.UnitNumber string

UnitNumber

Ingewikkeld
Address.Complex string

Ingewikkeld

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

Foto van werknemer uploaden

Werk één werknemersfoto bij op basis van de opgegeven EmployeeId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{EmployeeId}}
EmployeeId True integer

De EmployeeId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Werknemersfoto downloaden

Haalt één werknemersfoto op op basis van de opgegeven EmployeeId.

Parameters

Name Sleutel Vereist Type Description
{{company-id}}
company-id True integer

{{company-id}} De bedrijfs-id

{{EmployeeId}}
EmployeeId True integer

De EmployeeId

Bearer-token
CustomAuthHeader True string

Bearer-tokenwaarde (zonder het trefwoord Bearer)

Omgevingsvariabele
CustomEnvironmentHeader True string

Variabele die API (voor PROD) of apistaging (voor FASERING) is

Retouren

Name Pad Type Description
@odata.context
@odata.context string

@odata.context

Success
Success boolean

Success

Definities

Voorwerp

Dit is het type 'object'.