{
"accruedLeave": [
{
"amount": "double",
"leaveCategory": "string",
"notes": "string"
}
],
"bankPayments": [
{
"accountName": "string",
"accountNumber": "string",
"amount": "double",
"lodgementReference": "string",
"sortCode": "string"
}
],
"basePayRate": "string",
"baseRate": "string",
"businessAddress": "string",
"businessName": "string",
"contactName": "string",
"crn": "string",
"deductions": [
{
"amount": "double",
"name": "string",
"notes": "string",
"taxStatus": "string"
}
],
"earningsLines": [
{
"grossEarnings": "double",
"isFixed": "boolean",
"isTaxExempt": "boolean",
"locationName": "string",
"notes": "string",
"payCategoryName": "string",
"rate": "double",
"taxableEarnings": "double",
"units": "double"
}
],
"employeeBaseRate": "double",
"employeeBaseRateUnit": "string",
"employeeExpenses": [
{
"amount": "double",
"employeeExpenseCategoryName": "string",
"locationName": "string",
"notes": "string"
}
],
"employeeExternalId": "string",
"employeeFirstName": "string",
"employeeId": "int32",
"employeeName": "string",
"employeeNationalInsuranceContribution": "double",
"employeeNationalInsuranceYTD": "double",
"employeePensionContribution": "double",
"employeePensionYTD": "double",
"employeePostalAddressCity": "string",
"employeePostalAddressCountry": "string",
"employeePostalAddressCounty": "string",
"employeePostalAddressLine2": "string",
"employeePostalAddressPostcode": "string",
"employeePostalStreetAddress": "string",
"employeeSurname": "string",
"employerClass1ANationalInsuranceContribution": "double",
"employerClass1ANationalInsuranceContributionYTD": "double",
"employerNationalInsuranceContribution": "double",
"employerNationalInsuranceContributionIncludingClass1A": "double",
"employerNationalInsuranceContributionIncludingClass1AYTD": "double",
"employerNationalInsuranceYTD": "double",
"employerPensionContribution": "double",
"employerPensionYTD": "double",
"grossEarnings": "double",
"grossYTD": "double",
"grossYTDDetails": [
{
"grossEarnings": "double",
"payCategoryName": "string"
}
],
"hourlyRate": "double",
"id": "int32",
"isPublished": "boolean",
"leaveTaken": [
{
"amount": "double",
"leaveCategory": "string",
"notes": "string"
}
],
"message": "string",
"netEarnings": "double",
"netYTD": "double",
"notation": "string",
"payPeriodEnding": "string",
"payPeriodStarting": "string",
"payeAdjustments": [
{
"amount": "double",
"notes": "string"
}
],
"payeWithholdingAmount": "double",
"payeYTD": "double",
"postGradLoanComponentAmount": "double",
"postGradLoanYTD": "double",
"postTaxDeductionAmount": "double",
"postTaxDeductionsYTD": "double",
"preTaxDeductionAmount": "double",
"preTaxDeductionsYTD": "double",
"studentLoanComponentAmount": "double",
"studentLoanYTD": "double",
"taxCode": "string",
"taxableEarnings": "double",
"thisEmploymentYtdNIablePay": "double",
"thisEmploymentYtdPay": "double",
"thisEmploymentYtdPayrolledBenefits": "double",
"thisEmploymentYtdTaxDeducted": "double",
"totalAccruedLeave": [
{
"amount": "double",
"leaveCategory": "string",
"notes": "string"
}
],
"totalHours": "double",
"withholdingYTD": "double"
}
| Name | Type | Description |
|---|---|---|
| accruedLeave[] | array | |
| accruedLeave[].amount | double | Decimal |
| accruedLeave[].leaveCategory | string | String |
| accruedLeave[].notes | string | String |
| bankPayments[] | array | |
| bankPayments[].accountName | string | String |
| bankPayments[].accountNumber | string | String |
| bankPayments[].amount | double | Decimal |
| bankPayments[].lodgementReference | string | String |
| bankPayments[].sortCode | string | String |
| basePayRate | string | String |
| baseRate | string | String |
| businessAddress | string | String |
| businessName | string | String |
| contactName | string | String |
| crn | string | String |
| deductions[] | array | |
| deductions[].amount | double | Decimal |
| deductions[].name | string | String |
| deductions[].notes | string | String |
| deductions[].taxStatus | string | String |
| earningsLines[] | array | |
| earningsLines[].grossEarnings | double | Decimal |
| earningsLines[].isFixed | boolean | Boolean |
| earningsLines[].isTaxExempt | boolean | Boolean |
| earningsLines[].locationName | string | String |
| earningsLines[].notes | string | String |
| earningsLines[].payCategoryName | string | String |
| earningsLines[].rate | double | Decimal |
| earningsLines[].taxableEarnings | double | Decimal |
| earningsLines[].units | double | Decimal |
| employeeBaseRate | double | Decimal |
| employeeBaseRateUnit | string |
RateUnitEnum
Possible values are:
|
| employeeExpenses[] | array | |
| employeeExpenses[].amount | double | Decimal |
| employeeExpenses[].employeeExpenseCategoryName | string | String |
| employeeExpenses[].locationName | string | String |
| employeeExpenses[].notes | string | String |
| employeeExternalId | string | String |
| employeeFirstName | string | String |
| employeeId | int32 | Int32 |
| employeeName | string | String |
| employeeNationalInsuranceContribution | double | Decimal |
| employeeNationalInsuranceYTD | double | Decimal |
| employeePensionContribution | double | Decimal |
| employeePensionYTD | double | Decimal |
| employeePostalAddressCity | string | String |
| employeePostalAddressCountry | string | String |
| employeePostalAddressCounty | string | String |
| employeePostalAddressLine2 | string | String |
| employeePostalAddressPostcode | string | String |
| employeePostalStreetAddress | string | String |
| employeeSurname | string | String |
| employerClass1ANationalInsuranceContribution | double | Decimal |
| employerClass1ANationalInsuranceContributionYTD | double | Decimal |
| employerNationalInsuranceContribution | double | Decimal |
| employerNationalInsuranceContributionIncludingClass1A | double | Decimal |
| employerNationalInsuranceContributionIncludingClass1AYTD | double | Decimal |
| employerNationalInsuranceYTD | double | Decimal |
| employerPensionContribution | double | Decimal |
| employerPensionYTD | double | Decimal |
| grossEarnings | double | Decimal |
| grossYTD | double | Decimal |
| grossYTDDetails[] | array | |
| grossYTDDetails[].grossEarnings | double | Decimal |
| grossYTDDetails[].payCategoryName | string | String |
| hourlyRate | double | Decimal |
| id | int32 | Int32 |
| isPublished | boolean | Boolean |
| leaveTaken[] | array | |
| leaveTaken[].amount | double | Decimal |
| leaveTaken[].leaveCategory | string | String |
| leaveTaken[].notes | string | String |
| message | string | String |
| netEarnings | double | Decimal |
| netYTD | double | Decimal |
| notation | string | String |
| payPeriodEnding | string | String |
| payPeriodStarting | string | String |
| payeAdjustments[] | array | |
| payeAdjustments[].amount | double | Decimal |
| payeAdjustments[].notes | string | String |
| payeWithholdingAmount | double | Decimal |
| payeYTD | double | Decimal |
| postGradLoanComponentAmount | double | Decimal |
| postGradLoanYTD | double | Decimal |
| postTaxDeductionAmount | double | Decimal |
| postTaxDeductionsYTD | double | Decimal |
| preTaxDeductionAmount | double | Decimal |
| preTaxDeductionsYTD | double | Decimal |
| studentLoanComponentAmount | double | Decimal |
| studentLoanYTD | double | Decimal |
| taxCode | string | String |
| taxableEarnings | double | Decimal |
| thisEmploymentYtdNIablePay | double | Decimal |
| thisEmploymentYtdPay | double | Decimal |
| thisEmploymentYtdPayrolledBenefits | double | Decimal |
| thisEmploymentYtdTaxDeducted | double | Decimal |
| totalAccruedLeave[] | array | |
| totalAccruedLeave[].amount | double | Decimal |
| totalAccruedLeave[].leaveCategory | string | String |
| totalAccruedLeave[].notes | string | String |
| totalHours | double |
Nullable |
| withholdingYTD | double | Decimal |