Gebruik SmartHR met Sokko.

Create up to 100 sensitive payslip entries in one SmartHR payroll group. The connected API access token must have payroll Update permission and any applicable employee-field Update permissions.

Create a SmartHR department. The connected API access token must have the department resource Update permission.

Create an employee using the documented SmartHR employee fields. The connected API token must have employee resource and field Update permissions.

Create an employee custom-field template. The connected API token must have the custom employee field resource Update permission.

Create an employee custom-field template group.

Create a dependent for one employee using the documented family fields. The connected API token must have the required family and employee-field Update permissions.

Create a SmartHR employment type. The connected API access token must have the employment type resource Update permission.

Create a SmartHR grade. The connected API access token must have the grade resource Update permission.

Create a SmartHR job category. The connected API access token must have the job category resource Update permission.

Create a SmartHR job title. The connected API access token must have the job title resource Update permission.

Create a sensitive SmartHR payroll group. The connected API access token must have payroll Update permission.

Create a sensitive employee payslip in one SmartHR payroll group. The connected API access token must have payslip resource Update permission, and employee-field Update permissions may constrain writable data.

Create a SmartHR recruitment type. The connected API access token must have the recruitment type resource Update permission.

Create a sensitive SmartHR tax-withholding group in the unconfirmed state. The connected API access token must have tax-withholding-group Update permission.

Create a file-backed or field-backed sensitive tax-withholding slip for an employee in one SmartHR tax-withholding group. The connected API access token must have the tax-withholding-slip resource and applicable employee-field Update permissions.

Create the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

Create a SmartHR webhook configuration for future employee and dependent events. Matching events can send data to the configured destination, so confirm the URL, event selections, payload exposure, and secret token before calling. The connected API access token must have the webhook resource Update permission.

Deprecated: delete a SmartHR department by ID. Prefer SMARTHR_DISCONTINUE_DEPARTMENT because SmartHR no longer recommends department deletion. Deletion requires the department resource Update permission and fails when the department or a child department has a scheduled employee update whose effective date has not arrived.

Permanently delete one employee by SmartHR employee ID. This requires the employee resource Update permission on the connected access token.

Delete one employee custom-field template by ID. This permanently deletes all employee values set for the template. SmartHR rejects deletion when the field has a scheduled employee update whose effective date has not arrived.

Delete one employee custom-field template group by ID. This also permanently deletes every custom-field template in the group and all values set for those templates. SmartHR rejects deletion when a group field has a scheduled employee update whose effective date has not arrived.

Permanently delete one dependent and their sensitive family data from an employee record. This cannot be undone.

Delete one SmartHR employment type by ID. SmartHR does not allow deletion of a system-standard employment type or one referenced by a scheduled employee update whose effective date has not arrived. The connected API access token must have the employment type resource Update permission.

Delete one SmartHR grade by ID. A grade referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the grade resource Update permission.

Delete one SmartHR job category by ID. A job category referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job category resource Update permission.

Delete one SmartHR job title by ID. A job title referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job title resource Update permission.

Permanently delete one sensitive SmartHR payroll group by ID. The connected API access token must have the payroll resource Update permission.

Permanently delete one sensitive SmartHR payslip from its payroll group. The connected API access token must have the payslip resource Update permission, and employee fields may also require Update permission.

Delete one SmartHR recruitment type by ID. A recruitment type referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the recruitment type resource Update permission.

Permanently delete one sensitive SmartHR tax-withholding group by ID. The connected API access token must have the tax-withholding-group resource Update permission.

Permanently delete one sensitive SmartHR tax-withholding slip from its tax-withholding group. The connected API access token must have the tax-withholding-slip resource Update permission, and employee fields may also require Update permission.

Delete the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

Permanently delete one SmartHR webhook configuration by ID. The connected API access token must have the webhook resource Update permission.

Disable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.

Irreversibly discontinue one SmartHR department as of its final active date. The date must be in the past. SmartHR rejects discontinuation when a scheduled employee update references this department or a descendant; the connected access token must have department Update permission.

Download a SmartHR batch-job attachment as an offloaded file reference, with a maximum download size of 100,000,000 bytes. SmartHR deletes the provider attachment five minutes after it is retrieved, so use the returned reference for subsequent work.

Enable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.

Finalize one sensitive SmartHR payroll group. The connected API access token must have the payroll-group resource Update permission.

Get one SmartHR background batch job by ID, optionally embedding its attachments. The access token needs the corresponding resource Reference permission.

Get one SmartHR department by its department ID.

Get one employee by SmartHR employee ID, with optional comma-separated field selection. The access token needs employee Reference permission, and returned attributes may be limited by employee-field Reference permissions.

Get one employee custom-field template by ID. Set embed to group to include the custom field group that contains the template.

Get one employee custom-field template group by ID. Set embed to templates to include the custom field templates belonging to the group.

Get one dependent belonging to an employee.

Get one SmartHR employee information-collection form by ID, preserving its nested field groups, fields, and embedded custom-field definitions.

Get one SmartHR employment type by its employment type ID.

Get one SmartHR grade by its grade ID.

Get one SmartHR job category by its job category ID.

Get one SmartHR job title by its job title ID.

Get one SmartHR mail format by ID, optionally embedding the employee information-collection forms that use it.

Get one SmartHR payroll payment period by its payment period ID.

Get one sensitive SmartHR payroll group by ID. The access token needs payroll Reference permission, and returned data may contain sensitive financial information.

Get one highly sensitive SmartHR payslip from a payroll group. The access token needs payslip Reference permission, and returned employee fields may be permission-filtered.

Get one SmartHR recruitment type by its recruitment type ID.

Get one highly sensitive SmartHR tax-withholding group by ID. The access token needs tax-withholding-group Reference permission.

Get one highly sensitive SmartHR tax-withholding slip from a tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.

Get one SmartHR user account by user ID with an optional related object embedded in the response.

Get the SAML SSO account configuration for one SmartHR user. This endpoint requires the tenant's SAML/SSO option to be enabled.

Get one SmartHR webhook configuration by webhook ID.

Send the documented SmartHR invitation to one employee's configured email address. Repeating the action resends the invitation unless the employee has already accepted it; the inviter must be an administrator.

List one page of SmartHR bank-account setting definitions. This does not return employee bank-account values.

List one page of SmartHR background batch jobs. Optionally embed attachment metadata for each job.

List one page of SmartHR business establishments, optionally embedding the social insurance representative, labor insurance representative, or company.

List one page of SmartHR companies with an optional embedded owner.

List one page of SmartHR departments using the documented code and sort filters. Returns hierarchy and company details when present.

List one page of SmartHR custom-field templates for employee dependents.

List one page of configured SmartHR dependent relationship types.

List one page of employee custom-field template groups. Set embed to templates to include the custom fields belonging to each group.

List one page of SmartHR employee custom-field templates. Set embed to group to include each template's custom-field group.

List one page of sensitive family and dependent records for a SmartHR employee. The access token needs dependent Reference permission, and returned fields may be limited by employee-field Reference permissions.

List one page of SmartHR employee information-collection forms with their nested field definitions. Set embed to mail_format to include linked mail formats.

List one page of sensitive maternity and childcare leave records for a SmartHR employee. The access token needs leave-record Reference permission.

List one page of employees matching SmartHR's documented employee filters. Employee records contain sensitive HR data; use fields to request only the attributes needed.

List one page of SmartHR employment types.

List one page of SmartHR grades.

List one page of SmartHR job categories.

List one page of SmartHR job titles using the documented sort option.

List one page of SmartHR mail formats. Set embed to crew_input_forms to include the employee input forms linked to each format.

List one page of SmartHR payroll payment periods.

List one page of sensitive SmartHR payroll groups using payment-date and payment-type filters. The access token needs payroll Reference permission.

List one page of highly sensitive SmartHR payslips in a payroll group. The access token needs payslip Reference permission, and employee fields may be permission-filtered.

List one page of SmartHR recruitment types.

List one page of sensitive SmartHR tax-withholding groups. The access token needs tax-withholding-group Reference permission.

List one page of sensitive tax-withholding slips in a SmartHR tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.

List one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.

List one page of SmartHR webhook configurations.

Partially update a SmartHR department by ID. The connected API access token must have the department resource Update permission.

Partially update an employee custom-field template. Elements apply only to enum templates. When a future-dated employee update is pending for the template, SmartHR permits updating only the hint.

Partially update a SmartHR employment type by ID. SmartHR does not allow renaming a system preset employment type or updating an employment type used by a pending future-dated employee update. The connected API access token must have the employment type resource Update permission.

Partially update the administrator-facing and employee-facing names of a sensitive SmartHR payroll group by ID. Both names are required by SmartHR. The connected API access token must have the payroll resource Update permission.

Partially update the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.

Partially update a SmartHR webhook by ID. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling. The connected API access token must have the webhook resource Update permission.

Irreversibly publish one sensitive SmartHR payroll group immediately or at a scheduled time within one month, optionally notifying employees. The connected API access token must have payroll Update permission.

Remove all department assignments from one employee using the documented SmartHR endpoint. This requires the employee resource and field Update permissions assigned to the connected access token.

Reopen one sensitive SmartHR payroll group. Reopening a published payroll may also unpublish it. The connected API access token must have payroll Update permission.

Replace a SmartHR department through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Departments with pending employee updates in their hierarchy cannot be updated.

Replace an employee custom-field template through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed. Existing dropdown elements omitted from elements are also deleted.

Replace an employee custom-field template group through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed.

Replace a SmartHR employment type through PUT. Attributes omitted from the PUT contract are deleted; use the partial-update action to preserve them. System-standard employment types and employment types used by pending employee updates cannot be changed.

Replace a SmartHR grade by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.

Replace a SmartHR job category by ID using full PUT semantics. The PUT contract allows name to be omitted. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.

Replace a SmartHR job title by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.

Replace a SmartHR recruitment type by ID using full PUT semantics. Name is required for the complete replacement. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.

Replace a sensitive SmartHR tax-withholding group by ID using full PUT semantics. Name, status, and year are all required for the complete replacement. Finalized tax withholdings cannot be updated. The connected API access token must have the tax-withholding-group resource Update permission.

Replace a SmartHR webhook through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling.

Start an asynchronous SmartHR dependent-data import from a Base64-encoded CSV or Excel file. This creates a background job that processes sensitive family HR data; the connected API access token must have the corresponding resource and employee-field Update permissions.

Start a SmartHR background job that exports employee information using an existing custom download format. A successful 201 response only confirms that the asynchronous job was registered; use the batch-job actions to monitor it and retrieve any resulting attachment. The connected access token must have the required resource and employee-field Update permissions.

Start a SmartHR background job that inserts or updates employees from a sensitive base64-encoded CSV or Excel file. The connected API access token must have the required resource and employee-field Update permissions.

Update the supplied documented fields of one employee by SmartHR employee ID.

Update one or more supplied fields of an employee custom-field template group.

Update the supplied fields of one dependent belonging to an employee.

Update the supplied fields of a SmartHR grade by ID. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.

Update the supplied fields of a SmartHR job category by ID. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.

Update the supplied fields of a SmartHR job title by ID. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.

Update a SmartHR recruitment type by ID. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.

Update the supplied fields of a sensitive SmartHR tax-withholding group by ID. SmartHR does not allow updates after the group is fixed. The connected API access token must have the tax-withholding-group resource Update permission.

Update a sensitive SmartHR tax-withholding slip using a file, legacy values, or a complete set of required structured fields. Confirmed slips cannot be updated, switching between file-backed and field-backed data requires deleting and recreating the slip, and the access token must have tax-withholding-slip Update permission.