> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt > Use this file to discover all available pages before exploring further. # Remove an employee's whole working-pattern history > Removes every working-pattern version the employee has, in one write, returning them to the payroll-config default, then the organisation default, then Monday to Friday. This is what returning somebody to an inherited pattern means: removing versions one at a time only reveals the version before it. Succeeds when there is nothing to remove, because the end state is the one asked for. ## OpenAPI ````yaml /api-reference/specs/pay-api.yaml delete /employees/{employeeId}/working-pattern openapi: 3.0.3 info: title: FlowPayroll API description: >- API for payroll management, including payroll upload, lock, HMRC submission, employee management version: 0.1.0 servers: - url: https://api.sandbox.flowpayroll.ai/v1 security: - XAuthToken: [] XOrgId: [] tags: - name: Employees description: >- Create, retrieve, update, and delete employee records, and look them up by NI number or payroll ID. - name: Starters & leavers description: Set and clear starter and leaver details, individually or in bulk. - name: Tax codes description: >- Manage employee tax codes and query the effective tax code and NI category on a given date. - name: NI & identifiers description: Manage NI categories, National Insurance numbers, and payroll IDs. - name: Student loans description: Start and end student and postgraduate loans. - name: Payroll setup description: Assign an employee's payroll config and set opening balances. - name: Salary description: >- The employee's effective-dated annual salary history: read it, add or correct a version from a date, and remove one. The Salary API pro-rates this history onto each pay run. - name: Payroll - name: Payroll lines - name: PayrollConfig - name: Pay Elements - name: Calculator - name: Payslip - name: RTI - name: YearEnd - name: Organisation paths: /employees/{employeeId}/working-pattern: delete: tags: - Working patterns summary: Remove an employee's whole working-pattern history description: >- Removes every working-pattern version the employee has, in one write, returning them to the payroll-config default, then the organisation default, then Monday to Friday. This is what returning somebody to an inherited pattern means: removing versions one at a time only reveals the version before it. Succeeds when there is nothing to remove, because the end state is the one asked for. operationId: DeleteAllWorkingPatterns parameters: - name: employeeId in: path required: true schema: type: string description: The ID of the employee responses: '200': description: Working-pattern history removed content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/ResponseBody' - properties: content: type: object properties: data: $ref: >- #/components/schemas/EmployeeWorkingPatternHistoryResponseDto '404': description: Employee not found content: application/json: schema: $ref: '#/components/schemas/ResponseBody' '500': description: An internal server error occurred content: application/json: schema: $ref: '#/components/schemas/ResponseBody' components: schemas: ResponseBody: type: object properties: message: $ref: '#/components/schemas/MessageWithTokenResponse' content: type: object properties: data: type: object nullable: true metadata: type: object nullable: true properties: dateFormat: type: string default: yyyy-MM-dd dateTimeFormat: type: string default: yyyy-MM-ddTHH:mm:ss.fffZ paginationToken: type: string nullable: true validationIssues: type: array items: $ref: '#/components/schemas/ValidationIssue' EmployeeWorkingPatternHistoryResponseDto: type: object description: The full effective-dated history of an employee's working pattern. properties: versions: type: array items: $ref: '#/components/schemas/EmployeeWorkingPatternVersionDto' MessageWithTokenResponse: type: object properties: text: type: string token: type: string tokenArguments: type: array items: $ref: '#/components/schemas/ValidationIssueArgument' ValidationIssue: type: object description: > Field validation item. `reasonToken` is a stable snake_case key for i18n or custom client messages; `reason` is the default English text from the API. properties: field: type: string description: Dot-path of the field (e.g. name.firstName, address.line1). reason: type: string description: Default human-readable message. reasonToken: type: string description: Machine-readable error identifier (snake_case). reasonTokenArguments: type: array nullable: true items: $ref: '#/components/schemas/ValidationIssueArgument' EmployeeWorkingPatternVersionDto: type: object description: An effective-dated working-pattern version with audit metadata. properties: effectiveFrom: type: string example: '2026-04-06' configuration: $ref: '#/components/schemas/WorkingDaysConfigurationDto' createdDate: type: string createdBy: type: string updatedDate: type: string updatedBy: type: string ValidationIssueArgument: type: object properties: name: type: string value: type: string WorkingDaysConfigurationDto: type: object description: Configuration of employee's working days properties: standardWorkingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' description: Standard working days configuration example: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false shiftPattern: $ref: '#/components/schemas/ShiftPatternDto' description: Shift pattern configuration (if applicable) example: rotationStartDate: '2024-01-01' shifts: - name: Morning Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 - name: Night Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 patternType: FourOnFourOff workingPattern: type: string description: Type of working pattern enum: - Standard - Shift - Explicit default: Standard example: Standard explicitSchedule: $ref: '#/components/schemas/ExplicitScheduleDto' description: >- Explicit week-by-week schedule, used when workingPattern is "Explicit" StandardWorkingDaysDto: type: object description: Standard working days configuration properties: monday: type: boolean description: Whether Monday is a working day example: true tuesday: type: boolean description: Whether Tuesday is a working day example: true wednesday: type: boolean description: Whether Wednesday is a working day example: true thursday: type: boolean description: Whether Thursday is a working day example: true friday: type: boolean description: Whether Friday is a working day example: true saturday: type: boolean description: Whether Saturday is a working day example: false sunday: type: boolean description: Whether Sunday is a working day example: false ShiftPatternDto: type: object description: >- A repeating shift rotation. "Custom" spells the rotation out as an ordered list of shifts: starting on rotationStartDate, each shift runs for its durationInDays and the list then repeats from the top, so the cycle length is the sum of the durations. Every other patternType is a named rotation whose shape is built in, and ignores shifts. required: - rotationStartDate - shifts properties: rotationStartDate: type: string format: date description: The date when the shift pattern rotation begins example: '2024-01-01' shifts: type: array description: >- The shifts making up one cycle, in the order they are worked. Only read when patternType is "Custom". items: $ref: '#/components/schemas/ShiftDto' example: - name: Morning Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 - name: Night Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 patternType: type: string description: Type of shift pattern enum: - Custom - FourFourFive - FourOnFourOff - ThreeOnThreeOff - TwoOnTwoOff - FiveOnTwoOff default: Custom example: FourOnFourOff ExplicitScheduleDto: type: object description: >- An explicit, week-by-week schedule for irregular workers whose pattern does not repeat. required: - weeks properties: weeks: description: The scheduled weeks. A week that is not listed counts as not worked. type: array items: $ref: '#/components/schemas/ScheduledWeekDto' ShiftDto: type: object description: >- One shift within a rotation: the days worked, and how long the shift lasts before the rotation moves on to the next entry in the list. required: - name - workingDays properties: name: type: string description: Name of the shift example: Morning Shift workingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' description: Working days configuration for this shift durationInDays: type: integer description: >- How many days this shift lasts before the next one starts. Use 7 for a shift covering a whole week. default: 1 example: 5 ScheduledWeekDto: type: object description: The working days for a single calendar week within an explicit schedule. required: - weekCommencing - workingDays properties: weekCommencing: type: string description: >- The date this week starts on (any weekday; a 7-day block). Format YYYY-MM-DD. example: '2026-07-06' workingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' description: Which days of that week are worked. securitySchemes: XAuthToken: type: apiKey in: header name: X-Auth-Token description: Access token obtained from OAuth2 client credentials flow XOrgId: type: apiKey in: header name: X-Org-Id description: >- Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.