Paternities

Gets a single Paternity referenced by ID.

Changed on
get/attendance/paternities/{id}

Request

Path parameters

idstring required

Paternity ID.

Response

OK

FormReceivedDatestring date-time nullable

The date that certificate (form MAT B1) was received by the employer.

Cascade Source: [EmployeeMaternity].[MAT1BReceived]

ExpectedDateOfBirthstring date-time nullable

The expected date of birth of the child.

Cascade Source: [EmployeeMaternity].[ExpectedDate]

ExpectedWeekOfChildBirthStartDatestring date-time nullable

The date of the Sunday before the date of birth of the child.

ExpectedWeekOfChildBirthEndDatestring date-time nullable

The date of the Saturday after the date of birth of the child.

ChildDateOfBirthstring date-time nullable

The actual date of birth of the child.

Cascade Source: [EmployeeMaternity].[BabyDOB]

ChildNamestring nullable

The name of the child.

Cascade Source: [EmployeeMaternity].[BabyName]

NotificationReceivedDatestring date-time nullable

The date that the Employer was notified.

Cascade Source: [EmployeeMaternity].[NotificationReceived]

NotifyEmployerByDatestring date-time nullable

Cascade Source: [EmployeeMaternity].[NoticeDate]

LeaveStartDatestring date-time nullable

The start date of the Employee's leave.

Cascade Source: [EmployeeMaternity].[StartDate]

LeaveEndDatestring date-time nullable

The end date of the Employee's leave. Cascade Source: [EmployeeMaternity].[EndDate]

Narrativestring nullable

Cascade Source: [EmployeeMaternity].[Notes]

EmployeeIdstring nullable

The Id of the Employee.

Must exist in the Employee service.

AbsenceIdstring nullable

The Id of the Attendance Absence record.

Must exist in the Absence service.

CountryOfStatutoryPaternityPayEntitlementstring nullable

The country in which the Employee is entitled to statutory paternity pay.

Cascade Source: [EmployeeMaternity].[SPPCountry] translated through the SPPCountry system list.

ConsecutiveWeeksOnlyboolean

The Week 1 and Week 2 start dates are consecutive.

Week1StartDatestring date-time nullable

The start of the first week of the Paternity leave. Cascade Source: [EmployeeMaternity].[WeekOneStartDate]

Week1EndDatestring date-time nullable

The end of the first week of the Paternity leave.

Week2StartDatestring date-time nullable

The start of the second week of the Paternity leave. Cascade Source: [EmployeeMaternity].[WeekTwoStartDate]

Week2EndDatestring date-time nullable

The end of the second week of the Paternity leave.

SourceSystemIdstring nullable

Source HR System Id.

Cascade Source: [EmployeeMaternity].[RUID]

SourceSystemCreatedOnstring date-time nullable

The date when the Paternity was created in the Source HR System.

Cascade Source: [EmployeeMaternity].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The date when the Paternity was created or last updated in the Source HR System.

Cascade Source: [EmployeeMaternity].[SYS_ModifiedDate]

Idstring nullable

This ID is generated by the Iris HR platform and does not relate to the Cascade ID.

CreatedOnstring date-time

The date when the Paternity was created in the Iris HR platform.

CreatedBystring nullable

Not used as the Iris HR platform has no concept of users.

LastModifiedOnstring date-time nullable

The date when the Paternity was created or last updated.

LastModifiedBystring nullable

Not used as the Iris HR platform has no concept of users.

Changes