{
"task": {
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"context": {
"employee_id": "<string>",
"scope": "employee"
},
"requirement_id": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"type": "<string>"
}
],
"type": "hosted"
},
"manual": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"paths": [
{
"type": "<string>",
"value": "<string>",
"text": "<string>"
}
],
"order": 123
}
],
"type": "manual"
}
},
"category": "hr",
"type": "requirement",
"summary": "<string>",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"fee": {
"amount": "<string>",
"type": "fixed"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"summary": "<string>",
"tags": [
"certificate-of-good-standing"
],
"source": "requirement"
}
],
"automation_status": "started"
},
"priority": "medium",
"is_managed": false
},
"unlocked_tasks": [
{
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"context": {
"employee_id": "<string>",
"scope": "employee"
},
"requirement_id": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"type": "<string>"
}
],
"type": "hosted"
},
"manual": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"paths": [
{
"type": "<string>",
"value": "<string>",
"text": "<string>"
}
],
"order": 123
}
],
"type": "manual"
}
},
"category": "hr",
"type": "requirement",
"summary": "<string>",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"fee": {
"amount": "<string>",
"type": "fixed"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"summary": "<string>",
"tags": [
"certificate-of-good-standing"
],
"source": "requirement"
}
],
"automation_status": "started"
},
"priority": "medium",
"is_managed": false
}
]
}Updates the status of the specified requirement task. Question task’s status cannot be updated. Task status can be updated to todo or done only. After a successful update, the updated task is returned.
{
"task": {
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"context": {
"employee_id": "<string>",
"scope": "employee"
},
"requirement_id": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"type": "<string>"
}
],
"type": "hosted"
},
"manual": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"paths": [
{
"type": "<string>",
"value": "<string>",
"text": "<string>"
}
],
"order": 123
}
],
"type": "manual"
}
},
"category": "hr",
"type": "requirement",
"summary": "<string>",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"fee": {
"amount": "<string>",
"type": "fixed"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"summary": "<string>",
"tags": [
"certificate-of-good-standing"
],
"source": "requirement"
}
],
"automation_status": "started"
},
"priority": "medium",
"is_managed": false
},
"unlocked_tasks": [
{
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"context": {
"employee_id": "<string>",
"scope": "employee"
},
"requirement_id": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"type": "<string>"
}
],
"type": "hosted"
},
"manual": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"paths": [
{
"type": "<string>",
"value": "<string>",
"text": "<string>"
}
],
"order": 123
}
],
"type": "manual"
}
},
"category": "hr",
"type": "requirement",
"summary": "<string>",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"fee": {
"amount": "<string>",
"type": "fixed"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"resources": [
{}
],
"region": {
"id": "<string>",
"name": "<string>"
},
"summary": "<string>",
"tags": [
"certificate-of-good-standing"
],
"source": "requirement"
}
],
"automation_status": "started"
},
"priority": "medium",
"is_managed": false
}
]
}The access token received from the authorization server in the OAuth 2.0 flow.
todo, done Successful Response
Show child attributes
todo, deferred, in-progress, done Show child attributes
manual, hosted, endpoint Show child attributes
Directs a user to take action in order to start a hosted session to complete an action.
Show child attributes
"hosted"Show child attributes
Show child attributes
"manual"hr, insurance, payroll, registration, registration-maintenance, tax, sales-tax "requirement"Show child attributes
certificate-of-good-standing, charity-registration, charity-registration-renewal, employee-final-wage-payment, employee-new-hire-reporting, employee-onboarding, employee-termination, employee-requirement, exemption, foreign-qualification, foreign-state-only, handbook, home-state-only, initial-statement, local-business-setup, local-payroll-setup, newspaper-publication, notices, payroll-setup, registered-agent, sos-report, check-account-logins, setup, tpa-setup, task-applicability-override, sales-tax, warn-notice, password-update Show child attributes
certificate-of-good-standing, charity-registration, charity-registration-renewal, employee-final-wage-payment, employee-new-hire-reporting, employee-onboarding, employee-termination, employee-requirement, exemption, foreign-qualification, foreign-state-only, handbook, home-state-only, initial-statement, local-business-setup, local-payroll-setup, newspaper-publication, notices, payroll-setup, registered-agent, sos-report, check-account-logins, setup, tpa-setup, task-applicability-override, sales-tax, warn-notice, password-update "requirement"started, waiting_for_start_file_date, waiting_on_state, waiting_on_signature, waiting_on_customer_response, complete, canceled high, medium, low Show child attributes
todo, deferred, in-progress, done Show child attributes
manual, hosted, endpoint Show child attributes
Directs a user to take action in order to start a hosted session to complete an action.
Show child attributes
Show child attributes
"hosted"Show child attributes
Show child attributes
"manual"hr, insurance, payroll, registration, registration-maintenance, tax, sales-tax "requirement"Show child attributes
certificate-of-good-standing, charity-registration, charity-registration-renewal, employee-final-wage-payment, employee-new-hire-reporting, employee-onboarding, employee-termination, employee-requirement, exemption, foreign-qualification, foreign-state-only, handbook, home-state-only, initial-statement, local-business-setup, local-payroll-setup, newspaper-publication, notices, payroll-setup, registered-agent, sos-report, check-account-logins, setup, tpa-setup, task-applicability-override, sales-tax, warn-notice, password-update Show child attributes
certificate-of-good-standing, charity-registration, charity-registration-renewal, employee-final-wage-payment, employee-new-hire-reporting, employee-onboarding, employee-termination, employee-requirement, exemption, foreign-qualification, foreign-state-only, handbook, home-state-only, initial-statement, local-business-setup, local-payroll-setup, newspaper-publication, notices, payroll-setup, registered-agent, sos-report, check-account-logins, setup, tpa-setup, task-applicability-override, sales-tax, warn-notice, password-update "requirement"started, waiting_for_start_file_date, waiting_on_state, waiting_on_signature, waiting_on_customer_response, complete, canceled high, medium, low