APIHub
Back to Explore

PayRun.IO

PayRun.IO offers a RESTful API for managing payroll data for employers, covering employers, employees, CIS line types and transactions, DPS messages, tags, and auto‑enrolment assessments.

Finance
none
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

859ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
DELETE

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}

Delete an CIS line type

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

/Employer/{EmployerId}

Delete an Employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}

Gets the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}

Patches the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}

Updates the Employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}

Get CIS line type from employer

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

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}

Updates the CIS line type

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

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}

Delete CIS line type tag

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

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}

Get CIS line type tag

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

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}

Insert CIS line type tag

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

/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags

Get all tags from the CIS line type

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

/Employer/{EmployerId}/CisLineTypes

Get CIS line types from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/CisLineTypes

Create a new CIS line type

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/CisLineTypes/Tag/{TagId}

Get CIS line types with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/CisLineTypes/Tags

Get all CIS line type tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/CisTransaction/{CisTransactionId}

Delete the CIS transaction

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

/Employer/{EmployerId}/CisTransaction/{CisTransactionId}

Get the CIS transaction

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

/Employer/{EmployerId}/CisTransactions

Get all CIS transactions for the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/DpsMessage/{DpsMessageId}

Deletes the DPS message

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

/Employer/{EmployerId}/DpsMessage/{DpsMessageId}

Gets the DPS message

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

/Employer/{EmployerId}/DpsMessage/{DpsMessageId}

Patches the DPS message

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

/Employer/{EmployerId}/DpsMessage/{DpsMessageId}

Puts the DPS message

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

/Employer/{EmployerId}/DpsMessages

Gets the DPS messages

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/DpsMessages

Posta the DPS message

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}

Delete an Employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employers/Tags

Get all employer tags

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}

Get employee from employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}/Employee/{EmployeeId}

Patches the employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/Employee/{EmployeeId}

Updates the Employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}

Delete auto enrolment assessment

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

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}

Get the auto enrolment assessment

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

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}

Insert new auto enrolment assessment

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

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments

Get the auto enrolment assessments

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments

Insert new auto enrolment assessment

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries

Get links to all commentaries for the specified employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId}

Get commentary from employee

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

/Employer/{EmployerId}/Employee/{EmployeeId}/JournalLines

Gets the journal Lines from the specified employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}

Deletes a pay instruction

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}

Gets the specified pay instruction from the employee

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}

Sparse Update of a Pay Instruction

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}

Update a Pay Instruction

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}

Delete pay instruction tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}

Get pay instruction tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}

Insert pay instruction tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tags

Get all tags from the pay instruction

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions

Gets the pay instructions from the specified employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions

Creates a new Pay Instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tag/{TagId}

Get pay instructions with tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tags

Get all pay instruction tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}

Gets the specified pay line from the employee

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}

Delete pay line tag

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

/Employer/{EmployerId}/PaySchedules

Create a new pay schedule

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}

Get pay line tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}

Insert pay line tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tags

Get all tags from the pay line

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines

Gets the pay lines from the specified employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tag/{TagId}

Get pay lines with tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tags

Get all pay line tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/PayRuns

Gets the pay runs from the employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}

Delete an Employee revision matching the specified revision number.

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

/Employer/{EmployerId}/ReportingInstructions

Gets the reporting instructions from the specified employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}

Gets the employee by revision number

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}/Summary

Gets the employee summary by revision number

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Revisions

Get all employee revisions

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Revisions/Summary

Get all employee revision summaries

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}

Deletes employee secret

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}

Get employee secret

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}

Create a new employee secret

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Secrets

Get all employee secret links

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Employee/{EmployeeId}/Secrets

Create a new employee secret

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Summary

Get employee summary from employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}

Delete employee tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}

Get employee tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}

Insert employee tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}/{EffectiveDate}

Get employee revision tag

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

/Employer/{EmployerId}/Employee/{EmployeeId}/Tags

Get all employee tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employee/{EmployeeId}/Tags/{EffectiveDate}

Get all employee revision tags

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

/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}

Delete an Employee revision matching the specified revision date.

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}

Get holiday scheme from employer

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

/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}

Get employee by effective date.

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

/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}/Summary

Get employee summary by effective date.

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

/Employer/{EmployerId}/Employees

Get employees from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Employees

Create a new Employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employees/Summary

Get employee summaries from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employees/Tag/{TagId}

Get employees with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employees/Tags

Get all employee tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Employees/{EffectiveDate}

Get employees from employer at a given effective date.

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

/Employer/{EmployerId}/Employees/{EffectiveDate}/Summary

Get employee summaries from employer at a given effective date.

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}

Delete an holiday scheme

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}

Patches the holiday scheme

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}

Updates the holiday scheme

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber}

Delete an HolidayScheme revision matching the specified revision number.

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber}

Gets the holiday scheme revision by revision number

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revisions

Get all holiday scheme revisions

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}

Delete holiday scheme tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}

Get holiday scheme tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}

Insert holiday scheme tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidaySchemes/{EffectiveDate}

Get holiday schemes from employer at a given effective date.

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}/{EffectiveDate}

Get holiday scheme revision tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags

Get all tags from the holiday scheme

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

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags/{EffectiveDate}

Get all holiday scheme revision tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}

Delete an holiday scheme revision matching the specified revision date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}

Get holiday scheme by effective date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • HolidaySchemeId (path, required) — The holiday schemes' unique identifier. E.g HOLSCH001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidaySchemes

Get holiday schemes from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/HolidaySchemes

Create a new holiday scheme

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidaySchemes/Tag/{TagId}

Get holiday schemes with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/HolidaySchemes/Tags

Get all holiday scheme tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}

Deletes a Journal instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}

Gets the specified journal instruction from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}

Update a Journal Instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalInstructions

Gets the Journal instructions from the specified employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/JournalInstructions

Creates a new Journal Instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLine/{JournalLineId}

Gets the specified journal Line from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalLineId (path, required) — The journal line unique identifier. E.g JL001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}

Delete journal line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalLineId (path, required) — The journal line unique identifier. E.g JL001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}

Get journal line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalLineId (path, required) — The journal line unique identifier. E.g JL001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}

Insert journal line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalLineId (path, required) — The journal line unique identifier. E.g JL001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/ReportingInstructions

Creates a new Reporting Instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tags

Get tags from journal line

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • JournalLineId (path, required) — The journal line unique identifier. E.g JL001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLines

Gets the Journal Lines from the specified employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLines/Tag/{TagId}

Get links to tagged journal lines

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/JournalLines/Tags

Get all journal line tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/NominalCode/{NominalCodeId}

Deletes the nominal codes

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • NominalCodeId (path, required) — The nominal code unique identifier. E.g. NOM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/NominalCode/{NominalCodeId}

Gets the nominal code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • NominalCodeId (path, required) — The nominal code unique identifier. E.g. NOM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/NominalCode/{NominalCodeId}

Insert nominal code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • NominalCodeId (path, required) — The nominal code unique identifier. E.g. NOM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/NominalCode/{NominalCodeId}/PayCodes

Gets the pay codes by nominal code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • NominalCodeId (path, required) — The nominal code unique identifier. E.g. NOM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/NominalCodes

Gets the nominal codes

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/NominalCodes

Insert nominal code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employers/{EffectiveDate}

Gets all employers at the specified effective date

  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PayCode/{PayCodeId}

Deletes a pay code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}

Gets the specified pay code from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}/PayCode/{PayCodeId}

Patches the pay code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/PayCode/{PayCodeId}

Updates a pay code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber}

Delete an PayCode revision matching the specified revision number.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber}

Gets the pay code by revision number

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}/Revisions

Get all revisions of the Pay Code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}

Delete pay code tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}

Get pay code tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Dps

Get all DPS jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}

Insert pay code tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}/Tags

Get all pay code tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}

Deletes a pay code revision

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}

Gets pay code for specified date

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayCodeId (path, required) — The pay code unique identifier. E.g. BASIC
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCodes

Gets the pay codes from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/PayCodes

Create a new pay code

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCodes/Tag/{TagId}

Get pay codes with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCodes/Tags

Get all pay code tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PayCodes/{EffectiveDate}

Gets all pay codes for specified date

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

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}

Deletes a pay schedule

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}

Gets the specified pay schedule from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}

Updates a pay schedule

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees

Get all employees revisions from a pay schedule.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees/{EffectiveDate}

Get employees from a pay schedule on effective date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}

Deletes a pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}

Gets the pay run from the pay schedule

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/AEAssessments

Get the auto enrolment assessments

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Commentaries

Get links to all commentaries for the specified pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tags

Get all pay schedule tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}

Deletes a pay run employee

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}/Commentary

Get commentary from payrun by specified employee.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • EmployeeId (path, required) — The employees' unique identifier. E.g EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employees

Get employees from the pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/JournalLines

Gets the journal Lines from the specified pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/PayLines

Gets the pay lines from the specified pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/ReportLines

Gets the report lines from the specified pay run

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}

Delete pay run tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}

Insert pay schedule tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}

Get pay run tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}

Insert pay run tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tags

Get all pay run tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • PayRunId (path, required) — The pay runs' unique identifier. E.g. PR001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns

Gets the pay runs from the pay schedule

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tag/{TagId}

Get pay runs with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tags

Get all pay run tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}

Delete pay schedule tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}

Get pay schedule tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PayScheduleId (path, required) — The pay schedules' unique identifier. E.g SCH001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedules

Gets the pay schedule from the specified employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedules/Tag/{TagId}

Get pay schedule with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/PaySchedules/Tags

Get all pay schedule tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Pension/{PensionId}

Delete a Pension

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pension/{PensionId}

Get pension from employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}/Pension/{PensionId}

Patches the pension

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/Pension/{PensionId}

Updates the Pension

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber}

Delete an Pension revision matching the specified revision number.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber}

Gets the pension by revision number

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pension/{PensionId}/Revisions

Get all pension revisions

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Revision/{RevisionNumber}

Delete an Employer revision matching the specified revision number.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}

Delete an Pension revision matching the specified revision date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}

Get pension by effective date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • PensionId (path, required) — The pensions' unique identifier. E.g PEN001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pensions

Get pensions from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Pensions

Create a new Pension

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Pensions/{EffectiveDate}

Get pensions from employer at a given effective date.

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

/Employer/{EmployerId}/ReportLine/{ReportLineId}

Gets the specified report line from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ReportLineId (path, required) — The report line unique identifier. E.g. RTL001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ReportLines

Gets the report lines from the specified employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}

Deletes a reporting instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ReportingInstructionId (path, required) — The reporting instruction unique identifier. E.g. SERRPT001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}

Gets the specified reporting instruction from the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ReportingInstructionId (path, required) — The reporting instruction unique identifier. E.g. SERRPT001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}

Update a reporting Instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ReportingInstructionId (path, required) — The reporting instruction unique identifier. E.g. SERRPT001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Revision/{RevisionNumber}

Gets the employer by revision number

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Revision/{RevisionNumber}/Summary

Gets the employer summary by revision number

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Revisions

Gets the employer revisions

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Revisions/Summary

Get all employer revision summaries

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}

Delete the RTI transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}

Get the RTI transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Summary

Get the RTI transaction summary

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}

Delete RTI transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}

Get RTI transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}

Insert RTI transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tags

Get all tags from RTI transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • RtiTransactionId (path, required) — The RTI transaction unique identifier. E.g. FPS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransactions

Get all RTI transactions for the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransactions/Summary

Get all RTI transaction summaries for the employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransactions/Tag/{TagId}

Get RTI transactions with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/RtiTransactions/Tags

Get all RTI transaction tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Secret/{SecretId}

Deletes employer secret

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Secret/{SecretId}

Get employer secret

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/Secret/{SecretId}

Create a new employer secret

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Secrets

Get all employer secret links

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/Secrets

Create a new employer secret

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}

Delete an sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}

Get sub contractor from employer

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}/SubContractor/{SubContractorId}

Patches the sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/SubContractor/{SubContractorId}

Updates the sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}

Delete a CIS instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}

Get CIS instruction from sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}

Patches the CIS instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}

Updates the CIS instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}

Delete CIS instruction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employers

Create a new Employer

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}

Get CIS instruction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}

Insert CIS instruction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tags

Get all tags from the CIS instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisInstructionId (path, required) — The CIS instruction unique identifier. E.g. CIS001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions

Get CIS instructions from sub contractor.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions

Create a new CIS instruction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tag/{TagId}

Get CIS instructions with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tags

Get all CIS instruction tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}

Delete a CIS line

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employers/Summary

Get employer summaries.

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}

Get CIS line from sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}

Delete CIS line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}

Get CIS line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}

Insert CIS line tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tags

Get all tags from the CIS line

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • CisLineId (path, required) — The CIS line unique identifier. E.g. CISLN001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines

Get CIS lines from sub contractor.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tag/{TagId}

Get CIS lines with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tags

Get all CIS line tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/JournalLines

Gets the journal Lines from the specified sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber}

Delete an SubContractor revision matching the specified revision number.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber}

Gets the sub contractor by revision number

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • RevisionNumber (path, required) — The revision number. E.g. 1
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Revisions

Get all sub contractor revisions

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}

Delete sub contractor tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}

Get sub contractor tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}

Insert sub contractor tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}/{EffectiveDate}

Get sub contractor revision tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/Dps

Create new DPS job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags

Get all tags from the sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags/{EffectiveDate}

Get all sub contractor revision tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate}

Delete an sub contractor revision matching the specified revision date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate}

Get sub contractor by effective date.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • SubContractorId (path, required) — The sub contractors' unique identifier. E.g SUB001
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractors

Get sub contractors from employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Employer/{EmployerId}/SubContractors

Create a new sub contractor

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractors/Tag/{TagId}

Get sub contractors with tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractors/Tags

Get all sub contractor tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/SubContractors/{EffectiveDate}

Get sub contractors from employer at a given effective date.

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

/Employer/{EmployerId}/Summary

Get employer summary

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/Tag/{TagId}

Delete employer tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Tag/{TagId}

Get employer tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/Tag/{TagId}

Insert employer tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Tag/{TagId}/{EffectiveDate}

Get employer revision tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Tags

Get all employer tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/Tags/{EffectiveDate}

Get all employer revision tags

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

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}

Delete third party transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}

Get a third party transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}

Delete third party transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employers/Tag/{TagId}

Get employers with tag

  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}

Get third party transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}

insert third party transaction tag

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tags

Get tags from third party transaction

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • ThirdPartyTransactionId (path, required) — The third party transaction unique identifier. E.g TP001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransactions

Get all third party transaction links

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransactions/Tag/{TagId}

Get links to tagged third party transactions

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employer/{EmployerId}/ThirdPartyTransactions/Tags

Get all third party transaction tags

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Employer/{EmployerId}/{EffectiveDate}

Delete an Employer revision matching the specified revision date.

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

/Employer/{EmployerId}/{EffectiveDate}

Gets the employer at the specified effective

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

/Employer/{EmployerId}/{EffectiveDate}/Summary

Get employer summary by effective date.

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

/Employers

Gets all employers

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Employers/{EffectiveDate}/Summary

Get employer summaries at a given effective date.

  • EffectiveDate (path, required) — The effective date to be applied. E.g 2016-04-06
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Healthcheck

Get health check status

GET

/Jobs/Batch

Get all Batch jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/Batch

Create new Batch job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/Batch/{JobId}

Delete the Batch job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Batch/{JobId}/Info

Get the Batch job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Batch/{JobId}/Progress

Get the Batch job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Batch/{JobId}/Status

Get the Batch job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Cis

Get all CIS jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/Cis

Create new CIS job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/Cis/{JobId}

Delete the CIS job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Cis/{JobId}/Info

Get the CIS job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Cis/{JobId}/Progress

Get the CIS job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Cis/{JobId}/Status

Get the CIS job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/Dps/{JobId}

Delete the DPS job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Dps/{JobId}/Info

Get the DPS job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Dps/{JobId}/Progress

Get the DPS job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Dps/{JobId}/Status

Get the DPS job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Employer/{EmployerId}

Gets all jobs relating to the employer.

  • EmployerId (path, required) — The employers' unique identifier. E.g ER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/PayRuns

Get all PayRun jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/PayRuns

Create new PayRun job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/PayRuns/{JobId}

Delete the pay run job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/PayRuns/{JobId}/Info

Get the pay run job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/PayRuns/{JobId}/Progress

Get the pay run job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/PayRuns/{JobId}/Status

Get the pay run job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Rti

Get all RTI jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/Rti

Create new RTI job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/Rti/{JobId}

Delete the RTI job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Rti/{JobId}/Info

Get the RTI job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Rti/{JobId}/Progress

Get the RTI job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/Rti/{JobId}/Status

Get the RTI job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/ThirdParty

Get all Third Party jobs

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Jobs/ThirdParty

Create new Third Party job

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Jobs/ThirdParty/{JobId}

Delete the Third Party job

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/ThirdParty/{JobId}/Info

Get the Third Party job information

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/ThirdParty/{JobId}/Progress

Get the Third Party job progress

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Jobs/ThirdParty/{JobId}/Status

Get the Third Party job status

  • JobId (path, required) — The job unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/JournalInstruction/{JournalInstructionId}

Deletes a Journal instruction template

  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/JournalInstruction/{JournalInstructionId}

Gets the Journal instructions template for the application

  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/JournalInstruction/{JournalInstructionId}

Update a Journal Instruction template

  • JournalInstructionId (path, required) — The journal instruction unique identifier. E.g JI001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/JournalInstructions

Gets the Journal instructions templates for the application

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/JournalInstructions

Creates a new Journal Instruction template

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Permission/{PermissionId}

Deletes the permission object

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permission/{PermissionId}

Gets the permission object

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/Permission/{PermissionId}

Patch permission object

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Permission/{PermissionId}

Puts permisson object

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Permission/{PermissionId}/Tag/{TagId}

Delete Permission tag

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permission/{PermissionId}/Tag/{TagId}

Get Permission tag

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Permission/{PermissionId}/Tag/{TagId}

Insert Permission tag

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permission/{PermissionId}/Tags

Get tags from Permission

  • PermissionId (path, required) — The permission unique identifier. E.g PERM001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permissions

Gets all permission objects

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Permissions

Post permisson object

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permissions/Tag/{TagId}

Get links to tagged Permissions

  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Permissions/Tags

Get all Permission tags

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Query

Get the query result

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/ReferenceData/JournalExpressionDataTable

Gets the journal expression data schema

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/ACTPAYINS/run

Runs the active pay instructions report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • EmployeeKey (query, required) — The employee unique key. E.g. EE001
  • ActiveOn (query) — The active date to consider. E.g 2017-04-05
  • FromDate (query, required) — The lower filter date. E.g 2016-04-06
  • ToDate (query) — The upper filter date. E.g 2017-04-05
  • Type (query) — the data type to filter on. E.g. TaxPayInstruction
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/AOELIABILITY/run

Runs the AOE liability report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • TaxPeriod (query) — The tax period number.
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/DPSMSG/run

Runs the DPS message report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • FromDate (query, required) — The lower filter date. E.g 2016-04-06
  • ToDate (query) — The upper filter date. E.g 2017-04-05
  • MessageTypes (query) — The DPS message types as a CSV list. E.g. P6,P9,SL1,SL2
  • MessageStatuses (query) — The DPS message status as a CSV list. E.g. Retrieved,Processed,Blocked,Ignored
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/EMPSUM/run

Runs the employer summary report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • ContextDate (query, required) — The date context for the report. E.g. 2018-04-30
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/P32/run

Runs the P32 report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/GRO2NET/run

Runs the gross to net report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • TaxPeriod (query) — The tax period number.
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/HOLBAL/run

Runs the holiday balance report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • HolidayYearEnd (query, required) — The holiday year end for the report. E.g. 2018-12-31
  • EmployeeCodes (query) — A comma separated list of the employee codes. E.g. EMP001,EMP002
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/JOURNAL/run

Runs the journal report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayFrequency (query, required) — The pay frequency option. E.g. Monthly
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • TaxPeriod (query) — The tax period number.
  • LedgerTarget (query, required) — Specific to JOURNAL report, a filter used to select the journal lines for the specified ledger target. E.g. [Default]
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/LASTPAYDATE/run

Runs the last pay date report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • EmployeeKey (query, required) — The employee unique key. E.g. EE001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/NETPAY/run

Runs the net pay report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • TaxPeriod (query) — The tax period number.
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/NEXTPERIOD/run

Runs the next pay period report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/P11SUM/run

Runs the P11 summary report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/P32SUM/run

Runs the P32 summary report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/P45/run

Runs the P45 report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • EmployeeKey (query, required) — The employee unique key. E.g. EE001
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/P60/run

Runs the P60 report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • EmployeeCodes (query) — A comma separated list of the employee codes. E.g. EMP001,EMP002
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/PAPDIS/run

Runs the PAPDIS report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • PaymentDate (query) — The payment date context for the report. E.g. 2018-04-30
  • PensionKey (query, required) — The pension scheme unique key. E.g. PENSCH001
  • MessageFunctionCode (query, required) — Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol / Receive Contributions).
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/PASS/run

Runs the PASS report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • PaymentDate (query) — The payment date context for the report. E.g. 2018-04-30
  • PensionKey (query, required) — The pension scheme unique key. E.g. PENSCH001
  • MessageFunctionCode (query, required) — Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol / Receive Contributions).
  • IntermediaryId (query, required) — Specific to PensionSync PASS report, a unique identifier for the Intermediary who is acting on behalf of the employer.
  • DocumentId (query, required) — Specific to PensionSync PASS report, a document identifier unique for this document within the Intermediary.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Schemas

Get a list of all available schemas

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Schemas/{DtoDataType}

Get XSD schema

  • DtoDataType (path, required) — The data transfer object type name. E.g PensionPayInstruction
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Secret/{SecretId}

Deletes Application secret

  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/PAYDASHBOARD/run

Runs the Pay Dashboard payslips report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • EmployeeCodes (query) — A comma separated list of the employee codes. E.g. EMP001,EMP002
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • PaymentDate (query) — The payment date context for the report. E.g. 2018-04-30
  • PublicationDate (query, required) — Specific to the Pay Dashboard report, allows the specification of a future payslip publication date. E.g. 2018-12-31
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/PAYSLIP3/run

Runs the verbose payslip report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • PayScheduleKey (query, required) — The pay schedule unique key. E.g. SCH001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • EmployeeCodes (query) — A comma separated list of the employee codes. E.g. EMP001,EMP002
  • TransformDefinitionKey (query) — The transform definition unique key. E.g. P45-Pdf
  • StartIndex (query) — The element index to begin the report. Used to control paging within large data sets. E.g. 1
  • MaxIndex (query) — The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
  • PaymentDate (query) — The payment date context for the report. E.g. 2018-04-30
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/PENLIABILITY/run

Runs the pension liability report

  • EmployerKey (query, required) — The employer unique key. E.g. ER001
  • TaxYear (query, required) — The tax year. E.g. 2017 = 2017/18 year.
  • PensionKey (query, required) — The pension scheme unique key. E.g. PENSCH001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Report/{ReportDefinitionId}

Deletes a report definition

  • ReportDefinitionId (path, required) — The report definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/{ReportDefinitionId}

Get the report definition

  • ReportDefinitionId (path, required) — The report definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Report/{ReportDefinitionId}

Updates a report definition

  • ReportDefinitionId (path, required) — The report definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Report/{ReportDefinitionId}/run

Runs the specified report definition

  • ReportDefinitionId (path, required) — The report definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Reports

Gets all reports

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Reports

Create a new report definition

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Secret/{SecretId}

Get Application secret

  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Secret/{SecretId}

Create a new Application secret

  • SecretId (path, required) — The secret unique identifier. E.g ERSEC001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Secrets

Get all Application secret links

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Secrets

Create a new Application secret

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Template/{DtoDataType}

Get the object template

  • DtoDataType (path, required) — The data transfer object type name. E.g PensionPayInstruction
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Templates

Get a list of all available data object tempaltes

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/Transform/{TransformDefinitionId}

Deletes a transform definition

  • TransformDefinitionId (path, required) — The transform definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Transform/{TransformDefinitionId}

Get the transform definition

  • TransformDefinitionId (path, required) — The transform definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/Transform/{TransformDefinitionId}

Updates a transform definition

  • TransformDefinitionId (path, required) — The transform definition unique identifier.
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Transforms

Gets all transform definitions

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Transforms

Create a new transform definition

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/User/{UserId}

Deletes the user object

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/User/{UserId}

Gets the user object

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PATCH

/User/{UserId}

Patch user object

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/User/{UserId}

Puts user object

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/User/{UserId}/Permissions

Gets the user permissions

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
DELETE

/User/{UserId}/Tag/{TagId}

Delete user tag

  • UserId (path, required) — The user unique identifier. E.g USER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/User/{UserId}/Tag/{TagId}

Get user tag

  • UserId (path, required) — The user unique identifier. E.g USER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
PUT

/User/{UserId}/Tag/{TagId}

Insert user tag

  • UserId (path, required) — The user unique identifier. E.g USER001
  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/User/{UserId}/Tags

Get tags from user

  • UserId (path, required) — The user unique identifier. E.g USER001
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Users

Gets all user objects

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
POST

/Users

Post user object

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Users/Tag/{TagId}

Get links to tagged users

  • TagId (path, required) — The tag unique identifier. E.g. MyTag
  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.
GET

/Users/Tags

Get all user tags

  • Authorization (header, required) — The OAuth 1 authorization header. 'Auto' enables auto complete.
  • Api-Version (header, required) — The version of the api to target. Omit or set as 'default' to target the current api version.

389 endpoints auto-detected

curl -X DELETE \
  "https://api.test.payrun.io/Employer/{EmployerId}/CisLineType/{CisLineTypeId}"

api.test.payrun.io · HTTPS only