PaySpace (Independent Publisher) (Preview)

Our powerful solution allows you to access your employee data in order to utilize in your business environment. All supported endpoints in one place and ready to be integrated into your solution.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Mint PaySpace Support
URL	https://za.mintgroup.net/
Email	payspace.support@mintgroup.net

Connector Metadata
Publisher	Mint Management Technologies
Website	https://www.payspace.com
Privacy policy	https://www.payspace.com/privacy-policy/
Categories	Human Resources

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a single bank detail record	Create a single employee bank details record for the specified EmployeeNumber.
Create a single employee attachment record	Create a single attachment record for the specified EmployeeNumber.
Create a single Employee record	Create a single employee record for the specified EmployeeNumber.
Create a single employment status record	Create a single employee employment status record for the specified EmployeeNumber.
Create a single position record	Create a single employee position record for the specified EmployeeNumber.
Delete a single bank detail record	Retrieves employee bank detail information based on the specified BankDetailId.
Delete a single employee attachment record	Delete a single employee attachment record based on the specified AttachmentId.
Download employee photo	Retrieves a single employee photo based on the specified EmployeeId.
Get a collection of all employment statuses	Retrieves a list of all employee employment statuses based on the specified company-id.
Get a collection of bank detail records	Retrieves a list of employee bank details based on the specified company_id.
Get a collection of Employee attachment records	Retrieves a list of active employee attachment records based on the specified company_id.
Get a collection of employees	Retrieves a list of active employee biographical details as of the today's date and based on the specified company-id.
Get a collection of employees as of an effective date	Retrieves a list of active employee biographical details as of the specified effective date and based on the specified company-id.
Get a collection of employment statuses	Retrieves a list of current active employee employment statuses based on the specified company-id.
Get a collection of positions	Retrieves a list of employee position records as of the today's date and based on the specified company_id.
Get a collection of positions as of an effective date	Retrieves a list of employee position records as of the specified effective date and based on the specified company_id.
Get a single bank detail record	Retrieves employee bank detail information based on the specified BankDetailId.
Get a single employee attachment record	Retrieves employee attachment information based on the specified AttachmentId.
Get a single employee record	Retrieves employee information based on the specified EmployeeId.
Get a single position record	Retrieves employee position records based on the specified EmployeePositionId.
Update a single bank detail record	Update a single bank detail record based on the specified BankdetailId.
Update a single employee attachment record	Update a single attachment record based on the specified AttachmentId.
Update a single employee record	Update a single employee record based on the specified EmployeeId.
Update a single position record	Update a single employee position record based on the specified EmployeePositionId.
Upload employee photo	Update a single employee photo based on the specified EmployeeId.

Create a single bank detail record

Operation ID:

CreateASingleBankDetailRecord

Create a single employee bank details record for the specified EmployeeNumber.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
body	body	True	string
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Amount	Amount	integer	Amount
Comments	Comments	string	Comments
SwiftCode	SwiftCode	string	SwiftCode
RoutingCode	RoutingCode	string	RoutingCode
ComponentId	ComponentId	integer	ComponentId

Create a single employee attachment record

Operation ID:

CreateASingleEmployeeAttachmentRecord

Create a single attachment record for the specified EmployeeNumber.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

Name	Path	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
Attachment	Attachment	string	Attachment
CustomFields	CustomFields	array of object	CustomFields
Code	CustomFields.Code	string	Code
Label	CustomFields.Label	string	Label
Value	CustomFields.Value	string	Value

Create a single Employee record

Operation ID:

CreateASingleEmployeeRecord

Create a single employee record for the specified EmployeeNumber.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
EmployeeId	EmployeeId	integer	EmployeeId
EmployeeNumber	EmployeeNumber	string	EmployeeNumber
Title	Title	string	Title
FirstName	FirstName	string	FirstName
LastName	LastName	string	LastName
PreferredName	PreferredName	string	PreferredName
MaidenName	MaidenName	string	MaidenName
MiddleName	MiddleName	string	MiddleName
Initials	Initials	string	Initials
Email	Email	string	Email
Birthday	Birthday	string	Birthday
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
Race	Race	string	Race
Nationality	Nationality	string	Nationality
Citizenship	Citizenship	string	Citizenship
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
Label	CustomFields.Label	string	Label
Value	CustomFields.Value	string	Value
Address	Address	array of object	Address
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

Create a single employment status record

Operation ID:

CreateASingleEmploymentStatusRecord

Create a single employee employment status record for the specified EmployeeNumber.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

Name	Path	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
PercentageAmount	PercentageAmount	string	PercentageAmount
Amount	Amount	integer	Amount
Percentage	Percentage	integer	Percentage
DeemedMonthlyRemuneration	DeemedMonthlyRemuneration	integer	DeemedMonthlyRemuneration
Deemed75Indicator	Deemed75Indicator	boolean	Deemed75Indicator
DeemedRecoveryMonthly	DeemedRecoveryMonthly	boolean	DeemedRecoveryMonthly
EncashLeave	EncashLeave	boolean	EncashLeave
Irp30	Irp30	boolean	Irp30
FinalizeIssueTaxCert	FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
PassportCountry	PassportCountry	boolean	PassportCountry
PassportIssued	PassportIssued	string	PassportIssued
PassportExpiry	PassportExpiry	string	PassportExpiry
PermitIssued	PermitIssued	string	PermitIssued
PermitExpiry	PermitExpiry	string	PermitExpiry
AdditionalDate	AdditionalDate	string	AdditionalDate
EmploymentCaptureDate	EmploymentCaptureDate	string	EmploymentCaptureDate
TerminationCaptureDate	TerminationCaptureDate	string	TerminationCaptureDate
TempWorker	TempWorker	boolean	TempWorker
AdditionalDate1	AdditionalDate1	string	AdditionalDate1
NotReEmployable	NotReEmployable	boolean	NotReEmployable
ReferenceNumber	ReferenceNumber	string	ReferenceNumber
OldEmployeeId	OldEmployeeId	integer	OldEmployeeId

Create a single position record

Operation ID:

CreateASinglePositionRecord

Create a single employee position record for the specified EmployeeNumber.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
EmployeePositionId	EmployeePositionId	integer	EmployeePositionId
EmployeeNumber	EmployeeNumber	string	EmployeeNumber
EffectiveDate	EffectiveDate	string	EffectiveDate
OrganizationPosition	OrganizationPosition	string	OrganizationPosition
OrganizationPositionWithCode	OrganizationPositionWithCode	string	OrganizationPositionWithCode
PositionType	PositionType	string	PositionType
Grade	Grade	string	Grade
OccupationalLevel	OccupationalLevel	string	OccupationalLevel
DirectlyReportsPositionOverride	DirectlyReportsPositionOverride	string	DirectlyReportsPositionOverride
DirectlyReportsPosition	DirectlyReportsPosition	string	DirectlyReportsPosition
OrganizationGroup	OrganizationGroup	string	OrganizationGroup
OrganizationGroups	OrganizationGroups	array of	OrganizationGroups
OrganizationRegion	OrganizationRegion	string	OrganizationRegion
PayPoint	PayPoint	string	PayPoint
DirectlyReportsEmployee	DirectlyReportsEmployee	string	DirectlyReportsEmployee
DirectlyReportsEmployeeNumber	DirectlyReportsEmployeeNumber	string	DirectlyReportsEmployeeNumber
EmploymentCategory	EmploymentCategory	string	EmploymentCategory
EmploymentSubCategory	EmploymentSubCategory	string	EmploymentSubCategory
Administrator	Administrator	string	Administrator
AdministratorEmployeeNumber	AdministratorEmployeeNumber	string	AdministratorEmployeeNumber
WorkflowRole	WorkflowRole	string	WorkflowRole
GeneralLedger	GeneralLedger	string	GeneralLedger
TradeUnion	TradeUnion	string	TradeUnion
IsPromotion	IsPromotion	boolean	IsPromotion
Roster	Roster	string	Roster
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
Label	CustomFields.Label	string	Label
Value	CustomFields.Value	string	Value

Delete a single bank detail record

Operation ID:

DeleteASingleBankDetailRecord

Retrieves employee bank detail information based on the specified BankDetailId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{BankDetailId}}	BankDetailId	True	integer	{{BankDetailId}} The BankDetailId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

response

object

Delete a single employee attachment record

Operation ID:

DeleteASingleEmployeeAttachmentRecord

Delete a single employee attachment record based on the specified AttachmentId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
AttachmentId	AttachmentId	True	integer	{{AttachmentId}} The AttachmentId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

response

object

Download employee photo

Operation ID:

DownloadEmployeePhoto

Retrieves a single employee photo based on the specified EmployeeId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{EmployeeId}}	EmployeeId	True	integer	The EmployeeId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
Success	Success	boolean	Success

Get a collection of all employment statuses

Operation ID:

GetACollectionOfAllEmploymentStatuses

Retrieves a list of all employee employment statuses based on the specified company-id.

Parameters

Name	Key	Required	Type	Description
{{$employee-field}}	$orderby		string	Optional (string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
PercentageAmount	value.PercentageAmount	string	PercentageAmount
Amount	value.Amount	integer	Amount
Percentage	value.Percentage	integer	Percentage
DeemedMonthlyRemuneration	value.DeemedMonthlyRemuneration	integer	DeemedMonthlyRemuneration
Deemed75Indicator	value.Deemed75Indicator	boolean	Deemed75Indicator
DeemedRecoveryMonthly	value.DeemedRecoveryMonthly	boolean	DeemedRecoveryMonthly
EncashLeave	value.EncashLeave	boolean	EncashLeave
Irp30	value.Irp30	boolean	Irp30
FinalizeIssueTaxCert	value.FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
PassportCountry	value.PassportCountry	boolean	PassportCountry
PassportIssued	value.PassportIssued	string	PassportIssued
PassportExpiry	value.PassportExpiry	string	PassportExpiry
PermitIssued	value.PermitIssued	string	PermitIssued
PermitExpiry	value.PermitExpiry	string	PermitExpiry
AdditionalDate	value.AdditionalDate	string	AdditionalDate
EmploymentCaptureDate	value.EmploymentCaptureDate	string	EmploymentCaptureDate
TerminationCaptureDate	value.TerminationCaptureDate	string	TerminationCaptureDate
TempWorker	value.TempWorker	boolean	TempWorker
AdditionalDate1	value.AdditionalDate1	string	AdditionalDate1
NotReEmployable	value.NotReEmployable	boolean	NotReEmployable
ReferenceNumber	value.ReferenceNumber	string	ReferenceNumber
OldEmployeeId	value.OldEmployeeId	integer	OldEmployeeId
CustomFields	value.CustomFields	array of object	CustomFields
Code	value.CustomFields.Code	string	Code
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Get a collection of bank detail records

Operation ID:

GetACollectionOfBankDetailRecords

Retrieves a list of employee bank details based on the specified company_id.

Parameters

Name	Key	Required	Type	Description
Optional by {{$bank-detail-field}}	$orderby	True	string	(string) - Specifies the order in which items are returned
Optional $top	$top		string	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	string	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Amount	value.Amount	integer	Amount
Comments	value.Comments	string	Comments
SwiftCode	value.SwiftCode	string	SwiftCode
RoutingCode	value.RoutingCode	string	RoutingCode
ComponentId	value.ComponentId	integer	ComponentId

Get a collection of Employee attachment records

Operation ID:

GetACollectionOfEmployeeAttachmentRecords

Retrieves a list of active employee attachment records based on the specified company_id.

Parameters

Name	Key	Required	Type	Description
Optional by {{$attachment-field}}	$orderby		string	(string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Attachment	value.Attachment	string	Attachment
CustomFields	value.CustomFields	array of object	CustomFields
Code	value.CustomFields.Code	string	Code
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Get a collection of employees

Operation ID:

GetACollectionOfEmployees

Retrieves a list of active employee biographical details as of the today's date and based on the specified company-id.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Optional by {{$employee-field}}	$orderby		string	(string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip		integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count		string	(true/false) - Return total count in response
Optional $filter	$filter		string	Optional - Filter by field eg. "EmployeeNumber eq 'Emp01'"
Optional $select	$select		string	Optional (string) - Returns only the fields specified
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Title	value.Title	string	Title
FirstName	value.FirstName	string	FirstName
LastName	value.LastName	string	LastName
PreferredName	value.PreferredName	string	PreferredName
MaidenName	value.MaidenName	string	MaidenName
MiddleName	value.MiddleName	string	MiddleName
Initials	value.Initials	string	Initials
Email	value.Email	string	Email
Birthday	value.Birthday	string	Birthday
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
Race	value.Race	string	Race
Nationality	value.Nationality	string	Nationality
Citizenship	value.Citizenship	string	Citizenship
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
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value
Address	value.Address	array of object	Address
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

Get a collection of employees as of an effective date

Operation ID:

GetACollectionOfEmployeesAsOfAnEffectiveDate

Retrieves a list of active employee biographical details as of the specified effective date and based on the specified company-id.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
effectivedate	effectivedate	True	string	Effective date formatted in YYYY-MM-DD. eg. 2022-01-15
Optional by {{$employee-field}}	$orderby		string	(string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Title	value.Title	string	Title
FirstName	value.FirstName	string	FirstName
LastName	value.LastName	string	LastName
PreferredName	value.PreferredName	string	PreferredName
MaidenName	value.MaidenName	string	MaidenName
MiddleName	value.MiddleName	string	MiddleName
Initials	value.Initials	string	Initials
Email	value.Email	string	Email
Birthday	value.Birthday	string	Birthday
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
Race	value.Race	string	Race
Nationality	value.Nationality	string	Nationality
Citizenship	value.Citizenship	string	Citizenship
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
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value
Address	value.Address	array of object	Address
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

Get a collection of employment statuses

Operation ID:

GetACollectionOfEmploymentStatuses

Retrieves a list of current active employee employment statuses based on the specified company-id.

Parameters

Name	Key	Required	Type	Description
Optional by {{$employee-field}}	$orderby		string	(string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
PercentageAmount	value.PercentageAmount	string	PercentageAmount
Amount	value.Amount	integer	Amount
Percentage	value.Percentage	integer	Percentage
DeemedMonthlyRemuneration	value.DeemedMonthlyRemuneration	integer	DeemedMonthlyRemuneration
Deemed75Indicator	value.Deemed75Indicator	boolean	Deemed75Indicator
DeemedRecoveryMonthly	value.DeemedRecoveryMonthly	boolean	DeemedRecoveryMonthly
EncashLeave	value.EncashLeave	boolean	EncashLeave
Irp30	value.Irp30	boolean	Irp30
FinalizeIssueTaxCert	value.FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
PassportCountry	value.PassportCountry	boolean	PassportCountry
PassportIssued	value.PassportIssued	string	PassportIssued
PassportExpiry	value.PassportExpiry	string	PassportExpiry
PermitIssued	value.PermitIssued	string	PermitIssued
PermitExpiry	value.PermitExpiry	string	PermitExpiry
AdditionalDate	value.AdditionalDate	string	AdditionalDate
EmploymentCaptureDate	value.EmploymentCaptureDate	string	EmploymentCaptureDate
TerminationCaptureDate	value.TerminationCaptureDate	string	TerminationCaptureDate
TempWorker	value.TempWorker	boolean	TempWorker
AdditionalDate1	value.AdditionalDate1	string	AdditionalDate1
NotReEmployable	value.NotReEmployable	boolean	NotReEmployable
ReferenceNumber	value.ReferenceNumber	string	ReferenceNumber
OldEmployeeId	value.OldEmployeeId	integer	OldEmployeeId
CustomFields	value.CustomFields	array of object	CustomFields
Code	value.CustomFields.Code	string	Code
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Get a collection of positions

Operation ID:

GetACollectionOfPositions

Retrieves a list of employee position records as of the today's date and based on the specified company_id.

Parameters

Name	Key	Required	Type	Description
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $filter	$filter		string	Filter by field eg. "EmployeeNumber eq 'Emp01'"
Optional $expand	$expand	True	string	Optional - to return the OrganizationGroups field data, use the value 'OrganizationGroups'
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
EffectiveDate	value.EffectiveDate	string	EffectiveDate
OrganizationPosition	value.OrganizationPosition	string	OrganizationPosition
OrganizationPositionId	value.OrganizationPositionId	integer	OrganizationPositionId
OrganizationPositionWithCode	value.OrganizationPositionWithCode	string	OrganizationPositionWithCode
PositionType	value.PositionType	string	PositionType
Grade	value.Grade	string	Grade
OccupationalLevel	value.OccupationalLevel	string	OccupationalLevel
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
Budget	value.OrganizationGroups.Budget	integer	Budget
Reference	value.OrganizationGroups.Reference	string	Reference
ManagerEmployeeNumber	value.OrganizationGroups.ManagerEmployeeNumber	string	ManagerEmployeeNumber
InactiveDate	value.OrganizationGroups.InactiveDate	string	InactiveDate
OrganizationRegion	value.OrganizationRegion	string	OrganizationRegion
PayPoint	value.PayPoint	string	PayPoint
DirectlyReportsEmployee	value.DirectlyReportsEmployee	string	DirectlyReportsEmployee
DirectlyReportsEmployeeNumber	value.DirectlyReportsEmployeeNumber	string	DirectlyReportsEmployeeNumber
EmploymentCategory	value.EmploymentCategory	string	EmploymentCategory
EmploymentSubCategory	value.EmploymentSubCategory	string	EmploymentSubCategory
Administrator	value.Administrator	string	Administrator
AdministratorEmployeeNumber	value.AdministratorEmployeeNumber	string	AdministratorEmployeeNumber
WorkflowRole	value.WorkflowRole	string	WorkflowRole
GeneralLedger	value.GeneralLedger	string	GeneralLedger
TradeUnion	value.TradeUnion	string	TradeUnion
IsPromotion	value.IsPromotion	boolean	IsPromotion
Roster	value.Roster	string	Roster
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
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Get a collection of positions as of an effective date

Operation ID:

GetACollectionOfPositionsAsOfAnEffectiveDate

Retrieves a list of employee position records as of the specified effective date and based on the specified company_id.

Parameters

Name	Key	Required	Type	Description
{{$employee-field}}	$orderby	True	string	(string) - Specifies the order in which items are returned
Optional $top	$top		integer	(integer($int32)) - Limits the number of items returned from a collection
Optional $skip	$skip	True	integer	(integer($int32)) - Excludes the specified number of items of the queried collection from the result
Optional $count	$count	True	string	(true/false) - Return total count in response
Optional $expand	$expand	True	string	Optional - to return the OrganizationGroups field data, use the value 'OrganizationGroups'
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
effectivedate	effectivedate	True	string	Effective date formatted in YYYY-MM-DD. eg. 2022-01-15
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
EffectiveDate	value.EffectiveDate	string	EffectiveDate
OrganizationPosition	value.OrganizationPosition	string	OrganizationPosition
OrganizationPositionId	value.OrganizationPositionId	integer	OrganizationPositionId
OrganizationPositionWithCode	value.OrganizationPositionWithCode	string	OrganizationPositionWithCode
PositionType	value.PositionType	string	PositionType
Grade	value.Grade	string	Grade
OccupationalLevel	value.OccupationalLevel	string	OccupationalLevel
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
Budget	value.OrganizationGroups.Budget	integer	Budget
Reference	value.OrganizationGroups.Reference	string	Reference
ManagerEmployeeNumber	value.OrganizationGroups.ManagerEmployeeNumber	string	ManagerEmployeeNumber
InactiveDate	value.OrganizationGroups.InactiveDate	string	InactiveDate
OrganizationRegion	value.OrganizationRegion	string	OrganizationRegion
PayPoint	value.PayPoint	string	PayPoint
DirectlyReportsEmployee	value.DirectlyReportsEmployee	string	DirectlyReportsEmployee
DirectlyReportsEmployeeNumber	value.DirectlyReportsEmployeeNumber	string	DirectlyReportsEmployeeNumber
EmploymentCategory	value.EmploymentCategory	string	EmploymentCategory
EmploymentSubCategory	value.EmploymentSubCategory	string	EmploymentSubCategory
Administrator	value.Administrator	string	Administrator
AdministratorEmployeeNumber	value.AdministratorEmployeeNumber	string	AdministratorEmployeeNumber
WorkflowRole	value.WorkflowRole	string	WorkflowRole
GeneralLedger	value.GeneralLedger	string	GeneralLedger
TradeUnion	value.TradeUnion	string	TradeUnion
IsPromotion	value.IsPromotion	boolean	IsPromotion
Roster	value.Roster	string	Roster
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
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Get a single bank detail record

Operation ID:

GetASingleBankDetailRecord

Retrieves employee bank detail information based on the specified BankDetailId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{BankDetailId}}	BankDetailId	True	integer	The BankDetailId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Amount	Amount	integer	Amount
Comments	Comments	string	Comments
SwiftCode	SwiftCode	string	SwiftCode
RoutingCode	RoutingCode	string	RoutingCode
ComponentId	ComponentId	integer	ComponentId

Get a single employee attachment record

Operation ID:

GetASingleEmployeeAttachmentRecord

Retrieves employee attachment information based on the specified AttachmentId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{AttachmentId}}	AttachmentId	True	integer	The AttachmentId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
Attachment	Attachment	string	Attachment
CustomFields	CustomFields	array of object	CustomFields
Code	CustomFields.Code	string	Code
Label	CustomFields.Label	string	Label
Value	CustomFields.Value	string	Value

Get a single employee record

Operation ID:

GetASingleEmployeeRecord

Retrieves employee information based on the specified EmployeeId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{EmployeeId}}	EmployeeId	True	integer	The EmployeeId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
EmployeeId	EmployeeId	integer	EmployeeId
EmployeeNumber	EmployeeNumber	string	EmployeeNumber
Title	Title	string	Title
FirstName	FirstName	string	FirstName
LastName	LastName	string	LastName
PreferredName	PreferredName	string	PreferredName
MaidenName	MaidenName	string	MaidenName
MiddleName	MiddleName	string	MiddleName
Initials	Initials	string	Initials
Email	Email	string	Email
Birthday	Birthday	string	Birthday
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
Race	Race	string	Race
Nationality	Nationality	string	Nationality
Citizenship	Citizenship	string	Citizenship
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
Label	CustomFields.Label	string	Label
Value	CustomFields.Value	string	Value
Address	Address	array of object	Address
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

Get a single position record

Operation ID:

GetASinglePositionRecord

Retrieves employee position records based on the specified EmployeePositionId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{EmployeePositionId}}	EmployeePositionId	True	integer	The EmployeePositionId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	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
EffectiveDate	value.EffectiveDate	string	EffectiveDate
OrganizationPosition	value.OrganizationPosition	string	OrganizationPosition
OrganizationPositionId	value.OrganizationPositionId	integer	OrganizationPositionId
OrganizationPositionWithCode	value.OrganizationPositionWithCode	string	OrganizationPositionWithCode
PositionType	value.PositionType	string	PositionType
Grade	value.Grade	string	Grade
OccupationalLevel	value.OccupationalLevel	string	OccupationalLevel
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
Budget	value.OrganizationGroups.Budget	integer	Budget
Reference	value.OrganizationGroups.Reference	string	Reference
ManagerEmployeeNumber	value.OrganizationGroups.ManagerEmployeeNumber	string	ManagerEmployeeNumber
InactiveDate	value.OrganizationGroups.InactiveDate	string	InactiveDate
OrganizationRegion	value.OrganizationRegion	string	OrganizationRegion
PayPoint	value.PayPoint	string	PayPoint
DirectlyReportsEmployee	value.DirectlyReportsEmployee	string	DirectlyReportsEmployee
DirectlyReportsEmployeeNumber	value.DirectlyReportsEmployeeNumber	string	DirectlyReportsEmployeeNumber
EmploymentCategory	value.EmploymentCategory	string	EmploymentCategory
EmploymentSubCategory	value.EmploymentSubCategory	string	EmploymentSubCategory
Administrator	value.Administrator	string	Administrator
AdministratorEmployeeNumber	value.AdministratorEmployeeNumber	string	AdministratorEmployeeNumber
WorkflowRole	value.WorkflowRole	string	WorkflowRole
GeneralLedger	value.GeneralLedger	string	GeneralLedger
TradeUnion	value.TradeUnion	string	TradeUnion
IsPromotion	value.IsPromotion	boolean	IsPromotion
Roster	value.Roster	string	Roster
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
Label	value.CustomFields.Label	string	Label
Value	value.CustomFields.Value	string	Value

Update a single bank detail record

Operation ID:

UpdateASingleBankDetailRecord

Update a single bank detail record based on the specified BankdetailId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{BankDetailId}}	BankDetailId	True	integer	{{BankDetailId}} The BankDetailId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

response

object

Update a single employee attachment record

Operation ID:

UpdateASingleEmployeeAttachmentRecord

Update a single attachment record based on the specified AttachmentId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
AttachmentId	AttachmentId	True	integer	{{AttachmentId}} The AttachmentId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

response

object

Update a single employee record

Operation ID:

UpdateASingleEmployeeRecord

Update a single employee record based on the specified EmployeeId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	string	{{company-id}} The Company Id
{{EmployeeId}}	EmployeeId	True	string	{{EmployeeId}} The EmployeeId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
Success	Success	boolean	Success

Update a single position record

Operation ID:

UpdateASinglePositionRecord

Update a single employee position record based on the specified EmployeePositionId.

Parameters

Name	Key	Required	Type	Description
{{EmployeePositionId}}	EmployeePositionId	True	integer	{{EmployeePositionId}} The EmployeePositionId
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)
body	body	True	string

Returns

response

object

Upload employee photo

Operation ID:

UploadEmployeePhoto

Update a single employee photo based on the specified EmployeeId.

Parameters

Name	Key	Required	Type	Description
{{company-id}}	company-id	True	integer	{{company-id}} The Company Id
{{EmployeeId}}	EmployeeId	True	integer	The EmployeeId
Bearer token	CustomAuthHeader	True	string	Bearer token value (without the keyword Bearer)
Environment Variable	CustomEnvironmentHeader	True	string	Variable that is either api (for PROD) or apistaging (for STAGING)

Returns

Name	Path	Type	Description
@odata.context	@odata.context	string	@odata.context
Success	Success	boolean	Success

Definitions

object

This is the type 'object'.