@datafire/payrun v5.0.0

@datafire/payrun

Client library for PayRun.IO

Installation and Usage

npm install --save @datafire/payrun

let payrun = require('@datafire/payrun').create();

.then(data => {
  console.log(data);
});

Description

Open, scableable, transparent payroll API.

Actions

DeleteEmployer

Delete the specified employer

payrun.DeleteEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetEmployer

Get the specified employer object

payrun.GetEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employer

PatchEmployer

Patches the specified employer with the supplied values

payrun.PatchEmployer({
  "Employer": {},
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • Employer required Employer
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employer

PutEmployer

Updates the existing specified employer object

payrun.PutEmployer({
  "EmployerId": "",
  "Employer": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Employer required Employer
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employer

GetCisLineTypeWithTag

Gets the CIS line types with the tag

payrun.GetCisLineTypeWithTag({
  "EmployerId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteCisLineType

Delete the specified CIS line type

payrun.DeleteCisLineType({
  "EmployerId": "",
  "CisLineTypeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetCisLineTypeFromEmployer

Gets the specified CIS line type from employer.

payrun.GetCisLineTypeFromEmployer({
  "EmployerId": "",
  "CisLineTypeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output CisLineType

PutCisLineTypeIntoEmployer

Updates the existing specified CIS line type object

payrun.PutCisLineTypeIntoEmployer({
  "EmployerId": "",
  "CisLineTypeId": "",
  "CisLineType": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • CisLineType required CisLineType
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output CisLineType

DeleteCisLineTypeTag

Deletes a tag from the CIS line type

payrun.DeleteCisLineTypeTag({
  "EmployerId": "",
  "CisLineTypeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetTagFromCisLineType

Gets the tag from the CIS line type

payrun.GetTagFromCisLineType({
  "EmployerId": "",
  "CisLineTypeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

PutCisLineTypeTag

Inserts a new tag on the CIS line type

payrun.PutCisLineTypeTag({
  "EmployerId": "",
  "CisLineTypeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

GetTagsFromCisLineType

Gets all the tags from the CIS line type

payrun.GetTagsFromCisLineType({
  "EmployerId": "",
  "CisLineTypeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineTypeId required string: The CIS line type unique identifier. E.g. TYPEA
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetCisLineTypesFromEmployer

Get links to all CIS line types for the specified employer.

payrun.GetCisLineTypesFromEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

PostCisLineTypeIntoEmployer

Create a new CIS line type object

payrun.PostCisLineTypeIntoEmployer({
  "EmployerId": "",
  "CisLineType": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisLineType required CisLineType
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Link

GetCisLineTypesWithTag

Gets the CIS line type with the tag

payrun.GetCisLineTypesWithTag({
  "EmployerId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetAllCisLineTypeTags

Gets all the CIS line type tags

payrun.GetAllCisLineTypeTags({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteCisTransaction

Deletes the specified CIS transaction

payrun.DeleteCisTransaction({
  "EmployerId": "",
  "CisTransactionId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisTransactionId required string: The CIS transaction unique identifier. E.g. CISTRAN001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetCisTransactionFromEmployer

Returns the specified CIS transaction

payrun.GetCisTransactionFromEmployer({
  "EmployerId": "",
  "CisTransactionId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • CisTransactionId required string: The CIS transaction unique identifier. E.g. CISTRAN001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output CisTransaction

GetCisTransactionsFromEmployer

Get links for all CIS transactions for the specified employer

payrun.GetCisTransactionsFromEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteDpsMessage

Deletes the DPS message

payrun.DeleteDpsMessage({
  "EmployerId": "",
  "DpsMessageId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • DpsMessageId required string: The DPS message unique identifier. E.g. DPS001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetDpsMessageFromEmployer

Gets the DPS message

payrun.GetDpsMessageFromEmployer({
  "EmployerId": "",
  "DpsMessageId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • DpsMessageId required string: The DPS message unique identifier. E.g. DPS001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output DpsMessage

PatchDpsMessage

Patches the specified DPS message with the supplied values

payrun.PatchDpsMessage({
  "EmployerId": "",
  "DpsMessageId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • DpsMessageId required string: The DPS message unique identifier. E.g. DPS001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output DpsMessage

GetDpsMessagesFromEmployer

Gets the DPS message links

payrun.GetDpsMessagesFromEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteEmployee

Delete the specified employee

payrun.DeleteEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetEmployeeFromEmployer

Gets the specified employee from employer by employee code.

payrun.GetEmployeeFromEmployer({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employee

PatchEmployee

Patches the specified employee with the supplied values

payrun.PatchEmployee({
  "Employee": {},
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • Employee required Employee
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employee

PutEmployeeIntoEmployer

Updates the existing specified employee object

payrun.PutEmployeeIntoEmployer({
  "EmployerId": "",
  "EmployeeId": "",
  "Employee": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Employee required Employee
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employee

DeleteAEAssessment

Deletes an existing auto enrolment assessment for the employee. Used to remove historical assessments

payrun.DeleteAEAssessment({
  "EmployerId": "",
  "EmployeeId": "",
  "AEAssessmentId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • AEAssessmentId required string: The auto enrolment assessment unique identifier. E.g. AE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetAEAssessmentFromEmployee

Gets the auto enrolment assessment from the specified employee

payrun.GetAEAssessmentFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "AEAssessmentId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • AEAssessmentId required string: The auto enrolment assessment unique identifier. E.g. AE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output AEAssessment

PutNewAEAssessment

Creates a new auto enrolment assessment for the employee. Used to insert historical assessments

payrun.PutNewAEAssessment({
  "EmployerId": "",
  "EmployeeId": "",
  "AEAssessmentId": "",
  "AEAssessment": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • AEAssessmentId required string: The auto enrolment assessment unique identifier. E.g. AE001
  • AEAssessment required AEAssessment
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output AEAssessment

GetAEAssessmentsFromEmployee

Gets all auto enrolment assessments from the specified employee

payrun.GetAEAssessmentsFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

PostNewAEAssessment

Creates a new auto enrolment assessment for the employee. Used to insert historical assessments

payrun.PostNewAEAssessment({
  "EmployerId": "",
  "EmployeeId": "",
  "AEAssessment": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • AEAssessment required AEAssessment
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Link

GetCommentariesFromEmployee

Get links to all commentaries for the specified employee.

payrun.GetCommentariesFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetCommentaryFromEmployee

Gets the specified commentary report from the employee

payrun.GetCommentaryFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "CommentaryId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • CommentaryId required string: The commentary unique identifier. E.g. C001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Commentary

GetPayInstructionWithTag

Gets the pay instructions with the tag

payrun.GetPayInstructionWithTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeletePayInstruction

Delete the specified pay instruction

payrun.DeletePayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetPayInstructionFromEmployee

Returns the specified pay instruction from employee

payrun.GetPayInstructionFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output PayInstruction

PatchPayInstruction

Patches the specified pay instruction with the supplied values

payrun.PatchPayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "PayInstruction": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • PayInstruction required PayInstruction
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output PayInstruction

PutPayInstruction

Updates the existing specified pay instruction object

payrun.PutPayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "PayInstruction": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • PayInstruction required PayInstruction
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output PayInstruction

DeletePayInstructionTag

Deletes a tag from the pay instruction

payrun.DeletePayInstructionTag({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetTagFromPayInstruction

Gets the tag from the pay instruction

payrun.GetTagFromPayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

PutPayInstructionTag

Inserts a new tag on the pay instruction

payrun.PutPayInstructionTag({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

GetTagsFromPayInstruction

Gets all the tags from the pay instruction

payrun.GetTagsFromPayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstructionId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstructionId required string: The pay instruction unique identifier. E.g. SAL001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayInstructionsFromEmployee

Get links to all pay instructions for the specified employee

payrun.GetPayInstructionsFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

PostPayInstruction

Creates a new pay instruction object

payrun.PostPayInstruction({
  "EmployerId": "",
  "EmployeeId": "",
  "PayInstruction": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayInstruction required PayInstruction
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Link

GetPayInstructionsWithTag

Gets the pay instructions with the tag

payrun.GetPayInstructionsWithTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetAllPayInstructionTags

Gets all the pay instruction tags

payrun.GetAllPayInstructionTags({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayLineWithTag

Gets the pay lines with the tag

payrun.GetPayLineWithTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayLineFromEmployee

Returns the specified pay line from employee

payrun.GetPayLineFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "PayLineId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayLineId required string: The pay line unique identifier. E.g. PL001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output PayLine

DeletePayLineTag

Deletes a tag from the pay line

payrun.DeletePayLineTag({
  "EmployerId": "",
  "EmployeeId": "",
  "PayLineId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayLineId required string: The pay line unique identifier. E.g. PL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetTagFromPayLine

Gets the tag from the pay line

payrun.GetTagFromPayLine({
  "EmployerId": "",
  "EmployeeId": "",
  "PayLineId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayLineId required string: The pay line unique identifier. E.g. PL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

PutPayLineTag

Inserts a new tag on the pay line

payrun.PutPayLineTag({
  "EmployerId": "",
  "EmployeeId": "",
  "PayLineId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayLineId required string: The pay line unique identifier. E.g. PL001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

GetTagsFromPayLine

Gets all the tags from the pay line

payrun.GetTagsFromPayLine({
  "EmployerId": "",
  "EmployeeId": "",
  "PayLineId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • PayLineId required string: The pay line unique identifier. E.g. PL001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayLinesFromEmployee

Get links to all pay lines for the specified employee

payrun.GetPayLinesFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayLinesWithTag

Gets the pay line with the tag

payrun.GetPayLinesWithTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetAllPayLineTags

Gets all the pay line tags

payrun.GetAllPayLineTags({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetPayRunsFromEmployee

Get links to all pay runs for the specified employee.

payrun.GetPayRunsFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteEmployeeRevisionByNumber

Deletes the specified employee revision for the matching revision number

payrun.DeleteEmployeeRevisionByNumber({
  "EmployerId": "",
  "EmployeeId": "",
  "RevisionNumber": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • RevisionNumber required string: The revision number. E.g. 1
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetEmployeeRevisionByNumber

Get the employee revision matching the specified revision number

payrun.GetEmployeeRevisionByNumber({
  "EmployerId": "",
  "EmployeeId": "",
  "RevisionNumber": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • RevisionNumber required string: The revision number. E.g. 1
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employee

GetEmployeeRevisions

Gets links to all employee revisions

payrun.GetEmployeeRevisions({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteEmployeeSecret

Deletes an employee secret from the given resource location

payrun.DeleteEmployeeSecret({
  "EmployerId": "",
  "EmployeeId": "",
  "SecretId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • SecretId required string: The secret unique identifier. E.g ERSEC001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetEmployeeSecret

Get the public visible employee secret object

payrun.GetEmployeeSecret({
  "EmployerId": "",
  "EmployeeId": "",
  "SecretId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • SecretId required string: The secret unique identifier. E.g ERSEC001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output EmployeeSecret

PutEmployeeSecret

Create / update an employee secret at the given resource location

payrun.PutEmployeeSecret({
  "EmployerId": "",
  "EmployeeId": "",
  "SecretId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • SecretId required string: The secret unique identifier. E.g ERSEC001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output EmployeeSecret

GetEmployeeSecrets

Get all the employee secret links

payrun.GetEmployeeSecrets({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

PostEmployeeSecret

Create new employee secret using auto generated resource location key

payrun.PostEmployeeSecret({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Link

DeleteEmployeeTag

Deletes a tag from the employee

payrun.DeleteEmployeeTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetTagFromEmployee

Gets the tag from the employee

payrun.GetTagFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

PutEmployeeTag

Inserts a new tag on the employee

payrun.PutEmployeeTag({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

GetTagFromEmployeeRevision

Gets the tag from the employee revision

payrun.GetTagFromEmployeeRevision({
  "EmployerId": "",
  "EmployeeId": "",
  "TagId": "",
  "EffectiveDate": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • EffectiveDate required string: The effective date to be applied. E.g 2016-04-06
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Tag

GetTagsFromEmployee

Gets all the tags from the employee

payrun.GetTagsFromEmployee({
  "EmployerId": "",
  "EmployeeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetTagsFromEmployeeRevision

Gets all the tags from the employee revision

payrun.GetTagsFromEmployeeRevision({
  "EmployerId": "",
  "EmployeeId": "",
  "EffectiveDate": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • EffectiveDate required string: The effective date to be applied. E.g 2016-04-06
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteEmployeeRevision

Deletes the specified employee revision for the matching revision date

payrun.DeleteEmployeeRevision({
  "EmployerId": "",
  "EmployeeId": "",
  "EffectiveDate": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • EffectiveDate required string: The effective date to be applied. E.g 2016-04-06
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetEmployeeByEffectiveDate

Returns the employee's state at the specified effective date.

payrun.GetEmployeeByEffectiveDate({
  "EmployerId": "",
  "EmployeeId": "",
  "EffectiveDate": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EmployeeId required string: The employees' unique identifier. E.g EE001
  • EffectiveDate required string: The effective date to be applied. E.g 2016-04-06
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Employee

GetEmployeesFromEmployer

Get links to all employees for the specified employer.

payrun.GetEmployeesFromEmployer({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

PostEmployeeIntoEmployer

Create a new employee object

payrun.PostEmployeeIntoEmployer({
  "EmployerId": "",
  "Employee": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Employee required Employee
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output Link

GetEmployeesWithTag

Gets the employees with the tag

payrun.GetEmployeesWithTag({
  "EmployerId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetAllEmployeeTags

Gets all the employee tags

payrun.GetAllEmployeeTags({
  "EmployerId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetEmployeesByEffectiveDate

Get links to all employees for the employer on specified effective date.

payrun.GetEmployeesByEffectiveDate({
  "EmployerId": "",
  "EffectiveDate": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • EffectiveDate required string: The effective date to be applied. E.g 2016-04-06
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

GetHolidaySchemeWithTag

Gets the holiday schemes with the tag

payrun.GetHolidaySchemeWithTag({
  "EmployerId": "",
  "TagId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • TagId required string: The tag unique identifier. E.g. MyTag
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output LinkCollection

DeleteHolidayScheme

Delete the specified holiday scheme

payrun.DeleteHolidayScheme({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetHolidaySchemeFromEmployer

Gets the specified holiday scheme from employer.

payrun.GetHolidaySchemeFromEmployer({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output HolidayScheme

PatchHolidayScheme

Patches the specified holiday scheme with the supplied values

payrun.PatchHolidayScheme({
  "HolidayScheme": {},
  "EmployerId": "",
  "HolidaySchemeId": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • HolidayScheme required HolidayScheme
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output HolidayScheme

PutHolidaySchemeIntoEmployer

Updates the existing specified holiday scheme object

payrun.PutHolidaySchemeIntoEmployer({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "HolidayScheme": {},
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • HolidayScheme required HolidayScheme
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output HolidayScheme

DeleteHolidaySchemeRevisionByNumber

Deletes the specified holiday scheme revision for the matching revision number

payrun.DeleteHolidaySchemeRevisionByNumber({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "RevisionNumber": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • RevisionNumber required string: The revision number. E.g. 1
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

Output schema unknown

GetHolidaySchemeRevisionByNumber

Get the holiday scheme revision matching the specified revision number

payrun.GetHolidaySchemeRevisionByNumber({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "RevisionNumber": "",
  "Authorization": "",
  "Api-Version": ""
}, context)

Input

• input object
  • EmployerId required string: The employers' unique identifier. E.g ER001
  • HolidaySchemeId required string: The holiday schemes' unique identifier. E.g HOLSCH001
  • RevisionNumber required string: The revision number. E.g. 1
  • Authorization required string: The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version required string: The version of the api to target. Omit or set as 'default' to target the current api version.

Output

• output HolidayScheme

GetHolidaySchemeRevisions

Gets links to all the holiday scheme revisions

payrun.GetHolidaySchemeRevisions({
  "EmployerId": "",
  "HolidaySchemeId": "",
  "Authorization": "",
  "Ap