PayCaptain API Integration

These are the list of integration use cases supported by Knit for PayCaptain API as part of the HRIS category

Get employees

• ID: get_employees
• Operation: read
• Entities: department, company, employee
• Summary: The 'Get employees' API retrieves a paginated list of employees with a limit of 50 records per page. It requires a company code as a query parameter and optionally accepts parameters to filter employees modified after a certain date, include former employees, and specify the page number. The response includes detailed information about each employee, such as personal details, job information, and bank details.
• Input Fields: Input Fields
• Output Fields: Output Fields

Create or Update a Payment

• ID: post_create_or_update_a_payment
• Operation: write
• Entities: payment, company, employee
• Summary: The Create or Update a Payment API allows users to create, update, or archive a payment. The request body requires details such as paymentId, company, hrEmployeeId, payrollCode, date, location, department, team, job, units, rate, payCode, description, information, and archived status. The API responds with a code indicating success (200) or error (400).
• Input Fields: Input Fields
• Output Fields: Output Fields

Create or Update a Shift

• ID: post_create_or_update_a_shift
• Operation: write
• Entities: shift, company, employee
• Summary: The 'Create or Update a Shift' API allows users to create, update, or archive a shift. The request body requires details such as shiftId, company, hrEmployeeId, payrollCode, date, location, department, team, job, units, rate, payBasis, type, sicknessDayType, reason, and archived status. The API responds with a code and description indicating the success or failure of the operation.
• Input Fields: Input Fields
• Output Fields: Output Fields

Create or Update an Employee

• ID: post_create_or_update_an_employee
• Operation: write
• Entities: department, company, employee
• Summary: This API endpoint allows for the creation or updating of an employee record. If the HR employee ID already exists, the existing record will be updated. The request body must include details such as company, HR employee ID, payroll code, personal information (name, date of birth, gender, etc.), contact information (email, phone, address), job details (location, department, job title, etc.), and payment details (salary, bank information, etc.). The response will indicate success with a 200 code or an error with a 400 code.
• Input Fields: Input Fields
• Output Fields: Output Fields