# WurkNow API

## Docs
- [Overview](https://docs.wurknow.com/doc-602866.md): 

## API Docs
- Client [Get All Client Users](https://docs.wurknow.com/api-21822165.md): 
- Client [Get GeoFence Locations](https://docs.wurknow.com/api-23889275.md): This API returns a list of GeoFence Locations linked to a given Client. The response includes unique Id, ClientName, LocationName, Address
- Client [Add Clients](https://docs.wurknow.com/api-8318944.md): Create a new client under a specific agency with full contact, address, and account details.
- Client [Get Clients](https://docs.wurknow.com/api-20509358.md): This API returns a list of clients linked to a given agency. You can narrow results by specifying filters such as client status, creation date range, and pagination options. The response includes full client details including contact information, addresses (mailing, billing, shipping), account settings, and the profile creation date.
- Client [Update Client](https://docs.wurknow.com/api-8318945.md): This endpoint updates an existing client’s profile by replacing all required fields with the new values provided in the request. To perform the update, you must supply all mandatory client information, including agency details, client name, contact information, addresses, status, and other required fields. The request will overwrite the existing client record with the provided data, ensuring the profile reflects the latest complete information.
- Client [Get Client](https://docs.wurknow.com/api-20509359.md): This API retrieves complete details for a client based on the provided ClientName filter. The ClientName parameter is mandatory and must match the exact name of the client you want to look up. When a valid client name is provided, the API returns a full record of that client such as Name, Address, Agency Name, Status and Access etc.
- Client [Get Billing Templates](https://docs.wurknow.com/api-28691621.md): Retrieves the billing templates for a specified client by client GUID.
- Employee [Get Employee](https://docs.wurknow.com/api-20509361.md): This API retrieves a comprehensive list of all employees assigned to a specific agency. It supports optional filters to refine the results based on employee status, hire date, and created employee after Start date and before End Date.
- Employee [Get Employee](https://docs.wurknow.com/api-20509360.md): This endpoint retrieves the complete profile of a specific employee using their Id (Employee ID). The Id is mandatory and is used to uniquely identify the employee record.
- Employee [Add Employee](https://docs.wurknow.com/api-20186830.md): This endpoint allows you to create a new employee profile by providing all the required employee and agency details in the request body. All mandatory fields must be filled to successfully add the employee to the system.
- Employee [Update Employee](https://docs.wurknow.com/api-20186831.md): This API allows you to update an existing employee’s details for a given agency. It accepts personal details, contact information, employment status, reporting details, policies, and compliance information.
- Employee [Add Job Assignments](https://docs.wurknow.com/api-8318950.md): This API is used to assign a new job assignment to an employee within an agency. It links an employee to a specific client, job order, or department by defining the assignment details, pay structure, and validity period.
- Employee [Update Job Assignments](https://docs.wurknow.com/api-8318951.md): This API is used to update an existing job assignment for an employee within a given agency. It allows modification of assignment details such as pay rate, billing type, assignment duration, department, and custom fields.
- Employee [Cancel Job Assignments](https://docs.wurknow.com/api-8318952.md): This API is used to cancel an existing job assignment for an employee under a specific agency and client. It requires the Agency name, Client Id, Employee ID and assignment number (AssignmentNo) as a identifiers.
- Employee [Add Update Client and Job Assignment](https://docs.wurknow.com/api-8318958.md): This API is used to add or update both Client Assignments and Job Assignments for an employee under a specific agency.
- Employee [Get Job Order Assignment](https://docs.wurknow.com/api-8318956.md): This API is used to retrieve job assignment details of employees for a given agency.
- Client Assignment [Get Client Assignment](https://docs.wurknow.com/api-8318955.md): This API retrieves all types of client assignments associated with a specific employee based on the provided HREmpId (Employee ID) and ClientCode (Client ID). By using these two filters, users can obtain a complete view of all assignments, including active, past, and scheduled assignments under the given client for that employee.
- Client Assignment [Add Client Assignments](https://docs.wurknow.com/api-8318948.md): This API is used to assign an employee to a client within an agency and configure their shift, policies and system access.
- Client Assignment [Update Client Assignments](https://docs.wurknow.com/api-8318949.md): This API is used to update client assignment details for an employee. It allows agencies to modify assignment-related information such as hire details, shift, status, department, policies, approvers, and system access settings (e.g., mobile app, biometric clock, employee portal, etc.).
- Job Order [Get Job Orders](https://docs.wurknow.com/api-20580197.md): Get the list of job orders based on the filter options.
- Job Order [Get job Order details](https://docs.wurknow.com/api-20582539.md): Get Job Order details
- Job Order [Get Job Order Assignments](https://docs.wurknow.com/api-20186191.md): This API allows users to retrieve the details of all job assignments associated with a specific JobOrderCode or JobOrderID. By providing the job order identifier, users can obtain a comprehensive view of every assignment under that job order, including assignment-specific details, pay information, department and level hierarchies, and any custom or additional properties.
- Timecard [Get Timecards By Status](https://docs.wurknow.com/api-23829630.md): Fetches all employee timecards for a specified Pay Start Date, Pay End Date, and timecard status. Returns timecard details based on the agency’s selected payroll template and includes basic client information associated with the payroll.
- Timecard [Get Approved Timecards](https://docs.wurknow.com/api-23896934.md): This API is used to fetch all approved timecards of employees based on Pay Start date and Pay End date. It provides details in timecard based on payroll template selected by agency. 
- Timecard [Who’s at Work](https://docs.wurknow.com/api-8318965.md): This API retrieves a list of employees who were actively at work (punched in) during a specified reporting start and end date/time range.
- Timecard [Timecard_GetClientEmployees](https://docs.wurknow.com/api-8318969.md): This API retrieves all employees associated with a specific client based on the provided ClientID. Optionally, results can be filtered by employment status (e.g., Active, Inactive)
- VmsJobOrder [VmsJobOrder_ImportVmsJobOrders](https://docs.wurknow.com/api-8318975.md): This API is designed to add job orders into the Labor Vendor Management System (LVMS). Each job order contains essential information such as order details, work location, Shift, pay rate, position count, department, and custom levels for categorization.
- ClientWorksite [Get ClientWorksites](https://docs.wurknow.com/api-21568688.md): This endpoint retrieves a paginated list of client worksites for the current agency.
- ClientWorksite [Add ClientWorkSite](https://docs.wurknow.com/api-21568689.md): This endpoint allows you to create a new worksite location for a client within the system.
- ClientWorksite [Get ClientWorksite](https://docs.wurknow.com/api-21568690.md): This endpoint retrieves the details of a specific client worksite location based on its unique identifier.
- MSP Client [Get Employee Timecard Details](https://docs.wurknow.com/api-8318966.md): This API is used to retrieve all employee timecard records for a specified client within a defined date range. It requires Client ID and From/To dates as mandatory filters. The response includes detailed information such as employee profile, punches (in/out), shift, actual worked times and calculated hours.
- MSP Client [Get Last Week Timecards](https://docs.wurknow.com/api-8318967.md): This API retrieves the complete timecard details of employees for a week, based on the required filter of Client ID. It returns detailed employee information including profile, shift details, punch timings, actual punches and hours.
- MSP Client [Get Today Timecards](https://docs.wurknow.com/api-8318968.md): This API retrieves the complete timecard details of employees for today, based on the required filter of Client ID. It returns detailed employee information including profile, shift details, punch timings, actual punches and hours.
- MSP Client [Get Employee Timecards](https://docs.wurknow.com/api-8318964.md): This API is used to fetch all employee timecards for a specific client on a given reporting date. It provides essential details such as employee information, shift, punches (In and Out), and total worked hours.
- Report [Get Bill Summary_EMP Report](https://docs.wurknow.com/api-27608451.md): Returns the Bill Summary_EMP report list for a specified client and date range
- Report [Get Labor Cost Report](https://docs.wurknow.com/api-28691622.md): Returns the Labor Cost Report for a specified client and date range
- Report [Get Labor Cost CA Report](https://docs.wurknow.com/api-28691623.md): Returns the Labor Cost CA Report for a specified client and date range

## Schemas
- Schemas [AgentUserDTO](https://docs.wurknow.com/schema-8685691.md): 
- Schemas [AgencyInfoDTO](https://docs.wurknow.com/schema-8685693.md): 
- Schemas [AsgmtCustomPropertyDTO](https://docs.wurknow.com/schema-2514540.md): 
- Schemas [BranchesDTO](https://docs.wurknow.com/schema-8685690.md): 
- Schemas [BulkUpsertEmployeeDto](https://docs.wurknow.com/schema-2514550.md): 
- Schemas [Category](https://docs.wurknow.com/schema-2514383.md): 
- Schemas [ClAsgmtJobAsgmModel](https://docs.wurknow.com/schema-2514547.md): 
- Schemas [ClAsgmtModel](https://docs.wurknow.com/schema-2514548.md): 
- Schemas [ContactInfo](https://docs.wurknow.com/schema-2514557.md): 
- Schemas [CustomEmployeeModel](https://docs.wurknow.com/schema-2514531.md): 
- Schemas [ClientEmployeeDTO](https://docs.wurknow.com/schema-2514553.md): 
- Schemas [ClientUserDTO](https://docs.wurknow.com/schema-8685692.md): 
- Schemas [CustomWnTempProfileEducation](https://docs.wurknow.com/schema-2514532.md): 
- Schemas [CustomWnTempProfileWork](https://docs.wurknow.com/schema-2514533.md): 
- Schemas [DailyAnalyticsDTO](https://docs.wurknow.com/schema-8685694.md): 
- Schemas [DocumentExpirationDTO](https://docs.wurknow.com/schema-8685695.md): 
- Schemas [Earning](https://docs.wurknow.com/schema-2514559.md): 
- Schemas [EmployeeTimecardDTO](https://docs.wurknow.com/schema-2514551.md): 
- Schemas [ImportClientDTO](https://docs.wurknow.com/schema-2514527.md): 
- Schemas [ImportAssignmentDTO](https://docs.wurknow.com/schema-2514539.md): 
- Schemas [ImportAsgmtEmployeeDTO](https://docs.wurknow.com/schema-2514543.md): 
- Schemas [ImportClAssignmentDTO](https://docs.wurknow.com/schema-2514537.md): 
- Schemas [ImportCancelAssignmentDTO](https://docs.wurknow.com/schema-2514542.md): 
- Schemas [ImportVmsJobOrderViewModel](https://docs.wurknow.com/schema-2514560.md): 
- Schemas [ImportVMSJobOrderDTO](https://docs.wurknow.com/schema-2514561.md): 
- Schemas [JobOrderInfoDto](https://docs.wurknow.com/schema-8900886.md): 
- Schemas [JobOrderDetailDto](https://docs.wurknow.com/schema-8901051.md): 
- Schemas [JobAsgmtModel](https://docs.wurknow.com/schema-2514549.md): 
- Schemas [JobOrderClientResponse](https://docs.wurknow.com/schema-8685696.md): 
- Schemas [Name](https://docs.wurknow.com/schema-2514556.md): 
- Schemas [RequestMigrationDTO[CustomEmployeeModel]](https://docs.wurknow.com/schema-2514530.md): 
- Schemas [RequestEmpDTO[ClAsgmtJobAsgmModel]](https://docs.wurknow.com/schema-2514546.md): 
- Schemas [ResponseDTO](https://docs.wurknow.com/schema-2514528.md): 
- Schemas [RequestEmpDTO[APIEmployeeDTO]](https://docs.wurknow.com/schema-2514544.md): 
- Schemas [ResponseMigrationDTO](https://docs.wurknow.com/schema-2514534.md): 
- Schemas [ResponseImportDTO](https://docs.wurknow.com/schema-2514529.md): 
- Schemas [RequestMigrationDTO[ImportClientDTO]](https://docs.wurknow.com/schema-2514526.md): 
- Schemas [RequestMigrationDTO[ImportClAssignmentDTO]](https://docs.wurknow.com/schema-2514536.md): 
- Schemas [RequestMigrationDTO[ImportCancelAssignmentDTO]](https://docs.wurknow.com/schema-2514541.md): 
- Schemas [RequestMigrationDTO[ImportAssignmentDTO]](https://docs.wurknow.com/schema-2514538.md): 
- Schemas [TrackerMigrationDTO](https://docs.wurknow.com/schema-2514535.md): 
- Schemas [Tag](https://docs.wurknow.com/schema-2514384.md): 
- Schemas [Telnyx_TextDeliveryWebhookWebhook](https://docs.wurknow.com/schema-2514562.md): 
- Schemas [TimepairDetailDTO](https://docs.wurknow.com/schema-8685698.md): 
- Schemas [UKGPayrollAPIModel](https://docs.wurknow.com/schema-2514558.md): 
- Schemas [UKGInputModel](https://docs.wurknow.com/schema-2514554.md): 
- Schemas [UnprocessedTimecardsDTO](https://docs.wurknow.com/schema-8685697.md): 
- Schemas [UKGCandidateCreateModel](https://docs.wurknow.com/schema-2514555.md): 
- Schemas [WhosAtWorkDTO](https://docs.wurknow.com/schema-2514552.md): 
- Schemas [RecordRoles](https://docs.wurknow.com/schema-8882023.md): 
- Schemas [CustomData](https://docs.wurknow.com/schema-8882253.md): 
- Schemas [ClWorkSiteLocationNamesDTO](https://docs.wurknow.com/schema-9506542.md): 
- Schemas [ApprovedTCDataAPI](https://docs.wurknow.com/schema-10715653.md): 
- Schemas [ClinetGeoFenceLocationList](https://docs.wurknow.com/schema-10715489.md): 
- Schemas [PayrollData](https://docs.wurknow.com/schema-10688203.md): 
- Schemas [WnUserDTO](https://docs.wurknow.com/schema-9671075.md): 
- Schemas [ImportClWorksiteLocationDataDTO](https://docs.wurknow.com/schema-9506500.md): 
- Schemas [GetClientDetails](https://docs.wurknow.com/schema-8867218.md): 
- Schemas [ClWorksiteLocationDataDTO](https://docs.wurknow.com/schema-9506501.md): 
- Schemas [GetClientDataDetails](https://docs.wurknow.com/schema-8867219.md): 
- Schemas [GetEmployeeDataDetails](https://docs.wurknow.com/schema-8867220.md): 
- Schemas [GetEmployeeDetails](https://docs.wurknow.com/schema-8867221.md): 
- Schemas [ClientDataDTO](https://docs.wurknow.com/schema-10688757.md): 
- [APIEmployeeDTO](https://docs.wurknow.com/schema-2514545.md): 
- [ClientBillTemplateDTO](https://docs.wurknow.com/schema-13127384.md): 
- [BillSummaryEmpDisplayDTO](https://docs.wurknow.com/schema-12725187.md): 
- [LaborCostDisplayDTO](https://docs.wurknow.com/schema-13127385.md): 
- [LaborCostCADisplayDTO](https://docs.wurknow.com/schema-13127386.md):