No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
For more information, please visit http://www.staffology.co.uk.
PHP 8.1 and later.
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/synergitech/staffology-php.git"
}
],
"require": {
"synergitech/staffology-php": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/Staffology-PHP/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AccountApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$brandCode = 'brandCode_example'; // string
$autoActivate = false; // bool | If autoActivate is set to true, the account activation should be automatically performed without any user interaction
$user = new \SynergiTech\Staffology\Model\User(); // \SynergiTech\Staffology\Model\User
try {
$result = $apiInstance->activateAccount($brandCode, $autoActivate, $user);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->activateAccount: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AccountApi | activateAccount | POST /account/activate | Activate an Account |
AccountApi | changeEmailAddressAccount | POST /account/emailaddress | Change Email Address |
AccountApi | createApiKeyAccount | POST /account/keys | Create ApiKey |
AccountApi | createDemoEmployerAccount | POST /account/demo | Create Demo Employer |
AccountApi | deleteApiKeyAccount | DELETE /account/keys/{id} | Delete ApiKey |
AccountApi | getAccount | GET /account | Get Account Details |
AccountApi | getApiKeyAccount | GET /account/keys/{id} | Get ApiKey |
AccountApi | getEmployerDefaultsAccount | GET /account/employerdefaults | Get EmployerDefaults |
AccountApi | getInvitationsAccount | GET /account/invitations | Get Invitations |
AccountApi | getTenantAccount | GET /account/Tenant | Get Tenant |
AccountApi | getUserEmployersAccount | GET /account/useremployers | List User Employers |
AccountApi | listApiKeysAccount | GET /account/keys | List ApiKeys |
AccountApi | profileAccount | POST /account/profile | Update Profile |
AccountApi | setEmployerDefaultsAccount | PUT /account/employerdefaults | Set EmployerDefaults |
AccountApi | updatePhotoAccount | POST /account/photo | Update Photo |
AccountApi | verifyAccount | POST /account/verify | Re-send Verification Email |
AccountApi | verifyResponseAccount | PUT /account/verify/respond | Verify Email Address |
AnalysisCategoryApi | createAnalysisCategory | POST /employers/{employerId}/analysiscategories | Create AnalysisCategory |
AnalysisCategoryApi | createAnalysisCategoryCodeAnalysisCategory | POST /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes | Create AnalysisCategoryCode |
AnalysisCategoryApi | deleteAnalysisCategory | DELETE /employers/{employerId}/analysiscategories/{id} | Delete AnalysisCategory |
AnalysisCategoryApi | deleteAnalysisCategoryCodeAnalysisCategory | DELETE /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code} | Delete AnalysisCategoryCode |
AnalysisCategoryApi | getAnalysisCategory | GET /employers/{employerId}/analysiscategories/{id} | Get AnalysisCategory |
AnalysisCategoryApi | getAnalysisCategoryCodeAnalysisCategory | GET /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code} | Get AnalysisCategoryCode |
AnalysisCategoryApi | getCodesAnalysisCategory | GET /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes | List AnalysisCategoryCodes |
AnalysisCategoryApi | indexAnalysisCategory | GET /employers/{employerId}/analysiscategories | List AnalysisCategories |
AnalysisCategoryApi | updateAnalysisCategory | PUT /employers/{employerId}/analysiscategories/{id} | Update AnalysisCategory |
AnalysisCategoryApi | updateAnalysisCategoryCodeAnalysisCategory | PUT /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code} | Update AnalysisCategoryCode |
AttachmentOrderApi | addDocumentAttachmentOrder | POST /employers/{employerId}/employees/{employeeId}/attachmentorders/{id}/documents | Add Document |
AttachmentOrderApi | createAttachmentOrder | POST /employers/{employerId}/employees/{employeeId}/attachmentorders | Create AttachmentOrder |
AttachmentOrderApi | deleteAttachmentOrder | DELETE /employers/{employerId}/employees/{employeeId}/attachmentorders/{id} | Delete AttachmentOrder |
AttachmentOrderApi | deleteDocumentAttachmentOrder | DELETE /employers/{employerId}/employees/{employeeId}/attachmentorders/{id}/documents/{documentId} | Delete AttachmentOrder Document |
AttachmentOrderApi | getAttachmentOrder | GET /employers/{employerId}/employees/{employeeId}/attachmentorders/{id} | Get AttachmentOrder |
AttachmentOrderApi | getDocumentAttachmentOrder | GET /employers/{employerId}/employees/{employeeId}/attachmentorders/{id}/documents/{documentId} | Get AttachmentOrder Document |
AttachmentOrderApi | indexAttachmentOrder | GET /employers/{employerId}/employees/{employeeId}/attachmentorders | List AttachmentOrders |
AttachmentOrderApi | paymentsAttachmentOrder | GET /employers/{employerId}/employees/{employeeId}/attachmentorders/payments/{taxYear} | Get Payments |
AttachmentOrderApi | updateAttachmentOrder | PUT /employers/{employerId}/employees/{employeeId}/attachmentorders/{id} | Update AttachmentOrder |
AuditApi | employerAuditListAudit | GET /employers/{employerId}/audit | Employer Audit Log |
AutoEnrolmentApi | assessAutoEnrolment | POST /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments | Assess Employee for AutoEnrolment |
AutoEnrolmentApi | deleteAutoEnrolment | DELETE /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/{id} | Delete AE Assessment |
AutoEnrolmentApi | emailAllLettersAutoEnrolment | POST /employers/{employerId}/autoenrolment/letters/email | Email All Letters |
AutoEnrolmentApi | emailLetterAutoEnrolment | POST /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/{id}/letter/email | Email Letter |
AutoEnrolmentApi | getAutoEnrolment | GET /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/{id} | Get AE Assessment |
AutoEnrolmentApi | getLastAutoEnrolment | GET /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/last | Get Last AE Assessment |
AutoEnrolmentApi | getLetterAutoEnrolment | GET /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/{id}/letter | Get Letter |
AutoEnrolmentApi | listAutoEnrolment | GET /employers/{employerId}/employees/{employeeId}/autoenrolment | Get AE Assessments |
AutoEnrolmentApi | markLetterAsSentAutoEnrolment | PUT /employers/{employerId}/employees/{employeeId}/autoenrolment/assessments/{id}/letter/sent | Mark Letter as Sent |
AutoEnrolmentApi | markLettersAsSentAutoEnrolment | PUT /employers/{employerId}/autoenrolment/letters/sent | Mark All Letters as Sent |
AutoEnrolmentApi | pendingLettersAutoEnrolment | GET /employers/{employerId}/autoenrolment/letters/pending | Pending Letters |
AutoEnrolmentApi | pendingLettersCountAutoEnrolment | GET /employers/{employerId}/autoenrolment/letters/pending/count | Pending Letters Count |
AutoEnrolmentApi | pendingPostponementLettersAutoEnrolment | GET /employers/{employerId}/autoenrolment/letters/pending/postponement | Pending Postponement Letters |
AutoEnrolmentApi | reenrolAutoEnrolment | GET /employers/{employerId}/autoenrolment/renrol | Cyclical Re-enrolment |
AutoEnrolmentApi | setStateAutoEnrolment | PUT /employers/{employerId}/employees/{employeeId}/autoenrolment/state | Update State |
AverageHolidayPayHistoryApi | createAverageHolidayPayHistory | POST /{employerId}/employees/AverageHolidayPay/PayHistory | Create multiple AverageHolidayPayHistory for an Employer |
AverageHolidayPayHistoryApi | deleteAverageHolidayPayHistory | DELETE /{employerId}/employees/AverageHolidayPay/PayHistory/{id} | Delete an AverageHolidayPayHistory record |
AverageHolidayPayHistoryApi | deleteByEmployeeIdAverageHolidayPayHistory | DELETE /{employerId}/employees/{employeeId}/AverageHolidayPay/PayHistory | Delete all AverageHolidayPayHistory for an Employee |
AverageHolidayPayHistoryApi | getByEmployeeAverageHolidayPayHistory | GET /{employerId}/employees/{employeeId}/AverageHolidayPay/PayHistory/{taxYear} | List AverageHolidayPayHistory for Employee |
AverageHolidayPayHistoryApi | getByEmployerAverageHolidayPayHistory | GET /{employerId}/employees/AverageHolidayPay/PayHistory | Get AverageHolidayPayHistory for Employer |
AverageHolidayPayHistoryApi | importCsvAverageHolidayPayHistory | POST /{employerId}/employees/AverageHolidayPay/PayHistory/import | Import AverageHistoryPayHistory from csv file |
AverageHolidayPayHistoryApi | updateAverageHolidayPayHistory | PUT /{employerId}/employees/AverageHolidayPay/PayHistory | Update multiple AverageHolidayPayHistory for an Employer |
BenefitsApi | createBenefits | POST /employers/{employerId}/employees/{employeeId}/benefits | Create Benefit |
BenefitsApi | deleteBenefits | DELETE /employers/{employerId}/employees/{employeeId}/benefits/{id} | Delete Benefit |
BenefitsApi | getBenefits | GET /employers/{employerId}/employees/{employeeId}/benefits/{id} | Get Benefit |
BenefitsApi | indexBenefits | GET /employers/{employerId}/employees/{employeeId}/benefits | List Benefits |
BenefitsApi | updateBenefits | PUT /employers/{employerId}/employees/{employeeId}/benefits/{id} | Update Benefit |
BillingApi | billBilling | GET /billing/bill/{id} | Get Bill |
BillingApi | billCsvBilling | GET /billing/bill/{id}/csv | Get Bill CSV |
BillingApi | billsBilling | GET /billing/bills | List Bills |
BillingApi | confirmDirectDebitMandateBilling | GET /billing/directdebit/confirm | Confirm Direct Debit Setup |
BillingApi | deleteDirectDebitMandateBilling | DELETE /billing/directdebit | Delete DirectDebitMandate |
BillingApi | directDebitMandateBilling | GET /billing/directdebit | Get DirectDebitMandate |
BillingApi | getUsageStatsBilling | GET /billing/usage-stats | Get UsageStats Report |
BillingApi | setupDirectDebitMandateBilling | GET /billing/directdebit/setup | Setup DirectDebitMandate |
BureauApi | employersBureau | GET /bureau/employers | List Employers |
BureauApi | getProcessorUserBureau | GET /employers/{employerId}/bureau/settings/processor | Get Processor |
BureauApi | getReportPackBureau | GET /employers/{employerId}/bureau/settings/reportpack | Get BureauSettings ReportPack |
BureauApi | getSettingsBureau | GET /employers/{employerId}/bureau/settings | Get BureauSettings |
BureauApi | processorUsersBureau | GET /bureau/processors | List Allocated Processors |
BureauApi | updateSettingsBureau | PUT /employers/{employerId}/bureau/settings | Update BureauSettings |
Cis300Api | createCis300 | POST /employers/{employerId}/rti/cis300/{taxYear} | Create Cis300 |
Cis300Api | deleteCis300 | DELETE /employers/{employerId}/rti/cis300/{taxYear}/{id} | Delete Cis300 |
Cis300Api | getCis300 | GET /employers/{employerId}/rti/cis300/{taxYear}/{id} | Get Cis300 |
Cis300Api | getXmlRequestCis300 | GET /employers/{employerId}/rti/cis300/{taxYear}/{id}/xml/request | Get XML Request |
Cis300Api | listCis300 | GET /employers/{employerId}/rti/cis300/{taxYear} | List Cis300 |
Cis300Api | markAsAcceptedCis300 | POST /employers/{employerId}/rti/cis300/{taxYear}/{id}/markasaccepted | Mark as Sent |
Cis300Api | requiringAttentionCis300 | GET /employers/{employerId}/rti/cis300/requiringattention | Cis300 Requiring Attention |
Cis300Api | submitCis300 | POST /employers/{employerId}/rti/cis300/{taxYear}/{id}/submit | Submit Cis300 |
Cis300Api | updateCis300 | PUT /employers/{employerId}/rti/cis300/{taxYear}/{id} | Update Cis300 |
CisVerificationApi | createCisVerification | POST /employers/{employerId}/rti/cis-verification/{taxYear} | Create CisVerificationRequest |
CisVerificationApi | deleteCisVerification | DELETE /employers/{employerId}/rti/cis-verification/{taxYear}/{id} | Delete CisVerificationRequest |
CisVerificationApi | getCisVerification | GET /employers/{employerId}/rti/cis-verification/{taxYear}/{id} | Get CisVerificationRequest |
CisVerificationApi | getXmlRequestCisVerification | GET /employers/{employerId}/rti/cis-verification/{taxYear}/{id}/xml/request | Get XML Request |
CisVerificationApi | listCisVerification | GET /employers/{employerId}/rti/cis-verification/{taxYear} | List CisVerificationRequest |
CisVerificationApi | markAsAcceptedCisVerification | POST /employers/{employerId}/rti/cis-verification/{taxYear}/{id}/markasaccepted | Mark as Sent |
CisVerificationApi | requiringAttentionCisVerification | GET /employers/{employerId}/rti/cis-verification/requiringattention | CisVerificationRequest Requiring Attention |
CisVerificationApi | submitCisVerification | POST /employers/{employerId}/rti/cis-verification/{taxYear}/{id}/submit | Submit CisVerificationRequest |
CisVerificationApi | updateCisVerification | PUT /employers/{employerId}/rti/cis-verification/{taxYear}/{id} | Update CisVerificationRequest |
CostCentreApi | createCostCentre | POST /employers/{employerId}/costcentres | Create Cost Centre |
CostCentreApi | deleteCostCentre | DELETE /employers/{employerId}/costcentres/{code} | Delete Cost Centre (deprecated) |
CostCentreApi | deleteCostCentreCostCentre | DELETE /employers/{employerId}/costcentres | Delete Cost Centre |
CostCentreApi | getCostCentre | GET /employers/{employerId}/costcentres/{code} | Get Cost Centre (deprecated) |
CostCentreApi | getCostCentreCostCentre | GET /employers/{employerId}/costcentres/costcentre | Get Cost Centre |
CostCentreApi | indexCostCentre | GET /employers/{employerId}/costcentres | List Cost Centres |
CostCentreApi | updateCostCentre | PUT /employers/{employerId}/costcentres/{code} | Update Cost Centre (deprecated) |
CostCentreApi | updateCostCentreCostCentre | PUT /employers/{employerId}/costcentres | Update Cost Centre |
DepartmentApi | createDepartment | POST /employers/{employerId}/departments | Create Department |
DepartmentApi | deleteDepartment | DELETE /employers/{employerId}/departments/{code} | Delete Department (deprecated) |
DepartmentApi | deleteDepartmentDepartment | DELETE /employers/{employerId}/departments/department | Delete Department |
DepartmentApi | getDepartment | GET /employers/{employerId}/departments/{code} | Get Department (deprecated) |
DepartmentApi | getDepartmentDepartment | GET /employers/{employerId}/departments/Department | Get Department |
DepartmentApi | indexDepartment | GET /employers/{employerId}/departments | List Departments |
DepartmentApi | updateDepartment | PUT /employers/{employerId}/departments/{code} | Update Department (deprecated) |
DepartmentApi | updateDepartmentDepartment | PUT /employers/{employerId}/departments/department | Update Department |
DpsApi | applyDps | PUT /employers/{employerId}/dps/notices/{id} | Apply Notice |
DpsApi | checkForNoticesDps | POST /employers/{employerId}/dps/notices | Check for new Notices |
DpsApi | deleteAllDps | DELETE /employers/{employerId}/dps/notices | Delete All Notices |
DpsApi | deleteDps | DELETE /employers/{employerId}/dps/notices/{id} | Delete Notice |
DpsApi | getDps | GET /employers/{employerId}/dps/notices/{id} | Get Notice |
DpsApi | getDpsSettingsDps | GET /employers/{employerId}/dps/settings | Get DPS Settings |
DpsApi | listNoticesDps | GET /employers/{employerId}/dps/notices | List Notices |
DpsApi | parseXmlDps | POST /employers/{employerId}/dps/notices/xml | Parse notices from XML |
DpsApi | reapplyNoticesDps | PUT /employers/{employerId}/dps/reapply | Reapply DpsNotices |
DpsApi | updateDpsSettingsDps | PUT /employers/{employerId}/dps/settings | Update DPS Settings |
EmailApi | getEmailEmail | GET /employers/{employerId}/email/{emailId} | Get Email |
EmailApi | getMailSettingsEmail | GET /employers/{employerId}/email/settings | Get MailSettings |
EmailApi | indexEmail | GET /employers/{employerId}/email | List Emails |
EmailApi | resendEmailEmail | POST /employers/{employerId}/email/{emailId} | Re-send Email |
EmailApi | testMailSettingsEmail | POST /employers/{employerId}/email/settings/test | Send Test Email |
EmailApi | updateMailSettingsEmail | PUT /employers/{employerId}/email/settings | Update MailSettings |
EmailApi | verifyMailSettingsEmail | POST /employers/{employerId}/email/settings/verify | Email Verification (Request) |
EmailApi | verifyMailSettingsResponseEmail | PUT /employers/{employerId}/email/settings/verify | Email Verification (Respond) |
EmployeeApi | applyPayIncreaseEmployee | PUT /employers/{employerId}/employees/payincrease | Apply Pay Increase |
EmployeeApi | applyPayOptionsEmployee | PUT /employers/{employerId}/employees/payoptions | Apply PayOptions |
EmployeeApi | averageWeeklyEarningsEmployee | GET /employers/{employerId}/employees/{id}/awe | Average Weekly Earnings |
EmployeeApi | baseDailyRateEmployee | GET /employers/{employerId}/employees/{id}/basedailyrate | Calculate Base Daily Rate (deprecated) |
EmployeeApi | baseHourlyRateEmployee | GET /employers/{employerId}/employees/{id}/basehourlyrate | Calculate Base Hourly Rate (deprecated) |
EmployeeApi | createEmployee | POST /employers/{employerId}/employees | Create a new Employee |
EmployeeApi | deleteEmployee | DELETE /employers/{employerId}/employees/{id} | Delete an Employee |
EmployeeApi | deleteMultipleEmployee | POST /employers/{employerId}/employees/delete | Delete Employees |
EmployeeApi | deletePhotoEmployee | DELETE /employers/{employerId}/employees/{id}/photo | Delete Photo |
EmployeeApi | expiringRtwEmployee | GET /employers/{employerId}/employees/expiring-rtw | Expiring RightToWork |
EmployeeApi | getDepartmentMembershipsEmployee | GET /employers/{employerId}/employees/{id}/departments | Get Employee Departments |
EmployeeApi | getEmployee | GET /employers/{employerId}/employees/{id} | Get an Employee |
EmployeeApi | getEmployeeCostCentresEmployee | GET /employers/{employerId}/employees/{id}/costcentres | Get Employee Cost Centres |
EmployeeApi | getEvcSettingsEmployee | GET /employers/{employerId}/employees/{id}/evcsettings | Get EvcSettings |
EmployeeApi | importCsvEmployee | POST /employers/{employerId}/employees/import | Import CSV |
EmployeeApi | indexEmployee | GET /employers/{employerId}/employees | List Employees |
EmployeeApi | leaversEmployee | GET /employers/{employerId}/employees/leavers | List Leavers |
EmployeeApi | markAsLeaversEmployee | PUT /employers/{employerId}/employees/leavers | Mark as Leavers |
EmployeeApi | minimumWageEmployee | GET /employers/{employerId}/employees/{id}/{taxYear}/minimum-wage | Minimum Wage |
EmployeeApi | payRunEntriesEmployee | GET /employers/{employerId}/employees/{id}/payrunentries/{taxYear} | PayRunEntries for Employee |
EmployeeApi | reHireEmployee | GET /employers/{employerId}/employees/{id}/rehire | Rehire an Employee |
EmployeeApi | searchByPayrollCodeEmployee | GET /employers/{employerId}/employees/search/payrollcode | Get Employee by Payroll Code |
EmployeeApi | searchEmployee | GET /employers/{employerId}/employees/search | Search Employer for Employees |
EmployeeApi | setDepartmentMembershipsEmployee | PUT /employers/{employerId}/employees/{id}/departments | Set Employee Departments |
EmployeeApi | setEmployeeCostCentresEmployee | PUT /employers/{employerId}/employees/{id}/costcentres | Set Employee Cost Centres |
EmployeeApi | setOnHoldEmployee | PUT /employers/{employerId}/employees/onhold | Mark as On Hold |
EmployeeApi | updateEmployee | PUT /employers/{employerId}/employees/{id} | Update an Employee |
EmployeeApi | updateEvcSettingsEmployee | PUT /employers/{employerId}/employees/{id}/evcsettings | Update EvcSettings |
EmployeeApi | updatePhotoEmployee | POST /employers/{employerId}/employees/{id}/photo | Update Photo |
EmployeeRoleApi | createEmployeeRole | POST /employers/{employerId}/employees/{employeeId}/roles | Create Employee Role |
EmployeeRoleApi | createRoleWorkingPatternEmployeeRole | POST /employers/{employerId}/employees/{employeeId}/roles/{id}/workingpatterns | Create Employee Role Working Pattern |
EmployeeRoleApi | deleteEmployeeRole | DELETE /employers/{employerId}/employees/{employeeId}/roles/{id} | Delete Employee Role |
EmployeeRoleApi | deleteRoleWorkingPatternEmployeeRole | DELETE /employers/{employerId}/employees/{employeeId}/roles/{id}/workingpatterns/{roleWorkingPatternId} | Delete Employee Role Working Pattern |
EmployeeRoleApi | getBaseDailyRateEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{roleId}/basedailyrate | Calculate Base Daily Rate |
EmployeeRoleApi | getBaseHourlyRateEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{roleId}/basehourlyrate | Calculate Base Hourly Rate |
EmployeeRoleApi | getCostCentreMembershipsEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id}/costcentres | Get Employee Role Cost Centres |
EmployeeRoleApi | getDepartmentMembershipsEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id}/departments | Get Employee Role Departments |
EmployeeRoleApi | getEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id} | Get Employee Role |
EmployeeRoleApi | getEmployeeRoleAnalysisCategoryCodesEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id}/analysiscategorycodes | Get Employee Role AnalysisCategoryCode |
EmployeeRoleApi | getRoleAssumedPensionablePayEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{roleId}/assumedpensionablepay | Calculate Assumed Pensionable Pay |
EmployeeRoleApi | getRoleWorkingPatternEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id}/workingpatterns/{roleWorkingPatternId} | Get Employee Role Working Pattern |
EmployeeRoleApi | indexEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles | List Employee Roles |
EmployeeRoleApi | listRoleWorkingPatternsEmployeeRole | GET /employers/{employerId}/employees/{employeeId}/roles/{id}/workingpatterns | List Working Patterns for an Employee Role |
EmployeeRoleApi | setCostCentreMembershipsEmployeeRole | PUT /employers/{employerId}/employees/{employeeId}/roles/{id}/costcentres | Set Employee Role Cost Centres |
EmployeeRoleApi | setDepartmentMembershipsEmployeeRole | PUT /employers/{employerId}/employees/{employeeId}/roles/{id}/departments | Set Employee Role Departments |
EmployeeRoleApi | setEmployeeRoleAnalysisCategoryCodesEmployeeRole | PUT /employers/{employerId}/employees/{employeeId}/roles/{id}/analysiscategories/{analysisCategoryId}/analysiscategorycodes | Set Employee Role AnalysisCategorycode |
EmployeeRoleApi | updateEmployeeRole | PUT /employers/{employerId}/employees/{employeeId}/roles/{id} | Update Employee Role |
EmployeeRoleApi | updateRoleWorkingPatternEmployeeRole | PUT /employers/{employerId}/employees/{employeeId}/roles/{id}/workingPatterns/{roleWorkingPatternId} | Update Employee Role Working Pattern |
EmployerApi | applyYearEndEmployer | PUT /employers/{id}/YearEnd | Make Year End Changes |
EmployerApi | calendarEmployer | GET /employers/{id}/calendar | Get Employer Calendar |
EmployerApi | createEmployer | POST /employers | Create an Employer |
EmployerApi | customPayslipEmployer | GET /employers/{id}/custompayslip | Get Payslip Customisations |
EmployerApi | deleteEmployer | DELETE /employers/{id} | Delete an Employer |
EmployerApi | getAutomationSettingsEmployer | GET /employers/{id}/automation | Get Automation Settings |
EmployerApi | getEmployer | GET /employers/{id} | Get an Employer |
EmployerApi | getEmployerOpeningBalancesEmployer | GET /employers/{id}/openingbalances | Get EmployerOpeningBalances |
EmployerApi | getEvcOptInHistoryEmployer | GET /employers/{id}/evc | Get EVC OptIn History |
EmployerApi | getGroupMembershipsEmployer | GET /employers/{id}/groups | Get Employer Groups |
EmployerApi | importCsvEmployer | POST /employers/import | Import CSV |
EmployerApi | indexEmployer | GET /employers | List Employers |
EmployerApi | listUsersEmployer | GET /employers/{id}/users | List Users |
EmployerApi | removeUserEmployer | DELETE /employers/{id}/users/{userId} | Remove User |
EmployerApi | reviewYearEndEmployer | GET /employers/{id}/YearEnd | Review Year End Changes |
EmployerApi | rtiRequiringAttentionEmployer | GET /employers/{id}/rti/requiringattention | RTI Documents Requiring Attention |
EmployerApi | searchEmployeesEmployer | GET /employers/employees/search | Search Employees |
EmployerApi | searchEmployer | GET /employers/search | Search Employers |
EmployerApi | setEvcOptInEmployer | PUT /employers/{id}/evc | Update EVC OptIn |
EmployerApi | setGroupMembershipsEmployer | PUT /employers/{id}/groups | Set Employer Groups |
EmployerApi | setOwnerEmployer | PUT /employers/{id}/users/owner | Set Owner |
EmployerApi | suggestPayCodeEmployer | GET /employers/{id}/suggestPayrollCode | Suggest Payroll Code |
EmployerApi | updateAutomationSettingsEmployer | PUT /employers/{id}/automation | Update Automation Settings |
EmployerApi | updateCustomPayslipEmployer | POST /employers/{id}/custompayslip | Update Payslip Customisations |
EmployerApi | updateEmployer | PUT /employers/{id} | Update an Employer |
EmployerApi | updateEmployerOpeningBalancesEmployer | PUT /employers/{id}/openingbalances | Update EmployerOpeningBalances |
EmployerApi | updateLogoEmployer | POST /employers/{id}/logo | Update Employer Logo |
EmployerGroupApi | createEmployerGroup | POST /employers/groups | Create EmployerGroup |
EmployerGroupApi | deleteEmployerGroup | DELETE /employers/groups/{code} | Delete EmployerGroup |
EmployerGroupApi | getEmployerGroup | GET /employers/groups/{code} | Get EmployerGroup |
EmployerGroupApi | indexEmployerGroup | GET /employers/groups | List EmployerGroups |
EmployerGroupApi | updateEmployerGroup | PUT /employers/groups/{code} | Update EmployerGroup |
EmployerTemplateApi | getEmployerTemplate | GET /employers/{employerId}/templates/{type} | Get EmployerTemplate |
EmployerTemplateApi | indexEmployerTemplate | GET /employers/{employerId}/templates | List EmployerTemplates |
EmployerTemplateApi | updateEmployerTemplate | PUT /employers/{employerId}/templates/{type} | Update EmployerTemplate |
EngineApi | calculateNiEngine | GET /engine/ni | Calculate NI due. |
EngineApi | calculateTaxEngine | GET /engine/tax | Calculate Tax due |
EngineApi | configEngine | GET /engine/config | Get Configuration |
EngineApi | getNationalInsuranceThresholdsEngine | GET /engine/config/{taxYear}/ni/{payPeriod} | Get National Insurance Thresholds |
EngineApi | getTenantBrandingEngine | GET /engine/branding/{brandCode} | Tenant Branding |
EpsApi | apprenticeshipLevyEps | GET /employers/{employerId}/rti/eps/{taxYear}/{taxMonth}/apprenticeshipLevytodate | Apprenticeship Levy |
EpsApi | createEps | POST /employers/{employerId}/rti/eps/{taxYear} | Create EPS |
EpsApi | deleteEps | DELETE /employers/{employerId}/rti/eps/{taxYear}/{id} | Delete Eps |
EpsApi | getEps | GET /employers/{employerId}/rti/eps/{taxYear}/{id} | Get EPS |
EpsApi | getXmlRequestEps | GET /employers/{employerId}/rti/eps/{taxYear}/{id}/xml/request | Get XML Request |
EpsApi | listEps | GET /employers/{employerId}/rti/eps/{taxYear} | List EPS |
EpsApi | markAsAcceptedEps | POST /employers/{employerId}/rti/eps/{taxYear}/{id}/markasaccepted | Mark as Sent |
EpsApi | recoverableAmountsEps | GET /employers/{employerId}/rti/eps/{taxYear}/{taxMonth}/recoverableamounts | Recoverable Amounts |
EpsApi | requiringAttentionEps | GET /employers/{employerId}/rti/eps/requiringattention | EPS Requiring Attention |
EpsApi | submitEps | POST /employers/{employerId}/rti/eps/{taxYear}/{id}/submit | Submit EPS |
EpsApi | updateEps | PUT /employers/{employerId}/rti/eps/{taxYear}/{id} | Update EPS |
ExbApi | annualValuesExb | GET /employers/{employerId}/rti/exb/{taxYear}/values | Annual Values |
ExbApi | createExb | POST /employers/{employerId}/rti/exb/{taxYear} | Create EXB |
ExbApi | deleteExb | DELETE /employers/{employerId}/rti/exb/{taxYear}/{id} | Delete EXB |
ExbApi | getExb | GET /employers/{employerId}/rti/exb/{taxYear}/{id} | Get EXB |
ExbApi | getXmlRequestExb | GET /employers/{employerId}/rti/exb/{taxYear}/{id}/xml/request | Get XML Request |
ExbApi | listExb | GET /employers/{employerId}/rti/exb/{taxYear} | List EXB |
ExbApi | markAsAcceptedExb | POST /employers/{employerId}/rti/exb/{taxYear}/{id}/markasaccepted | Mark as Sent |
ExbApi | requiringAttentionExb | GET /employers/{employerId}/rti/exb/requiringattention | EXB Requiring Attention |
ExbApi | submitExb | POST /employers/{employerId}/rti/exb/{taxYear}/{id}/submit | Submit EXB |
ExbApi | updateExb | PUT /employers/{employerId}/rti/exb/{taxYear}/{id} | Update EXB |
ExternalDataApi | authorizeExternalData | GET /employers/{employerId}/external-data/{id}/authorize | Get Authorization Url |
ExternalDataApi | companiesExternalData | GET /employers/{employerId}/external-data/{id}/companies | List Companies |
ExternalDataApi | disconnectExternalData | GET /employers/{employerId}/external-data/{id}/disconnect | Disconnect |
ExternalDataApi | employeeExternalData | GET /employers/{employerId}/external-data/{id}/employees/{employeeId} | Get Employee |
ExternalDataApi | employeeLogsExternalData | GET /employers/{employerId}/external-data/{id}/employees/{employeeId}/logs | Get Employee Logs |
ExternalDataApi | employeesExternalData | GET /employers/{employerId}/external-data/{id}/employees | List Employees |
ExternalDataApi | getConfigDataExternalData | GET /employers/{employerId}/external-data/{id}/config | Get Config Data |
ExternalDataApi | importEmployeesExternalData | POST /employers/{employerId}/external-data/{id}/employees | Import Employees |
ExternalDataApi | listExternalData | GET /employers/{employerId}/external-data | List Providers |
ExternalDataApi | nominalCodesExternalData | GET /employers/{employerId}/external-data/{id}/nominals | List Nominal Codes |
ExternalDataApi | pensionContributionsCsvExternalData | GET /employers/{employerId}/external-data/{id}/contributions/{taxYear}/{payPeriod}/{periodNumber} | Contributions CSV File |
ExternalDataApi | postJournalExternalData | POST /employers/{employerId}/external-data/{id}/{taxYear}/{payPeriod}/{periodNumber}/journal | Post Journal |
ExternalDataApi | postPaymentsExternalData | POST /employers/{employerId}/external-data/{id}/{taxYear}/{payPeriod}/{periodNumber}/payments | Post Payments |
ExternalDataApi | pushEmployeesExternalData | PUT /employers/{employerId}/external-data/{id}/employees/push | Push Employees |
ExternalDataApi | pushP11DExternalData | POST /employers/{employerId}/external-data/{id}/p11d | Push P11D |
ExternalDataApi | pushP11DsExternalData | POST /employers/{employerId}/external-data/{id}/p11ds | Push P11Ds |
ExternalDataApi | pushP45ExternalData | POST /employers/{employerId}/external-data/{id}/p45 | Push P45 |
ExternalDataApi | pushP45sExternalData | POST /employers/{employerId}/external-data/{id}/p45s | Push P45s |
ExternalDataApi | pushP60ExternalData | POST /employers/{employerId}/external-data/{id}/p60 | Push P60 |
ExternalDataApi | pushP60sExternalData | POST /employers/{employerId}/external-data/{id}/p60s | Push P60s |
ExternalDataApi | pushPayslipsExternalData | POST /employers/{employerId}/external-data/{id}/payslips | Push Payslips |
ExternalDataApi | pushPensionLetterExternalData | POST /employers/{employerId}/external-data/{id}/pension-letter | Push Pension Letter |
ExternalDataApi | pushPensionLettersExternalData | POST /employers/{employerId}/external-data/{id}/pension-letters | Push Pension Letters |
ExternalDataApi | respondExternalData | GET /external-data/{id}/respond | 3rd Party Response |
ExternalDataApi | setConfigDataExternalData | PUT /employers/{employerId}/external-data/{id}/config | Set Config Data |
ExternalDataApi | setCredentialsExternalData | PUT /employers/{employerId}/external-data/{id}/authorize | Set Credentials |
ExternalDataApi | syncAllEmployeesExternalData | GET /employers/{employerId}/external-data/{id}/employees/i/sync-all | Sync Employees |
ExternalDataApi | syncEmployeeExternalData | GET /employers/{employerId}/external-data/{id}/employees/{employeeId}/sync | Sync Employee |
ExternalDataApi | syncLeaveExternalData | POST /employers/{employerId}/external-data/{id}/{taxYear}/{payPeriod}/{periodNumber}/leave | Sync Leave |
ExternalDataApi | timeAndAttendanceExternalData | GET /employers/{employerId}/external-data/{id}/time-and-attendance | Get Time And Attendance Data |
ExternalDataApi | updateEmployeeExternalData | PUT /employers/{employerId}/external-data/{id}/employees/{employeeId} | Update Employee |
FpsApi | createFps | POST /employers/{employerId}/rti/fps/{taxYear} | Create FPS |
FpsApi | deleteFps | DELETE /employers/{employerId}/rti/fps/{taxYear}/{id} | Delete FPS |
FpsApi | getFps | GET /employers/{employerId}/rti/fps/{taxYear}/{id} | Get FPS |
FpsApi | getXmlRequestFps | GET /employers/{employerId}/rti/fps/{taxYear}/{id}/xml/request | Get XML Request |
FpsApi | listFps | GET /employers/{employerId}/rti/fps/{taxYear} | List FPS |
FpsApi | markAsAcceptedFps | POST /employers/{employerId}/rti/fps/{taxYear}/{id}/markasaccepted | Mark as Sent |
FpsApi | mostRecentForEmployeeFps | GET /employers/{employerId}/rti/fps/{taxYear}/mostrecentforemployee/{employeeId} | Get most recent FPS for Employee |
FpsApi | requiringAttentionFps | GET /employers/{employerId}/rti/fps/requiringattention | FPS Requiring Attention |
FpsApi | submitFps | POST /employers/{employerId}/rti/fps/{taxYear}/{id}/submit | Submit FPS |
FpsApi | updateFps | PUT /employers/{employerId}/rti/fps/{taxYear}/{id} | Update FPS |
HmrcPaymentApi | bankPaymentHmrcPayment | GET /employers/{employerId}/hmrcpayment/{taxYear}/{periodEnding}/bankpayment | HMRC Bank Payment |
HmrcPaymentApi | getHmrcPayment | GET /employers/{employerId}/hmrcpayment/{taxYear}/{periodEnding} | Get HmrcLiability |
HmrcPaymentApi | indexHmrcPayment | GET /employers/{employerId}/hmrcpayment/{taxYear} | List HmrcLiabilities |
HmrcPaymentApi | updateHmrcPayment | PUT /employers/{employerId}/hmrcpayment/{taxYear}/{periodEnding} | Update HmrcLiability |
HolidaySchemeApi | createHolidayScheme | POST /employers/{employerId}/holidayscheme | Create holiday scheme |
HolidaySchemeApi | deleteHolidayScheme | DELETE /employers/{employerId}/holidayscheme/{id} | Delete holiday scheme |
HolidaySchemeApi | getByIdHolidayScheme | GET /employers/{employerId}/holidayscheme/{id} | Get holiday scheme by Id |
HolidaySchemeApi | getHolidayScheme | GET /employers/{employerId}/holidayscheme | Get holiday scheme |
HolidaySchemeApi | updateHolidayScheme | PUT /employers/{employerId}/holidayscheme/{id} | Update holiday scheme |
ImportApi | createPaymentsCsvMappingImport | POST /employers/{employerId}/import/payments/mappings | Create PaymentsCsvMapping |
ImportApi | deletePaymentCsvMappingImport | DELETE /employers/{employerId}/import/payments/mappings/{id} | Delete PaymentsCsvMapping |
ImportApi | employeeImportCsvImport | POST /employers/{employerId}/import/employees/async | Import Employees Asynchronously (Beta) |
ImportApi | importEmployeePayImport | POST /employers/{employerId}/import/pay | Import Pay To Employee |
ImportApi | importLeaveImport | POST /employers/{employerId}/import/leave | Import Leave Asynchronously |
ImportApi | importPensionMembershipsImport | POST /employers/{employerId}/import/pensionmemberships | Import PensionMemberships from csv file |
ImportApi | importRolesImport | POST /employers/{employerId}/import/import | Import EmployeeRoles from csv file |
ImportApi | listPaymentsCsvMappingsImport | GET /employers/{employerId}/import/payments/mappings | List PaymentsCsvMappings |
ImportApi | paymentsCsvMappingCsvFileImport | GET /employers/{employerId}/import/payments/mappings/{id}/csv | Get PaymentsCsvMapping CSV File |
ImportApi | paymentsCsvMappingImport | GET /employers/{employerId}/import/payments/mappings/{id} | Get PaymentsCsvMapping |
ImportApi | updatePaymentsCsvMappingImport | PUT /employers/{employerId}/import/payments/mappings/{id} | Update PaymentsCsvMapping |
InvitationApi | acceptInvitation | POST /invitations/{id} | Accept Invitation |
InvitationApi | createInvitation | POST /employers/{employerId}/invitation | Create Invitation |
InvitationApi | deleteInvitation | DELETE /employers/{employerId}/invitation/{id} | Delete Invitation |
InvitationApi | getInvitation | GET /employers/{employerId}/invitation/{id} | Get Invitation |
InvitationApi | indexInvitation | GET /employers/{employerId}/invitation | List Invitations |
JobApi | deleteCompletedJobsJob | DELETE /jobs/completed | Delete Completed Jobs |
JobApi | getJobErrorsByJobIdJob | GET /jobs/{jobId}/errors | Get Job Errors |
JobApi | getJobJob | GET /jobs/{jobId} | Get Job |
JobApi | getJobsListJob | GET /jobs | List Jobs |
JobApi | getReportJobResultJob | GET /jobs/{jobId}/document | Get Job file |
JournalTemplateApi | createJournalTemplate | POST /employers/{employerId}/journaltemplate | Create Journal Template |
JournalTemplateApi | getJournalTemplate | GET /employers/{employerId}/journaltemplate | Get Journal Template |
JournalTemplateApi | updateJournalTemplate | PUT /employers/{employerId}/journaltemplate/{id} | Update Journal Template |
JournalTokenApi | createCostCentreJournalOverridesJournalToken | POST /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides | Create CostCentre Journal Overrides |
JournalTokenApi | createDepartmentJournalOverridesJournalToken | POST /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides | Create Department Journal Overrides |
JournalTokenApi | createJournalToken | POST /employers/{employerId}/journaltokens | Create Journal Token |
JournalTokenApi | deleteJournalToken | DELETE /employers/{employerId}/journaltokens/{id} | Delete Journal Token |
JournalTokenApi | getCostCentreJournalOverridesListJournalToken | GET /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides | List CostCentre Journal Overrides |
JournalTokenApi | getDepartmentJournalOverridesListJournalToken | GET /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides | List Department Journal Overrides |
JournalTokenApi | getJournalToken | GET /employers/{employerId}/journaltokens/{id} | Get Journal Token |
JournalTokenApi | indexJournalToken | GET /employers/{employerId}/journaltokens | List Journal Tokens |
JournalTokenApi | updateCostCentreJournalOverridesJournalToken | PUT /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides | Update CostCentre Journal Overrides |
JournalTokenApi | updateDepartmentJournalOverridesJournalToken | PUT /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides | Update Department Journal Overrides |
JournalTokenApi | updateJournalToken | PUT /employers/{employerId}/journaltokens/{id} | Update Journal Token |
LeaveApi | addDocumentLeave | POST /employers/{employerId}/employees/{employeeId}/leave/{id}/documents | Add Document |
LeaveApi | createLeave | POST /employers/{employerId}/employees/{employeeId}/leave | Create Leave |
LeaveApi | deleteDocumentLeave | DELETE /employers/{employerId}/employees/{employeeId}/leave/{id}/documents/{documentId} | Delete Leave Document |
LeaveApi | deleteLeave | DELETE /employers/{employerId}/employees/{employeeId}/leave/{id} | Delete Leave |
LeaveApi | findLinkedPiwLeave | GET /employers/{employerId}/employees/{employeeId}/leave/findlinkedpiw | Find Linked Piw |
LeaveApi | getDocumentLeave | GET /employers/{employerId}/employees/{employeeId}/leave/{id}/documents/{documentId} | Get Leave Document |
LeaveApi | getLeave | GET /employers/{employerId}/employees/{employeeId}/leave/{id} | Get Leave |
LeaveApi | getMaternityLeaveScheduleLeave | GET /employers/{employerId}/employees/{employeeId}/leave/statutorymaternityschedule | List Statutory Maternity Leave History |
LeaveApi | getOccupationalMaternityScheduleLeave | GET /employers/{employerId}/employees/{employeeId}/leave/occupationalmaternityschedule/{id} | List occupational Maternity Leave History |
LeaveApi | indexLeave | GET /employers/{employerId}/employees/{employeeId}/leave | List Leave |
LeaveApi | updateLeave | PUT /employers/{employerId}/employees/{employeeId}/leave/{id} | Update Leave |
LoanApi | addDocumentLoan | POST /employers/{employerId}/employees/{employeeId}/loans/{id}/documents | Add Document |
LoanApi | createLoan | POST /employers/{employerId}/employees/{employeeId}/loans | Create Loan |
LoanApi | deleteDocumentLoan | DELETE /employers/{employerId}/employees/{employeeId}/loans/{id}/documents/{documentId} | Delete Loan Document |
LoanApi | deleteLoan | DELETE /employers/{employerId}/employees/{employeeId}/loans/{id} | Delete Loan |
LoanApi | getDocumentLoan | GET /employers/{employerId}/employees/{employeeId}/loans/{id}/documents/{documentId} | Get Loan Document |
LoanApi | getLoan | GET /employers/{employerId}/employees/{employeeId}/loans/{id} | Get Loan |
LoanApi | indexLoan | GET /employers/{employerId}/employees/{employeeId}/loans | List Loans |
LoanApi | updateLoan | PUT /employers/{employerId}/employees/{employeeId}/loans/{id} | Update Loan |
NoteApi | addDocumentNote | POST /employers/{employerId}/employees/{employeeId}/notes/{id}/documents | Add Document |
NoteApi | createNote | POST /employers/{employerId}/employees/{employeeId}/notes | Create Note |
NoteApi | deleteDocumentNote | DELETE /employers/{employerId}/employees/{employeeId}/notes/{id}/documents/{documentId} | Delete Note Document |
NoteApi | deleteNote | DELETE /employers/{employerId}/employees/{employeeId}/notes/{id} | Delete Note |
NoteApi | getDocumentNote | GET /employers/{employerId}/employees/{employeeId}/notes/{id}/documents/{documentId} | Get Note Document |
NoteApi | getNote | GET /employers/{employerId}/employees/{employeeId}/notes/{id} | Get Note |
NoteApi | indexNote | GET /employers/{employerId}/employees/{employeeId}/notes | List Notes |
NoteApi | updateNote | PUT /employers/{employerId}/employees/{employeeId}/notes/{id} | Update Note |
NvrApi | createNvr | POST /employers/{employerId}/rti/nvr/{taxYear} | Create NVR |
NvrApi | deleteNvr | DELETE /employers/{employerId}/rti/nvr/{taxYear}/{id} | Delete NVR |
NvrApi | getNvr | GET /employers/{employerId}/rti/nvr/{taxYear}/{id} | Get NVR |
NvrApi | getXmlRequestNvr | GET /employers/{employerId}/rti/nvr/{taxYear}/{id}/xml/request | Get XML Request |
NvrApi | listNvr | GET /employers/{employerId}/rti/nvr/{taxYear} | List NVR |
NvrApi | markAsAcceptedNvr | POST /employers/{employerId}/rti/nvr/{taxYear}/{id}/markasaccepted | Mark as Sent |
NvrApi | requiringAttentionNvr | GET /employers/{employerId}/rti/nvr/requiringattention | NVR Requiring Attention |
NvrApi | submitNvr | POST /employers/{employerId}/rti/nvr/{taxYear}/{id}/submit | Submit an existing NVR |
NvrApi | updateNvr | PUT /employers/{employerId}/rti/nvr/{taxYear}/{id} | Update NVR |
OccupationalPolicyApi | createOccupationalPolicy | POST /employers/{employerId}/occupationalpolicies | Create Occupational Policy |
OccupationalPolicyApi | deleteOccupationalPolicy | DELETE /employers/{employerId}/occupationalpolicies/{id} | Delete Occupational Policy |
OccupationalPolicyApi | getOccupationalPolicy | GET /employers/{employerId}/occupationalpolicies/{id} | Get Occupational Policy |
OccupationalPolicyApi | indexOccupationalPolicy | GET /employers/{employerId}/occupationalpolicies | List Occupational Policies |
OccupationalPolicyApi | updateOccupationalPolicy | PUT /employers/{employerId}/occupationalpolicies/{id} | Update Occupational Policy |
OccupationalSickLeaveHistoryApi | createOccupationalSickLeaveHistory | POST /employers/{employerId}/occupationalsickleavehistory/employees/{employeeId} | Create OccupationalSickLeaveHistory |
OccupationalSickLeaveHistoryApi | deleteOccupationalSickLeaveHistory | DELETE /employers/{employerId}/occupationalsickleavehistory/employees/{employeeId}/{id} | Delete OccupationalSickLeaveHistory |
OccupationalSickLeaveHistoryApi | getOccupationalSickLeaveHistory | GET /employers/{employerId}/occupationalsickleavehistory/employees/{employeeId}/{id} | Get OccupationalSickLeaveHistory |
OccupationalSickLeaveHistoryApi | importOccupationalSickLeaveHistoryCsvOccupationalSickLeaveHistory | POST /employers/{employerId}/occupationalsickleavehistory/importfile | Import OccupationalSickLeaveHistory from csv file |
OccupationalSickLeaveHistoryApi | occupationalSickLeaveHistoryOccupationalSickLeaveHistory | GET /employers/{employerId}/occupationalsickleavehistory/employees/{employeeId} | List OccupationalSickLeaveHistory |
OccupationalSickLeaveHistoryApi | updateOccupationalSickLeaveHistory | PUT /employers/{employerId}/occupationalsickleavehistory/employees/{employeeId}/{id} | Update OccupationalSickLeaveHistory |
OccupationalSickLeaveHistoryApi | uploadOSPHistoryOccupationalSickLeaveHistory | POST /employers/{employerId}/occupationalsickleavehistory/import | Upload OccupationalSickLeaveHistory |
OpeningBalancesApi | createNicSummaryOpeningBalances | POST /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear} | Create NicSummary |
OpeningBalancesApi | deleteNicSummaryOpeningBalances | DELETE /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear}/{uniqueId} | Delete NicSummary |
OpeningBalancesApi | getNicSummariesOpeningBalances | GET /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear} | Get NicSummaries |
OpeningBalancesApi | getNicSummaryOpeningBalances | GET /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear}/{uniqueId} | Get NicSummary |
OpeningBalancesApi | getOpeningBalances | GET /employers/{employerId}/employees/{employeeId}/openingBalances | Get Opening Balances |
OpeningBalancesApi | getOpeningBalancesTotalsOpeningBalances | GET /employers/{employerId}/employees/openingbalances/{taxYear} | Totals of employee opening balances for a tax year |
OpeningBalancesApi | updateNicSummariesOpeningBalances | PUT /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear} | Update NicSummaries |
OpeningBalancesApi | updateNicSummaryOpeningBalances | PUT /employers/{employerId}/employees/{employeeId}/openingBalances/nic/{taxYear}/{uniqueId} | Update NicSummary |
OpeningBalancesApi | updateOpeningBalances | PUT /employers/{employerId}/employees/{employeeId}/openingBalances | Update Opening Balances |
OpeningBalancesApi | updateP45OpeningBalances | PUT /employers/{employerId}/employees/{employeeId}/openingBalances/p45 | Update P45 Value |
OpeningBalancesApi | updateTerminationPaymentsOpeningBalances | PUT /employers/{employerId}/employees/{employeeId}/openingBalances/terminationpayments | Update Termination Pay |
P11HistoryApi | createP11History | POST /employers/{employerId}/employees/{employeeId}/p11history | Create P11 Historical data |
P11HistoryApi | deleteP11History | DELETE /employers/{employerId}/employees/{employeeId}/p11history/{id} | Delete P11 Historical data |
P11HistoryApi | listPagedP11History | GET /employers/{employerId}/employees/{employeeId}/p11history | Retrieve P11 Historical data |
P11HistoryApi | updateP11History | PUT /employers/{employerId}/employees/{employeeId}/p11history/{id} | Update P11 Historical entry |
PayCodeApi | createPayCode | POST /employers/{employerId}/paycodes | Create PayCode |
PayCodeApi | deletePayCode | DELETE /employers/{employerId}/paycodes/{code} | Delete PayCode (deprecated) |
PayCodeApi | deletePayCodePayCode | DELETE /employers/{employerId}/paycodes/paycode | Delete PayCode |
PayCodeApi | getPayCode | GET /employers/{employerId}/paycodes/{code} | Get PayCode (deprecated) |
PayCodeApi | getPayCodePayCode | GET /employers/{employerId}/paycodes/paycode | Get PayCode |
PayCodeApi | indexPayCode | GET /employers/{employerId}/paycodes | List PayCodes |
PayCodeApi | nominalCodeMappingsPayCode | GET /employers/{employerId}/paycodes/nominalcodes | Get Nominal Code Mappings |
PayCodeApi | updateNominalCodeMappingsPayCode | PUT /employers/{employerId}/paycodes/nominalcodes | Updates Nominal Code Mappings |
PayCodeApi | updatePayCode | PUT /employers/{employerId}/paycodes/{code} | Update PayCode (deprecated) |
PayCodeApi | updatePayCodePayCode | PUT /employers/{employerId}/paycodes/paycode | Update PayCode |
PayCodeSetApi | createPayCodeSet | POST /employers/{employerId}/paycodesets | Create PayCodeSet |
PayCodeSetApi | deletePayCodeSet | DELETE /employers/{employerId}/paycodesets/{id} | Delete PayCodeSet |
PayCodeSetApi | getPayCodeSet | GET /employers/{employerId}/paycodesets/{id} | Get PayCodeSet |
PayCodeSetApi | indexPayCodeSet | GET /employers/{employerId}/paycodesets | List PayCodeSets |
PayCodeSetApi | updatePayCodeSet | PUT /employers/{employerId}/paycodesets/{id} | Update PayCodeSet |
PayRunApi | addPayRunEntriesPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/addpayrunentries | Add PayRunEntries (deprecated) |
PayRunApi | aeoPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/aeo | List AttachmentOrders related to a PayRun |
PayRunApi | calculateAverageHolidayPayPayRun | GET /employers/{employerId}/payrun/employees/{employeeId}/averageholidaypayrate | Calculate Average Holiday Pay Rate |
PayRunApi | changesForPayRunEntryPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/{id}/changes | List PayRun Changes for PayRunEntry |
PayRunApi | changesPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/changes | List PayRun Changes |
PayRunApi | createNextPayRunPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod} | Starts the next PayRun |
PayRunApi | deletePayRun | DELETE /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber} | Delete a PayRun |
PayRunApi | emailMultipleP45sPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/p45/email | (Re)send P45 Emails |
PayRunApi | finalisePayRunPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/finalise | Finalise a PayRun (deprecated) |
PayRunApi | getPayRunEntryPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/{id} | Get a PayRunEntry |
PayRunApi | getPayRunEventsPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/events | Get PayPeriodEvents |
PayRunApi | getPayRunJournalPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/journal | Get Journal for PayRun |
PayRunApi | getPayRunPayCodesPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/paycodes | Get PayCodes for a PayRun |
PayRunApi | getPayRunPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber} | Get a PayRun |
PayRunApi | getPayRunStateHistoryPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/stateHistory | List PayRunStateHistory |
PayRunApi | getPayRunWarningsPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/warnings | Get PayRun Warnings |
PayRunApi | getPayRunsPayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod} | List PayRuns |
PayRunApi | importPayPayRun | POST /employers/{employerId}/payrun/{payPeriod}/importpay | Import Pay |
PayRunApi | importTimeAndAttendancePayRun | POST /employers/{employerId}/payrun/{payPeriod}/importtimeandattendance | Import Time And Attendance |
PayRunApi | importUmbrellaPayPayRun | POST /employers/{employerId}/payrun/{payPeriod}/importumbrellapay | Import Umbrella Pay |
PayRunApi | lastPayRunEntryForEmployeePayRun | GET /employers/{employerId}/payrun/employees/{employeeId}/Last | Gets the last closed pay run entry for an employee. |
PayRunApi | lastPayRunEntryWithPensionYtdValuesForEmployeePayRun | GET /employers/{employerId}/payrun/{taxYear}/employees/{employeeId}/pension/{pensionUniqueId}/pensionytd | Gets last PayRunEntry for a Pension |
PayRunApi | leavePayRun | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/leave | List Leave related to a PayRun |
PayRunApi | payRunEntryUmbrellaPaymentPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/{id}/umbrella | PayRunEntry Umbrella Payment |
PayRunApi | reOpenPayRunPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/reopen | Re-open a PayRun (deprecated) |
PayRunApi | removePayRunEntriesPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/removepayrunentries | Remove PayRunEntries (deprecated) |
PayRunApi | sendPayslipEmailsPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/email | (Re)send Payslip Emails |
PayRunApi | startNextPayRunPayRun | PUT /employers/{employerId}/payrun/{taxYear}/{payPeriod} | Starts the next PayRun (deprecated) |
PayRunApi | updatePayRunEntryPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/{id} | Update a PayRunEntry |
PayRunApi | updatePayRunPayRun | PUT /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber} | Update PayRun |
PayRunApi | updatePaymentDatePayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/paymentdate | Set PaymentDate |
PayRunApi | ytdPayRun | PUT /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/ytd | Update YTD |
PayRunApi | zeroisePayRunEntriesPayRun | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/zeroise | Zeroise PayRunEntries |
PayRunAsyncApi | importPayPayRunAsync | POST /employers/{employerId}/payrun-async/{payPeriod}/importpay | Import Pay (beta) |
PayRunAsyncApi | queueCreatePayRunPayRunAsync | POST /employers/{employerId}/payrun-async/{taxYear}/{payPeriod} | Registers a request to start the next PayRun (beta) |
PayRunAsyncApi | queueDeletePayRunPayRunAsync | DELETE /employers/{employerId}/payrun-async/{taxYear}/{payPeriod}/{periodNumber} | Registers a request to delete a PayRun (beta) |
PayRunAsyncApi | queueUpdatePayRunPayRunAsync | PUT /employers/{employerId}/payrun-async/{taxYear}/{payPeriod}/{periodNumber} | Registers a request to update the PayRun (beta) |
PayScheduleApi | createPaySchedule | POST /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal} | Create a PaySchedule |
PayScheduleApi | createWithOptionalOrdinalPaySchedule | POST /employers/{employerId}/schedules/{taxYear}/{payPeriod} | Create a PaySchedule (deprecated) |
PayScheduleApi | deletePaySchedule | DELETE /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal} | Delete PaySchedule |
PayScheduleApi | deleteWithOptionalOrdinalPaySchedule | DELETE /employers/{employerId}/schedules/{taxYear}/{payPeriod} | Delete PaySchedule (deprecated) |
PayScheduleApi | getAllPaySchedule | GET /employers/{employerId}/schedules/{taxYear} | Get PaySchedules |
PayScheduleApi | getPaySchedule | GET /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal} | Get PaySchedule |
PayScheduleApi | getPeriodsPaySchedule | GET /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal}/periods | Get PaySchedulePeriods |
PayScheduleApi | getWithOptionalOrdinalPaySchedule | GET /employers/{employerId}/schedules/{taxYear}/{payPeriod} | Get PaySchedule (deprecated) |
PayScheduleApi | savePaySchedule | PUT /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal} | Update PaySchedule |
PayScheduleApi | saveWithOptionalOrdinalPaySchedule | PUT /employers/{employerId}/schedules/{taxYear}/{payPeriod} | Update PaySchedule (deprecated) |
PayScheduleApi | updatePaySchedulePeriodPaySchedule | PUT /employers/{employerId}/schedules/{taxYear}/{payPeriod}/{ordinal}/periods/{periodNumber} | Update PaySchedulePeriod |
PaySpineApi | createAllowanceGradesPaySpine | POST /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades | Create AllowanceGrade |
PaySpineApi | createLondonAllowancePaySpine | POST /employers/{employerId}/payspines/{paySpineId}/londonallowances | Create LondonAllowance |
PaySpineApi | createMultipleAllowanceGradesPaySpine | POST /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades/create/bulk | Create Multiple AllowanceGrades |
PaySpineApi | createMultiplePaySpine | POST /employers/{employerId}/payspines/{paySpineId}/spinalpoints/bulk | Create Multiple SpinalPoints |
PaySpineApi | createMultipleSpineAllowancePaySpine | POST /employers/{employerId}/payspines/{paySpineId}/allowances/create/bulk | Create Multiple SpineAllowances |
PaySpineApi | createPaySpine | POST /employers/{employerId}/payspines | Create PaySpine |
PaySpineApi | createPaySpineGradePaySpine | POST /employers/{employerId}/payspines/{paySpineId}/paygrades | Create PaySpine Grade |
PaySpineApi | createSpinalPointPaySpine | POST /employers/{employerId}/payspines/{paySpineId}/spinalpoints | Create SpinalPoint |
PaySpineApi | createSpineAllowancePaySpine | POST /employers/{employerId}/payspines/{paySpineId}/allowances | Create SpineAllowance |
PaySpineApi | deleteAllAllowanceGradesPaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades | Delete All AllowanceGrades Associated with a PaySpine |
PaySpineApi | deleteAllSpinalPointsPaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/spinalpoints | Delete All SpinalPoints Associated with a PaySpine |
PaySpineApi | deleteAllSpineAllowancesPaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/allowances | Delete All SpineAllowances Associated with a PaySpine |
PaySpineApi | deleteAllowanceGradePaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades/{allowanceGradeId} | Delete AllowanceGrade |
PaySpineApi | deleteLondonAllowancePaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/londonallowances/{londonAllowanceId} | Delete LondonAllowance |
PaySpineApi | deletePaySpine | DELETE /employers/{employerId}/payspines/{id} | Delete PaySpine |
PaySpineApi | deletePaySpineGradePaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/paygrades/{payGradeId} | Delete PaySpine Grade |
PaySpineApi | deleteSpinalPointPaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/spinalpoints/{spinalPointId} | Delete SpinalPoint |
PaySpineApi | deleteSpineAllowancePaySpine | DELETE /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceid} | Delete SpineAllowance |
PaySpineApi | getAllowanceGradePaySpine | GET /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades/{allowanceGradeId} | Get AllowanceGrade |
PaySpineApi | getAllowanceGradesPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades | List AllowanceGrades |
PaySpineApi | getAnnualValueFromSalaryFormulaPaySpine | GET /employers/{employerId}/payspines/{id}/annualsalarybypayspines | Get Annual Value from pay spines formula |
PaySpineApi | getLondonAllowanceListPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/londonallowances | List LondonAllowances |
PaySpineApi | getLondonAllowancePaySpine | GET /employers/{employerId}/payspines/{paySpineId}/londonallowances/{londonAllowanceId} | Get LondonAllowance |
PaySpineApi | getPaySpine | GET /employers/{employerId}/payspines/{id} | Get PaySpine |
PaySpineApi | getPaySpineGradeListPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/paygrades | List PaySpine Grade |
PaySpineApi | getPaySpineGradePaySpine | GET /employers/{employerId}/payspines/{paySpineId}/paygrades/{payGradeId} | Get PaySpine Grade |
PaySpineApi | getSpinalPointListPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/spinalpoints | List SpinalPoints |
PaySpineApi | getSpinalPointPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/spinalpoints/{spinalPointId} | Get SpinalPoint |
PaySpineApi | getSpineAllowanceListPaySpine | GET /employers/{employerId}/payspines/{paySpineId}/allowances | List SpineAllowances |
PaySpineApi | getSpineAllowancePaySpine | GET /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceid} | Get SpineAllowance |
PaySpineApi | importCsvPaySpine | POST /employers/{employerId}/payspines/spinalpoints/import | Import SpinalPoints from csv file |
PaySpineApi | importCsvPaySpinePaySpine | POST /employers/{employerId}/payspines/import | Import PaySpine from csv file |
PaySpineApi | importPayspineGradeCsvPaySpine | POST /employers/{employerId}/payspines/paygrades/import | Import SpineGrades from csv file |
PaySpineApi | indexPaySpine | GET /employers/{employerId}/payspines | List PaySpine |
PaySpineApi | updateAllowanceGradePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades/{allowanceGradeId} | Update AllowanceGrade |
PaySpineApi | updateLondonAllowancePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/londonallowances/{londonAllowanceId} | Update LondonAllowance |
PaySpineApi | updateMultipleAllowanceGradesPaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceId}/allowancegrades/update/bulk | Update Multiple AllowanceGrades |
PaySpineApi | updateMultiplePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/spinalpoints/bulk | Update Multiple SpinalPoints |
PaySpineApi | updateMultipleSpineAllowancePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/allowances/update/bulk | Update Multiple SpineAllowances |
PaySpineApi | updatePayGradePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/paygrades/{payGradeId} | Update PaySpine Grade |
PaySpineApi | updatePaySpine | PUT /employers/{employerId}/payspines/{id} | Update PaySpine |
PaySpineApi | updateSpinalPointPaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/spinalpoints/{spinalPointId} | Update SpinalPoint |
PaySpineApi | updateSpineAllowancePaySpine | PUT /employers/{employerId}/payspines/{paySpineId}/allowances/{allowanceid} | Update SpineAllowance |
PayeeApi | createPayee | POST /employers/{employerId}/payees | Create Payee |
PayeeApi | deletePayee | DELETE /employers/{employerId}/payees/{id} | Delete Payee |
PayeeApi | getPayee | GET /employers/{employerId}/payees/{id} | Get Payee |
PayeeApi | indexPayee | GET /employers/{employerId}/payees | List Payees |
PayeeApi | updatePayee | PUT /employers/{employerId}/payees/{id} | Update Payee |
PensionApi | createPension | POST /employers/{employerId}/employees/{employeeId}/pension | Create Pension |
PensionApi | getDeprecatedPension | GET /employers/{employerId}/employees/{employeeId}/pension | Get Pension (deprecated) |
PensionApi | getPension | GET /employers/{employerId}/employees/{employeeId}/pension/{id} | Get Pension |
PensionApi | lastPayRunEntryWithPensionYtdValuesForEmployeePension | GET /employers/{employerId}/employees/{employeeId}/pension/{pensionUniqueId}/{taxYear}/pensionytd | Get last PayRunEntry for a Pension (deprecated) |
PensionApi | listPension | GET /employers/{employerId}/employees/{employeeId}/pension/list | List Pensions |
PensionApi | removeDeprecatedPension | DELETE /employers/{employerId}/employees/{employeeId}/pension | Remove Pension (deprecated) |
PensionApi | removePension | DELETE /employers/{employerId}/employees/{employeeId}/pension/{id} | Remove Pension |
PensionApi | updateDeprecatedPension | PUT /employers/{employerId}/employees/{employeeId}/pension | Update Pension (deprecated) |
PensionApi | updatePension | PUT /employers/{employerId}/employees/{employeeId}/pension/{id} | Update Pension |
PensionRefundApi | createPensionRefund | POST /employers/{employerId}/employees/{employeeId}/pensionrefund | Create Pension Refund |
PensionRefundApi | deletePensionRefund | DELETE /employers/{employerId}/employees/{employeeId}/pensionrefund/{id} | Delete Pension Refund |
PensionRefundApi | getPensionRefund | GET /employers/{employerId}/employees/{employeeId}/pensionrefund/{id} | Get Pension Refund |
PensionRefundApi | indexPensionRefund | GET /employers/{employerId}/employees/{employeeId}/pensionrefund | List Pension Refunds |
PensionRefundApi | issueRefundForCurrentPensionSchemePensionRefund | POST /employers/{employerId}/employees/{employeeId}/pensionrefund/autocalculated | Issue Pension Refund (deprecated) |
PensionRefundApi | issueRefundForPensionPensionRefund | POST /employers/{employerId}/employees/{employeeId}/pensionrefund/{pensionId}/autocalculated | Issue Pension Refund |
PensionRefundApi | updatePensionRefund | PUT /employers/{employerId}/employees/{employeeId}/pensionrefund/{id} | Update Pension Refund |
PensionSchemeApi | contributionsForPayrunPensionScheme | GET /employers/{employerId}/pensionschemes/{id}/contributions/{taxYear}/{payPeriod}/{periodNumber} | Contributions for Payrun |
PensionSchemeApi | contributionsPensionScheme | GET /employers/{employerId}/pensionschemes/{id}/contributions/{taxYear}/{submissionId} | Contributions Data |
PensionSchemeApi | createPensionScheme | POST /employers/{employerId}/pensionschemes | Create a PensionScheme |
PensionSchemeApi | deletePensionScheme | DELETE /employers/{employerId}/pensionschemes/{id} | Delete a PensionScheme |
PensionSchemeApi | employeesPensionScheme | GET /employers/{employerId}/pensionschemes/{id}/employees | Get Employees |
PensionSchemeApi | getPensionScheme | GET /employers/{employerId}/pensionschemes/{id} | Get a PensionScheme |
PensionSchemeApi | indexPensionScheme | GET /employers/{employerId}/pensionschemes | List PensionSchemes |
PensionSchemeApi | listContributionsPensionScheme | GET /employers/{employerId}/pensionschemes/{id}/contributions/{taxYear} | List Contributions |
PensionSchemeApi | markAsSentPensionScheme | POST /employers/{employerId}/pensionschemes/{id}/contributions/{taxYear}/{submissionId}/markassent | Mark as Sent |
PensionSchemeApi | resubmitContributionsPensionScheme | POST /employers/{employerId}/pensionschemes/{id}/contributions/{taxYear}/{submissionId} | Re-submit Contributions |
PensionSchemeApi | updatePensionScheme | PUT /employers/{employerId}/pensionschemes/{id} | Update a PensionScheme |
ProcessingNoteApi | addDocumentProcessingNote | POST /employers/{employerId}/payrun/{id}/documents | Add Document |
ProcessingNoteApi | createProcessingNote | POST /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/processingnotes | Create ProcessingNote |
ProcessingNoteApi | deleteDocumentProcessingNote | DELETE /employers/{employerId}/payrun/{id}/documents/{documentId} | Delete ProcessingNote Document |
ProcessingNoteApi | getDocumentProcessingNote | GET /employers/{employerId}/payrun/{id}/documents/{documentId} | Get ProcessingNote Document |
ProcessingNoteApi | getProcessingNote | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/processingnotes/{id} | Get a ProcessingNote |
ProcessingNoteApi | listProcessingNote | GET /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/processingnotes | List ProcessingNotes for a PayRun |
ProcessingNoteApi | setStatusProcessingNote | PUT /employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/processingnotes/{id}/status | Set a ProcessingNote status |
ReportPackApi | createReportPack | POST /employers/{employerId}/reports/packs | Create ReportPack |
ReportPackApi | deleteReportPack | DELETE /employers/{employerId}/reports/packs/{id} | Delete ReportPack |
ReportPackApi | getReportPack | GET /employers/{employerId}/reports/packs/{id} | Get ReportPack |
ReportPackApi | indexReportPack | GET /employers/{employerId}/reports/packs | List ReportPacks |
ReportPackApi | updateReportPack | PUT /employers/{employerId}/reports/packs/{id} | Update ReportPack |
ReportTemplateApi | createReportTemplate | POST /employers/{employerId}/reporttemplates | Create Report Template (beta) |
ReportTemplateApi | deleteReportTemplate | DELETE /employers/{employerId}/reporttemplates/{id} | Delete Report Template (beta) |
ReportTemplateApi | getReportTemplate | GET /employers/{employerId}/reporttemplates/{id} | Get Report Template (beta) |
ReportTemplateApi | indexReportTemplate | GET /employers/{employerId}/reporttemplates | List Report Templates (beta) |
ReportTemplateApi | updateReportTemplate | PUT /employers/{employerId}/reporttemplates/{id} | Update Report Template (beta) |
ReportsApi | advancedVarianceReportReports | GET /employers/{employerId}/reports/advancedvariance | Advanced Variance Report |
ReportsApi | aeAssessmentsReports | GET /employers/{employerId}/reports/AeAssessments | AutoEnrolment Assessments |
ReportsApi | aeoStatementReports | GET /aeo/{employeeId}/{id} | AEO Statement |
ReportsApi | analysisReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/analysis | Analysis |
ReportsApi | apprenticeshipLevyDetailsReports | GET /employers/{employerId}/reports/{taxYear}/apprenticeshiplevy | Apprenticeship Levy Details |
ReportsApi | attachmentOrdersReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/attachmentorders | Attachment Orders |
ReportsApi | averageHolidayPayRateReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/averageholidaypayrate | Average Holiday Pay Rate |
ReportsApi | bankPaymentInstructionsReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payments/employee/credit | Bank Payment Instructions |
ReportsApi | changesReports | GET /employers/{employerId}/reports/changes | Gets audit changes of all employees within a company. |
ReportsApi | cis300Reports | GET /employers/{employerId}/reports/{taxYear}/cis300/{id} | CIS300 |
ReportsApi | cisStatementReports | GET /employers/{employerId}/reports/{taxYear}/cisstatement/{taxMonth} | CIS Statement |
ReportsApi | cisSubContractorSummaryReports | GET /employers/{employerId}/reports/cissummary | CIS Subcontractor Summary |
ReportsApi | costAnalysisReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/costanalysis | Cost Analysis |
ReportsApi | costOfEmploymentReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/costofemployment | Cost Of Employment |
ReportsApi | downloadMaternitySchedulesReports | GET /employers/{employerId}/reports/downloadmaternityschedules | Download Maternity Payment Schedule |
ReportsApi | emailP11DMultipleReports | POST /employers/{employerId}/reports/p11d/email | Email P11D to all Employees |
ReportsApi | emailP11DReports | POST /employers/{employerId}/reports/p11d/email/{employeeId} | Email P11D to an Employee |
ReportsApi | emailP45Reports | POST /employers/{employerId}/reports/p45/email | Email P45 to Employee |
ReportsApi | emailP60MultipleReports | POST /employers/{employerId}/reports/p60/email | Email P60 to all Employees |
ReportsApi | emailP60Reports | POST /employers/{employerId}/reports/p60/email/{employeeId} | Email P60 to an Employee |
ReportsApi | employeeBenefitsReports | GET /employers/{employerId}/reports/{taxYear}/EmployeeBenefits | Employee Benefits |
ReportsApi | employeeExportReports | GET /employees | Employee Export Details |
ReportsApi | employeeLeaveReports | GET /employers/{employerId}/reports/employeeleave | Employee Leave |
ReportsApi | employeeRoleExportReports | GET /employeeroles | Employee Export Roles Details |
ReportsApi | employerChangesReports | GET /employers/{employerId}/reports/employerchanges | Gets audit changes for a company. |
ReportsApi | employerExportReports | GET /employers/{employerId}/reports/employers | Employer Export |
ReportsApi | examplePayslipReports | POST /payslip/example/pdf | Example Payslip |
ReportsApi | exbReports | GET /employers/{employerId}/reports/{taxYear}/exb/{id} | EXB |
ReportsApi | fpsReports | GET /employers/{employerId}/reports/{taxYear}/fps/{id} | FPS |
ReportsApi | fullSummaryOfPayReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/fullsummaryofpay | Cost Of Employment |
ReportsApi | furloughReportReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/furlough | FurloughReport |
ReportsApi | genderPayGapReports | GET /employers/{employerId}/reports/{taxYear}/GenderPayGap | Gender Pay Gap |
ReportsApi | getPayRunCsvReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payruncsv | Get PayRun CSV |
ReportsApi | grossToNetReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/gross-to-net | Gross To Net |
ReportsApi | holidayReports | GET /employers/{employerId}/reports/holiday | Holiday |
ReportsApi | hourlyPayReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/hourly-pay | Hourly Pay |
ReportsApi | loanBalancesReports | GET /employers/{employerId}/reports/{payPeriod}/loanbalances | Loan Balances |
ReportsApi | niLetterValidationReportEmployeesReports | GET /employers/{employerId}/reports/NiLetterValidationReport | NI Letter Validation (Employees) |
ReportsApi | niLetterValidationReportReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/NiLetterValidationReport | NI Letter Validation (Payrun) |
ReportsApi | niYtdReports | GET /niytd | NI Year To Date Values |
ReportsApi | p11DMultipleReports | GET /employers/{employerId}/reports/{taxYear}/p11d | All P11Ds For TaxYear |
ReportsApi | p11DReports | GET /employers/{employerId}/reports/{taxYear}/p11d/{employeeId} | P11D For Employee |
ReportsApi | p11DetailedMultipleReports | GET /employers/{employerId}/reports/{taxYear}/p11detailed | All Detailed P11s For TaxYear |
ReportsApi | p11DetailedReports | GET /employers/{employerId}/reports/{taxYear}/{employeeId}/p11detailed | P11 (Detailed) |
ReportsApi | p11Reports | GET /employers/{employerId}/reports/{taxYear}/{employeeId}/p11 | P11 |
ReportsApi | p30Reports | GET /employers/{employerId}/reports/{taxYear}/p30/{periodEnding} | P30 |
ReportsApi | p32Reports | GET /employers/{employerId}/reports/{taxYear}/p32 | P32 |
ReportsApi | p45Reports | GET /employers/{employerId}/reports/p45 | P45 For Employee |
ReportsApi | p60MultipleReports | GET /employers/{employerId}/reports/{taxYear}/p60 | All P60s For TaxYear |
ReportsApi | p60Reports | GET /employers/{employerId}/reports/{taxYear}/p60/{employeeId} | P60 For Employee |
ReportsApi | papdisFileReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/papdis | PAPDIS File |
ReportsApi | payCodeExportReports | GET /employers/{employerId}/reports/paycodes | Pay Code Export Details |
ReportsApi | payElementReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/pay-element | Pay Element |
ReportsApi | payGradesReports | GET /employers/{employerId}/reports/payGrades | Pay Grade |
ReportsApi | payRunCsvReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payrun-csv | PayRun CSV (deprecated) |
ReportsApi | payRunPaymentsReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payments/employee | PayRun Payments |
ReportsApi | payRunSummaryReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/payrunsummary | PayRunSummary |
ReportsApi | paySpineReports | GET /employers/{employerId}/reports/payspines | Pay Spine |
ReportsApi | payrollAnalysisCostBreakdownReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/analysiscostbreakdown | Analysis Cost Breakdown |
ReportsApi | payrollAnalysisEmployeeRoleBreakdownReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/analysisemployeerolebreakdown | Payroll Analysis with Employee Role Breakdown |
ReportsApi | payrollJournalCsvReportReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payrolljournalcsv | Payroll Journal CSV |
ReportsApi | payrunNiYtdReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/niytd | NI Year To Date Values |
ReportsApi | payrunYtdReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/ytd | Year To Date Values |
ReportsApi | payslipReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/{id}/payslip | Payslip |
ReportsApi | payslipsReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payslips | Payslips |
ReportsApi | pensionMembershipsReports | GET /employers/{employerId}/reports/{taxYear}/pensionmemberships | Export Multiple Pension Memberships Report |
ReportsApi | rightToWorkReports | GET /employers/{employerId}/reports/right-to-work | RightToWork |
ReportsApi | spinePointReports | GET /employers/{employerId}/reports/spinepoints | Spine Point |
ReportsApi | statutoryPayReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/statutory-pay | Statutory Pay |
ReportsApi | taxCodeChangesReports | GET /employers/{employerId}/reports/{taxYear}/taxcode | Taxcode Change |
ReportsApi | teachersPensionEoyReports | GET /employers/{employerId}/reports/{taxYear}/teachersPensionEoy | Teachers Pension Eoy Report |
ReportsApi | umbrellaReconciliationReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/umbrella-reconciliation | Umbrella Reconciliation |
ReportsApi | varianceReportReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/variance | Variance Report |
ReportsApi | warningsReports | GET /employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/PayrollRunWarnings | Export Payroll Run Warnings |
ReportsApi | ytdReports | GET /ytd | Year To Date Values |
ReportsAsyncApi | queueGrossToNetReportReportsAsync | POST /employers/{employerId}/reports-async/gross-to-net | Gross To Net async (beta) |
TagApi | createTag | POST /employers/{employerId}/tags | Create Tag |
TagApi | deleteTag | DELETE /employers/{employerId}/tags/{code} | Delete Tag (deprecated) |
TagApi | deleteTagTag | DELETE /employers/{employerId}/tags/tag | Delete Tag |
TagApi | getTag | GET /employers/{employerId}/tags/{code} | Get Tag (deprecated) |
TagApi | getTagTag | GET /employers/{employerId}/tags/Tag | Get Tag |
TagApi | indexTag | GET /employers/{employerId}/tags | List Tags |
TagApi | updateTag | PUT /employers/{employerId}/tags/{code} | Update Tag (deprecated) |
TagApi | updateTagTag | PUT /employers/{employerId}/tags/tag | Update Tag |
TenantApi | addAdminUserTenant | POST /tenants/{id}/users/admins | Add Admin User |
TenantApi | adminUsersTenant | GET /tenants/{id}/users/admins | List Admin Users |
TenantApi | billTenant | GET /tenants/{id}/bills/{year}/{month}/{billId} | Get Bill |
TenantApi | billsTenant | GET /tenants/{id}/bills/{year}/{month} | Get Bills |
TenantApi | createBillsTenant | POST /tenants/bills | Create Bills for Period |
TenantApi | createPayrollSquadTenant | POST /tenants/{id}/payrollsquad | Create Payroll Squad |
TenantApi | createPricingTableTenant | POST /tenants/{id}/pricingtables | Create PricingTable |
TenantApi | createTenant | POST /tenants | Create a Tenant |
TenantApi | deletePayrollSquadMemberTenant | DELETE /tenants/{id}/payrollsquad/{payrollSquadId}/member/{payrollSquadMemberId} | Delete Payroll Squad Member |
TenantApi | deletePayrollSquadTenant | DELETE /tenants/{id}/payrollsquad/{payrollSquadId} | Delete Payroll Squad and it's Members and Employers. |
TenantApi | deletePricingTableTenant | DELETE /tenants/{id}/pricingtables/{pricingTableId} | Delete PricingTable |
TenantApi | disabledTenant | PUT /tenants/{id}/users/{userId}/disabled | Disable User Account |
TenantApi | employerCreationTenant | PUT /tenants/{id}/users/{userId}/employercreation | Enable Employer Creation |
TenantApi | employerUsageTenant | GET /tenants/{id}/employers/{employerId}/usage | Get Employer Usage |
TenantApi | employerUsersTenant | GET /tenants/{id}/employers/{employerId}/users | Get Employer Users |
TenantApi | getApiMailingListReportByIdTenant | GET /tenants/{id}/reports/apimailinglist | Api Mailing List Report |
TenantApi | getApiMailingListReportTenant | GET /tenants/reports/apimailinglist | Api Mailing List Report |
TenantApi | getEmployersTenant | GET /tenants/{id}/users/employers | Get Employers |
TenantApi | getPayrollSquadTenant | GET /tenants/{id}/payrollsquad/{payrollSquadId} | Get Payroll Squad |
TenantApi | getPayrollSquadsTenant | GET /tenants/{id}/payrollsquad | Get Payroll Squads |
TenantApi | getPricingTableTenant | GET /tenants/{id}/pricingtables/{pricingTableId} | Get PricingTable |
TenantApi | getPricingTablesTenant | GET /tenants/{id}/pricingtables | Get PricingTables |
TenantApi | getRtiSubmissionSettingsTenant | GET /tenants/ritsubmissionsettings | Get RtiSubmissionSettings |
TenantApi | getTenant | GET /tenants/{id} | Get a Tenant |
TenantApi | getUsersWithNoBillableActivityTenant | GET /tenants/{id}/reports/users/nobillableactivity | Get Users with no Billable Activity. |
TenantApi | netSuiteBillingTenant | GET /tenants/{id}/reports/netsuitebills | NetSuite Billing Report |
TenantApi | payrollSquadAddMemberTenant | POST /tenants/{id}/payrollsquad/member | Add Payroll Squad Member |
TenantApi | payrollSquadUpdateEmployersTenant | POST /tenants/{id}/payrollsquad/employers | Update Payroll Squad Employers |
TenantApi | removeAdminUserTenant | DELETE /tenants/{id}/users/admins | Remove Admin User |
TenantApi | setAccountingIdTenant | PUT /tenants/{id}/users/{userId}/accounting | Set User Accounting Id |
TenantApi | setAddressTenant | PUT /tenants/{id}/users/{userId}/address | Set Address |
TenantApi | setBureauRedirectEmailAddressTenant | PUT /tenants/{id}/users/{userId}/bureauredir | Set Bureau Redirect |
TenantApi | setBusinessNameTenant | PUT /tenants/{id}/users/{userId}/businessname | Set User Business Name |
TenantApi | setCountryTenant | PUT /tenants/{id}/users/{userId}/country | Set Country |
TenantApi | setEmployeeCountTenant | PUT /tenants/{id}/users/{userId}/employeecount | Set Employee Count |
TenantApi | setEvcTenant | PUT /tenants/{id}/admin/evc | Set Evc |
TenantApi | setIndustryTenant | PUT /tenants/{id}/users/{userId}/industry | Set Industry |
TenantApi | setMonthlyMinimumTenant | PUT /tenants/{id}/users/{userId}/monthlyminimum | Set Monthly Minimum |
TenantApi | setPricingTableIdTenant | PUT /tenants/{id}/users/{userId}/pricingtable | Set User PricingTableId |
TenantApi | setTenantTenant | PUT /tenants/{id}/users/{userId}/tenant | Set User Tenant |
TenantApi | updateBillTenant | PUT /tenants/{id}/bills/{year}/{month}/{billId} | Update Bill |
TenantApi | updateCssColorsTenant | PUT /tenants/{id}/css/colors | Update CSS Colors |
TenantApi | updateCssTenant | PUT /tenants/{id}/css | Update CSS |
TenantApi | updateFavIconTenant | PUT /tenants/{id}/favicon | Upload Favicon |
TenantApi | updateLogoTenant | PUT /tenants/{id}/logo | Upload Logo |
TenantApi | updatePricingTableTenant | PUT /tenants/{id}/pricingtables/{pricingTableId} | Update PricingTable |
TenantApi | updateRtiSubmissionSettingsTenant | PUT /tenants/ritsubmissionsettings | Update RtiSubmissionSettings |
TenantApi | updateTenant | PUT /tenants/{id} | Update a Tenant |
TenantApi | updateUserTenant | PUT /tenants/{id}/users/{userId} | Update a User |
TenantApi | usageTenant | GET /tenants/{id}/usage/{year}/{month} | Get Usage |
TenantApi | userBillsTenant | GET /tenants/{id}/users/{userId}/bills | Get User Bills |
TenantApi | userEmployersTenant | GET /tenants/{id}/users/{userId}/employers | Get User Employers |
TenantApi | userTenant | GET /tenants/{id}/users/{userId} | Get a User |
TenantApi | usersSearchTenant | GET /tenants/{id}/users/search | Search Users |
TenantApi | usersTenant | GET /tenants/{id}/users | List Users |
TenantApi | weeklyActivityTenant | GET /tenants/{id}/reports/weeklyactivity | Weekly Activity Report |
TenantEmailApi | getEmailTenantEmail | GET /tenants/{id}/email/{emailId} | Get Email |
TenantEmailApi | getMailSettingsTenantEmail | GET /tenants/{id}/email/settings | Get MailSettings |
TenantEmailApi | indexTenantEmail | GET /tenants/{id}/email | List Emails |
TenantEmailApi | resendEmailTenantEmail | POST /tenants/{id}/email/{emailId} | Re-send Email |
TenantEmailApi | testMailSettingsTenantEmail | POST /tenants/{id}/email/settings/test | Send test email |
TenantEmailApi | updateMailSettingsTenantEmail | PUT /tenants/{id}/email/settings | Update MailSettings |
TermCalendarApi | createTermCalendar | POST /employers/{employerId}/termcalendars | Create Term Calendar |
TermCalendarApi | deleteTermCalendar | DELETE /employers/{employerId}/termcalendars/{id} | Delete Term Calendar |
TermCalendarApi | getTermCalendar | GET /employers/{employerId}/termcalendars/{id} | Get Term Calendar |
TermCalendarApi | indexTermCalendar | GET /employers/{employerId}/termcalendars | List Term Calendars |
TermCalendarApi | updateTermCalendar | PUT /employers/{employerId}/termcalendars/{id} | Update Term Calendar |
TermCalendarYearApi | createTermCalendarYear | POST /employers/{employerId}/termcalendaryears/{termCalendarId} | Create Term Calendar Year |
TermCalendarYearApi | deleteTermCalendarYear | DELETE /employers/{employerId}/termcalendaryears/{termCalendarId}/{id} | Delete Term Calendar Year |
TermCalendarYearApi | getTermCalendarYear | GET /employers/{employerId}/termcalendaryears/{termCalendarId}/{id} | Get Term Calendar Year |
TermCalendarYearApi | indexTermCalendarYear | GET /employers/{employerId}/termcalendaryears/{termCalendarId} | List Term Calendar Years |
TermCalendarYearApi | updateTermCalendarYear | PUT /employers/{employerId}/termcalendaryears/{termCalendarId}/{id} | Update Term Calendar Year |
TierablePayApi | getTierablePay | GET /employers/{employerId}/tierablepay/{payrunEntryId} | Calculate tierable pay |
ToolsApi | calculateNetOfOnCostsTools | GET /tools/calculate-net-of-on-costs | Calculate Net of On Costs |
WebhookApi | createWebhook | POST /employers/{employerId}/webhooks | Create Webhook |
WebhookApi | deleteWebhook | DELETE /employers/{employerId}/webhooks/{id} | Delete Webhook |
WebhookApi | getWebhook | GET /employers/{employerId}/webhooks/{id} | Get Webhook |
WebhookApi | indexWebhook | GET /employers/{employerId}/webhooks | List Webhooks |
WebhookApi | payloadWebhook | GET /employers/{employerId}/webhooks/{id}/payloads/{payloadId} | Get WebhookPayload |
WebhookApi | payloadsWebhook | GET /employers/{employerId}/webhooks/{id}/payloads | List WebhookPayloads |
WebhookApi | sampleWebhook | GET /employers/{employerId}/webhooks/samples/{webhookEvent} | Sample Value |
WebhookApi | updateWebhook | PUT /employers/{employerId}/webhooks/{id} | Update Webhook |
WorkingPatternApi | createWorkingPattern | POST /employers/{employerId}/workingpatterns | Create WorkingPattern |
WorkingPatternApi | deleteWorkingPattern | DELETE /employers/{employerId}/workingpatterns/{id} | Delete WorkingPattern |
WorkingPatternApi | getAsyncWorkingPattern | GET /employers/{employerId}/workingpatterns/{id} | Get WorkingPattern |
WorkingPatternApi | indexAsyncWorkingPattern | GET /employers/{employerId}/workingpatterns | List WorkingPatterns |
WorkingPatternApi | updateWorkingPattern | PUT /employers/{employerId}/workingpatterns/{id} | Update WorkingPattern |
- Address
- AdvancedVarianceReport
- AdvancedVarianceReportLine
- AdvancedVarianceReportReportResponse
- AeAction
- AeAssessment
- AeAssessmentAction
- AeEmployeeState
- AeExclusionCode
- AeStatus
- AeStatutoryLetter
- AeUKWorker
- AllowanceType
- AnalysisCategory
- AnalysisCategoryCode
- AnalysisCategoryCodes
- AnalysisCategoryIndex
- AnalysisReport
- AnalysisReportLine
- AnalysisReportLineValue
- AnalysisReportReportResponse
- AnnualRoundingRule
- AssumedPensionablePay
- AttachmentOrder
- AttachmentOrderPayment
- AttachmentOrderReportResponse
- AttachmentOrderType
- AttachmentOrdersReport
- AttachmentOrdersReportReportResponse
- AuditEventAction
- AuthScheme
- AutoEnrolment
- AutoEnrolmentSettings
- AutoPilotFinaliseTime
- AutomationSettings
- AverageHolidayPayRateReport
- AverageHolidayPayRateReportLine
- AverageHolidayPayRateReportReportResponse
- AveragePayGradesReportLine
- AverageWeeklyEarnings
- AverageWeeklyEarningsResult
- BackgroundTaskStatus
- BankDetails
- BankHolidayCollection
- BankPaymentInstruction
- BankPaymentInstructionReportResponse
- BankPaymentInstructionsCsvFormat
- Benefit
- BenefitDeclarationType
- BenefitDetailsAssetType
- BenefitDetailsCar
- BenefitDetailsCarPowerType
- BenefitDetailsClass1AType
- BenefitDetailsLoan
- BenefitDetailsNonClass1AType
- BenefitDetailsPaymentType
- BenefitDetailsUseOfAssetType
- BenefitPayrolled
- BenefitType
- BureauSettings
- CISSubContractorType
- CISTaxStatus
- CalendarEntry
- CalendarEntryType
- CalendarMonth
- CarCharge
- CarChargeRate
- ChangeSummary
- ChangeSummaryListReportResponse
- Cis300
- Cis300Declarations
- Cis300ReportResponse
- CisContractor
- CisDetails
- CisPartnership
- CisRequest
- CisReturn
- CisStatement
- CisStatementListReportResponse
- CisSubContractor
- CisSubContractorSummary
- CisSubContractorSummaryListReportResponse
- CisVerification
- CisVerificationDetails
- ContractAddress
- ContractAeAssessmentAction
- ContractAeAssessmentRequest
- ContractAeAssessmentResponse
- ContractAllowanceGradesRequest
- ContractAllowanceGradesResponse
- ContractAllowanceGradesUpdateRequest
- ContractAnalysisCategoryCodeRequest
- ContractAnalysisCategoryCodeResponse
- ContractAnalysisCategoryRequest
- ContractAnalysisCategoryResponse
- ContractAutoEnrolmentRequest
- ContractAutoEnrolmentResponse
- ContractBankDetails
- ContractCisDetailsRequest
- ContractCisDetailsResponse
- ContractCisPartnership
- ContractCisSubContractor
- ContractCisSubContractorItem
- ContractCisVerificationDetailsRequest
- ContractCisVerificationDetailsResponse
- ContractCostCentreJournalOverridesRequest
- ContractCostCentreJournalOverridesResponse
- ContractCostCentreJournalOverridesResponseItem
- ContractCostCentreJournalOverridesUpdateRequest
- ContractCreateEmployeeRequest
- ContractDepartmentJournalOverridesRequest
- ContractDepartmentJournalOverridesResponse
- ContractDepartmentJournalOverridesResponseItem
- ContractDepartmentJournalOverridesUpdateRequest
- ContractDepartmentRequest
- ContractDepartmentResponse
- ContractDirectorshipDetails
- ContractEmployeeItem
- ContractEmployeeResponse
- ContractEmployeeRoleAnalysisCategoryCodeRequest
- ContractEmployeeRoleAnalysisCategoryCodeResponse
- ContractEmployeeRoleItem
- ContractEmployeeRoleResponse
- ContractEmployeeRoleWorkingPatternRequest
- ContractEmployeeRoleWorkingPatternResponse
- ContractEmployeeRoleWorkingPatternResponseItem
- ContractEmployerBase
- ContractEmploymentDetailsRequest
- ContractEmploymentDetailsResponse
- ContractFpsFields
- ContractGrossToNetReportRequest
- ContractHolidayEntitlementRequest
- ContractHolidayEntitlementResponse
- ContractHolidayEntitlementUpdateRequest
- ContractHolidaySchemeRequest
- ContractHolidaySchemeResponse
- ContractJobErrorResponse
- ContractJobResponse
- ContractJobResultFileResponse
- ContractJobResultResponse
- ContractJournalTemplateRequest
- ContractJournalTemplateResponse
- ContractJournalTokenRequest
- ContractJournalTokenResponse
- ContractJournalTokenResponseItem
- ContractLeaveImportRequest
- ContractLeaveSettingsRequest
- ContractLeaveSettingsResponse
- ContractLeaverDetails
- ContractLondonAllowanceRequest
- ContractLondonAllowanceResponse
- ContractNetOfOnCostsResponse
- ContractNetOfOnCostsSimulationResponse
- ContractOverseasEmployerDetails
- ContractP11HistoryRequest
- ContractP11HistoryResponse
- ContractPartnerDetails
- ContractPayHistoryRequest
- ContractPayHistoryResponse
- ContractPayHistoryUpdateRequest
- ContractPayLineRequest
- ContractPayLineResponse
- ContractPayOptionsBaseResponse
- ContractPayOptionsImportRequest
- ContractPayOptionsRequest
- ContractPayOptionsResponse
- ContractPayRunStateHistoryResponse
- ContractPaySpineGradeRequest
- ContractPaySpineGradeResponse
- ContractPaySpineRequest
- ContractPaySpineResponse
- ContractPaySpineUpdateRequest
- ContractPaylineAnalysisCategoriesCodes
- ContractPaylineRequest
- ContractPayrollSquadEmployerRequest
- ContractPayrollSquadEmployerResponse
- ContractPayrollSquadMemberRequest
- ContractPayrollSquadMemberResponse
- ContractPayrollSquadRequest
- ContractPayrollSquadResponse
- ContractPendingLettersCountResponse
- ContractPensionerPayroll
- ContractPersonalDetailsRequest
- ContractPersonalDetailsResponse
- ContractReapplyDpsNoticeResponse
- ContractRightToWork
- ContractRtiEmployeeAddress
- ContractRtiEmployeeName
- ContractShiftWorkingPatternDayRequest
- ContractShiftWorkingPatternDayResponse
- ContractSpinalPointRequest
- ContractSpinalPointResponse
- ContractSpinalPointUpdateRequest
- ContractSpineAllowanceRequest
- ContractSpineAllowanceResponse
- ContractSpineAllowanceUpdateRequest
- ContractStarterDetails
- ContractTaxAndNi
- ContractTermCalendarRequest
- ContractTermCalendarResponse
- ContractTermCalendarYearRequest
- ContractTermCalendarYearResponse
- ContractUpdateEmployeeRequest
- ContractVeteranDetails
- ContractWorkingPatternRequest
- ContractWorkingPatternResponse
- ContractYearsServiceEntitlementRequest
- ContractYearsServiceEntitlementResponse
- ContractYearsServiceEntitlementUpdateRequest
- CostAnalysisReport
- CostAnalysisReportReportResponse
- CostCentre
- CostOfEmploymentReport
- CostOfEmploymentReportLine
- CostOfEmploymentReportReportResponse
- Country
- CsvFileFormat
- DayOfWeek
- DecimalTaxYearConfigPrimitiveValue
- DeferalPeriodType
- Department
- DepartmentMembership
- DirectDebitMandate
- DirectorshipDetails
- DpsDataType
- DpsNotice
- DpsSettings
- EmailAttachment
- EmpRefs
- Employee
- EmployeeBenefitsReport
- EmployeeBenefitsReportReportResponse
- EmployeeCostCentre
- EmployeeLeaveReport
- EmployeeLeaveReportLine
- EmployeeLeaveReportReportResponse
- EmployeeNiYtdValues
- EmployeePayRunTotal
- EmployeeRole
- EmployeeRoleAnalysisCategoryCode
- EmployeeRolePayItem
- EmployeeRolePayOptions
- EmployeeSortBy
- EmployeeStatus
- EmployeeYtdValues
- Employer
- EmployerDefaults
- EmployerEmail
- EmployerEvcOptInHistory
- EmployerGroup
- EmployerGroupMembership
- EmployerItem
- EmployerOpeningBalances
- EmployerPensionContribution
- EmployerSettings
- EmployerTemplate
- EmployerTemplateType
- EmploymentDetails
- EntitlementBand
- EntityType
- Eps
- EpsAccount
- EpsApprenticeshipLevy
- EpsDeMinimisStateAid
- EpsFinalSubmission
- Establishment
- EvcSettings
- Exb
- ExbDeclarations
- ExbEmployer
- ExbP11d
- ExbP11dEmployee
- ExbP11db
- ExbP11dbClass1A
- ExbP11dbClass1AAdjustment
- ExbP11dbClass1AAdjustments
- ExbP11dbClass1ATotalBenefit
- ExbReportResponse
- ExpensesAndBenefits
- ExternalDataCompany
- ExternalDataProvider
- ExternalDataProviderId
- ExternalDataProviderType
- ExternalEmployeeMapping
- ExternalEmployeeMappingStatus
- ExternalProviderConversation
- FieldModification
- FixedCode
- FlexibleDrawdown
- Fps
- FpsBenefit
- FpsCar
- FpsCarFuel
- FpsEmployee
- FpsEmployeeDetails
- FpsEmployeeDetailsPartnerDetails
- FpsEmployeeFigsToDate
- FpsEmployeeFlexibleDrawdown
- FpsEmployeeNIlettersAndValues
- FpsEmployeePayment
- FpsEmployeeSeconded
- FpsEmployeeStarter
- FpsEmployeeStarterOccPension
- FpsEmployeeTaxCode
- FpsEmployeeTrivialCommutationPayment
- FpsEmployerPayIdChanged
- FpsEmployment
- FpsFields
- FpsLateReason
- FpsPriorVersion
- FpsReportResponse
- FromToDates
- FullPaymentSubmission
- FullSummaryOfPayReport
- FullSummaryOfPayReportLine
- FullSummaryOfPayReportReportResponse
- FurloughCalculationBasis
- FurloughReport
- FurloughReportLine
- FurloughReportReportResponse
- Gender
- GenderPayGapLine
- GenderPayGapReport
- GenderPayGapReportReportResponse
- GenderPayGapSnapShotDate
- GovTalk
- GovTalkError
- GovTalkSubmission
- GrossToNetReport
- GrossToNetReportCisLine
- GrossToNetReportLine
- GrossToNetReportReportResponse
- HmrcDetails
- HmrcLiability
- HmrcPayment
- HolidayAccrual
- HolidayAccrualDefaultRateType
- HolidayReport
- HolidayReportLine
- HolidayReportReportResponse
- HolidaySchemeDurationType
- HolidayType
- HourlyPayReport
- HourlyPayReportLine
- HourlyPayReportReportResponse
- HoursNormallyWorked
- HtmlEmailSettings
- HtmlInsertionPoint
- IncrementRule
- Invitation
- Item
- ItemListReportResponse
- JobStatus
- JobType
- JournalCsvFormat
- JournalTemplate
- JournalTokenType
- Leave
- LeaveAssumedPensionablePay
- LeaveCalculationType
- LeaveCustomPayment
- LeaveCustomProRataRule
- LeavePayType
- LeaveProRataRule
- LeaveSettings
- LeaveType
- LeaverDetails
- LgpsCivicaCasualHours
- LgpsCivicaPayrollNumber
- LgpsFund
- LgpsIConnectFileType
- LgpsIConnectPayrollReference
- LgpsIConnectSalaryType
- LgpsPayCategory
- LinkedPiw
- LinkedPiwResult
- Loan
- LoanBalancesReport
- LoanBalancesReportLine
- LoanBalancesReportReportResponse
- LoanCharge
- LogEntry
- LondonAllowance
- LondonAllowanceType
- LondonAllowanceValueType
- MailSettings
- MaritalStatus
- McrPayCategory
- MileageAllowancePaymentsRate
- MileageVehicleType
- MonthlyMinimum
- NationalInsuranceCalculation
- NationalInsuranceCalculationBase
- NationalInsuranceCalculationPeriodValues
- NationalInsuranceCode
- NationalMinimumWage
- NiLetterError
- NiLetterValidationReport
- NiLetterValidationReportLine
- NiLetterValidationReportReportResponse
- NiYtdReport
- NiYtdReportReportResponse
- NiYtdValue
- NicSummary
- NominalCodeMapping
- Note
- NoteType
- Nvr
- NvrEmployee
- NvrEmployeeDetails
- NvrEmployment
- NvrRequest
- OccupationalPolicy
- OccupationalPolicyEntitlement
- OccupationalPolicyEntitlementRecalculationBasis
- OccupationalPolicyPayCalculatedOn
- OccupationalPolicySicknessYear
- OccupationalPolicyType
- OccupationalSickLeaveHistory
- OpeningBalances
- OpeningBalancesTotals
- OverseasEmployerDetails
- OverseasSecondmentStatus
- P11
- P11DAssetAvailable
- P11DAssetAvailableCollection
- P11DAssetTransferredCollection
- P11DCar
- P11DCarCollection
- P11DDescOther
- P11DLoan
- P11DLoanCollection
- P11DOther
- P11DPaymentCollection
- P11DSingleItem
- P11Detailed
- P11DetailedNiValues
- P11DetailedReportResponse
- P11Line
- P11NiAndStatPaymentsLine
- P11NiAndStatPaymentsTotalsLine
- P11NiValues
- P11PayeLine
- P11PayeSummary
- P11PayeTotalsLine
- P11ReportResponse
- P11dCarFreeFuelWithdrawn
- P11dExpenses
- P11dVans
- P32
- P32ReportResponse
- PapdisDocument
- PapdisDocumentReportResponse
- PapdisEmployee
- PapdisEmployeeAssessment
- PapdisEmployeeContact
- PapdisEmployeeContactPostalAddress
- PapdisEmployeeContribution
- PapdisEmployeeExit
- PapdisEmployeeIdentity
- PapdisEmployeeName
- PapdisEmployeePay
- PapdisEmployer
- PapdisEmployerContactPostalAddress
- PapdisMessageFunctionCode
- PapdisPayrollPeriod
- PapdisPensionProvider
- PapdisVersion
- PartnerDetails
- PayBasis
- PayCode
- PayCodeCalculationType
- PayCodeMultiplierType
- PayCodeSet
- PayCodeVarianceLine
- PayElementReport
- PayElementReportLine
- PayElementReportReportResponse
- PayGradesReport
- PayGradesReportReportResponse
- PayLine
- PayMethod
- PayOptions
- PayOptionsImport
- PayPeriodEventType
- PayPeriodTypes
- PayPeriods
- PayRun
- PayRunChanges
- PayRunCsvType
- PayRunEntry
- PayRunEntrySortBy
- PayRunEntryWarningType
- PayRunJournal
- PayRunPayment
- PayRunState
- PayRunStateChange
- PayRunStateChangeReason
- PayRunSummaryLine
- PayRunSummaryLineIEnumerableReportResponse
- PayRunTotals
- PaySchedule
- PaySchedulePeriod
- PaySchedulePeriodEvent
- PaySchedulePeriodEventsConfig
- PaySpineReport
- PaySpineReportLine
- PaySpineReportReportResponse
- PaySpineYearsServiceEntitlementBasis
- Payee
- PayeeType
- PaylineCalculationData
- PaymentDateRule
- PaymentDateType
- PaymentMethodAfterLeaving
- PaymentsCsvMapping
- PaymentsCsvMappingColumn
- PaymentsCsvMappingType
- PayrollAnalysisCostBreakdownReport
- PayrollAnalysisCostBreakdownReportLine
- PayrollAnalysisCostBreakdownReportReportResponse
- PayrollAnalysisCostBreakdownReportValue
- PayrollAnalysisEmployeeRoleBreakdownReport
- PayrollAnalysisEmployeeRoleBreakdownReportLine
- PayrollAnalysisEmployeeRoleBreakdownReportLineValue
- PayrollAnalysisEmployeeRoleBreakdownReportReportResponse
- PayrollValueType
- PayrunEmail
- PayrunPaymentsReport
- PayrunPaymentsReportReportResponse
- Payslip
- PayslipCustomisation
- PayslipLine
- PayslipLineType
- PayslipReleaseType
- PayslipReportResponse
- PdfPaperMargins
- PdfPaperOrientation
- PdfPaperSize
- PdfPasswordType
- Pension
- PensionAdministrator
- PensionContributionLevelType
- PensionContributionsSubmission
- PensionCsvFormat
- PensionEndReason
- PensionJoinReason
- PensionMembershipReportLine
- PensionMembershipsReport
- PensionMembershipsReportReportResponse
- PensionOpeningBalances
- PensionPayCode
- PensionProvider
- PensionRefund
- PensionReportingType
- PensionRule
- PensionScheme
- PensionSchemeNominalCodeMapping
- PensionSchemeReportOptionsLgpsCivicaUpm
- PensionSchemeReportOptionsLgpsIConnect
- PensionSelection
- PensionSummary
- PensionSummaryCostBreakdown
- PensionablePayDefinition
- PensionerPayroll
- PeriodValue
- PeriodValuePeriodValues
- PersonalDetails
- PricingBand
- PricingTable
- ProRataRule
- ProcessingNote
- ProcessingNoteStatus
- RecoverableAmounts
- Report
- ReportCustomCssOption
- ReportFormat
- ReportPack
- ReportResponse
- ReportSortBy
- ReportTemplate
- RightToWork
- RightToWorkDocumentType
- RightToWorkReport
- RightToWorkReportLine
- RightToWorkReportReportResponse
- RoleBasis
- RoleType
- RtiAgent
- RtiContact
- RtiEmployeeAddress
- RtiEmployeeName
- RtiSenderType
- RtiSubmissionSettings
- RtiValidationWarning
- RtiValidationWarningType
- ServiceBand
- ShiftWorkingPatternDay
- SmtpEncryption
- SmtpSettings
- SpinePointReport
- SpinePointReportLine
- SpinePointReportReportResponse
- StarterDeclaration
- StarterDetails
- StartersLeaversFilter
- StatPayFrequency
- StatutoryPay
- StatutoryPayReport
- StatutoryPayReportLine
- StatutoryPayReportReportResponse
- StringDecimalKeyValuePair
- StringStringKeyValuePair
- StudentLoan
- StudentLoanRecovered
- SubmissionStatus
- Tag
- TaxAndNi
- TaxBracket
- TaxCodeChange
- TaxCodeChangeReport
- TaxCodeChangeReportReportResponse
- TaxCodeChangeValues
- TaxYear
- TaxYearConfig
- TaxYearTypes
- TeachersPensionAgeWarning
- TeachersPensionDetails
- TeachersPensionEmploymentType
- TeachersPensionEoyLineItem
- TeachersPensionEoyReport
- TeachersPensionEoyReportReportResponse
- Tenant
- TenantBillingSettings
- TenantEmail
- TenantHtmlInsertion
- TenantItem
- TieredPension
- TieredPensionRate
- UmbrellaPayment
- UmbrellaReconciliationReport
- UmbrellaReconciliationReportLine
- UmbrellaReconciliationReportReportResponse
- UmbrellaSettings
- UsageBill
- User
- UserAuthorization
- UserCategory
- UserDisplayPreferences
- UserIndustry
- UserJobType
- UserRole
- UserstartPage
- UtmInfo
- ValueOverride
- VarianceReport
- VarianceReportReportResponse
- VeteranDetails
- WarningsReport
- WarningsReportLine
- WarningsReportReportResponse
- Webhook
- WebhookEvent
- WebhookPayload
- WorkerGroup
- WorkingPattern
- WorkingPatternHoursType
- WorkingPatternType
- YearEnd
- YearEndTaxCodeChange
- YtdReport
- YtdReportReportResponse
- YtdValue
- ZeroPaidFilter
- Type: HTTP basic authentication
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
v1
- Package version:
1.0.0
- Generator version:
7.11.0-SNAPSHOT
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen