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.
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.