For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tasks

Get tasks

get
/tasks/

This api is used to sync external projects with WorkorderApp. Each project record can contain the following data:

Parameter
Required
Type (size)

code

Y

Varchar (255)

code_ext

N

Varchar (255)

debtor_number

Y

Varchar (255)

status

Y

Varchar (255)

name

Y

Varchar (255)

description

N

Text

progress

N

Integer

date_start

Y

Varchar (255)

date_end

N

Varchar (255)

active

N

Integer (1 or 0)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
tokenstringOptionalExample: {{client_token}}
software_tokenstringOptionalExample: {{software_token}}
Responses
200

Get tasks

application/json
get/tasks/
GET /tasks/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Get tasks

{
  "code": 200,
  "messages": [],
  "response": [
    {
      "tsk_id": "1",
      "tsk_tsk_id": null,
      "tsk_cus_id": "78",
      "tsk_type": "TASK",
      "tsk_name": "Test",
      "tsk_description": "<p>test</p>",
      "tsk_reference": "",
      "tsk_category": "2",
      "tsk_icon": "phone-square",
      "tsk_owner": "445697",
      "tsk_assigned_to": "",
      "tsk_priority": "LOW",
      "tsk_status": "COMPLETED",
      "tsk_debtor_nr": "876456",
      "tsk_address_nr": "",
      "tsk_contact_nr": "",
      "tsk_timestamp_due": null,
      "tsk_timestamp_create": "2021-03-08 14:51:26",
      "tsk_timestamp_mutate": "2021-03-12 22:45:08",
      "tsk_timestamp_started": "2021-03-10 18:07:28",
      "tsk_timestamp_completed": "2021-03-12 21:45:07",
      "tsk_timestamp_start": null,
      "tsk_link": null,
      "tsk_project_nr": null,
      "tsk_project_activity_nr": null,
      "tsk_order_nr": "WB-2021-00001",
      "tsk_invoice_number": "",
      "tsk_quotation_number": ""
    },
    {
      "tsk_id": "2",
      "tsk_tsk_id": null,
      "tsk_cus_id": "78",
      "tsk_type": "TASK",
      "tsk_name": "TEst",
      "tsk_description": "<p>test</p>",
      "tsk_reference": "",
      "tsk_category": "2",
      "tsk_icon": "phone-square",
      "tsk_owner": "445697",
      "tsk_assigned_to": "",
      "tsk_priority": "LOW",
      "tsk_status": "COMPLETED",
      "tsk_debtor_nr": "230",
      "tsk_address_nr": "",
      "tsk_contact_nr": "",
      "tsk_timestamp_due": null,
      "tsk_timestamp_create": "2021-03-18 15:02:40",
      "tsk_timestamp_mutate": null,
      "tsk_timestamp_started": null,
      "tsk_timestamp_completed": "2021-04-23 14:30:06",
      "tsk_timestamp_start": null,
      "tsk_link": null,
      "tsk_project_nr": null,
      "tsk_project_activity_nr": null,
      "tsk_order_nr": "WB-2021-00029",
      "tsk_invoice_number": "",
      "tsk_quotation_number": ""
    },
    {
      "tsk_id": "3",
      "tsk_tsk_id": null,
      "tsk_cus_id": "78",
      "tsk_type": "TASK",
      "tsk_name": "tsk_name",
      "tsk_description": "Gesproken met:<span style=\"color: rgb(152, 118, 170); background-color: rgb(43, 43, 43); font-family: \" jetbrains=\"\" mono\",=\"\" monospace;=\"\" font-size:=\"\" 13px;=\"\" letter-spacing:=\"\" 0.015rem;\"=\"\">CALL_LOG_DEFAULT_TEXT</span><br>\n<br>\nKlantvraag:<br>\n<br>\nUitgevoerde stappen om het op te lossen/escaleren:",
      "tsk_reference": "0611111111",
      "tsk_category": "CALL",
      "tsk_icon": "phone",
      "tsk_owner": "",
      "tsk_assigned_to": "",
      "tsk_priority": "NORMAL",
      "tsk_status": "COMPLETED",
      "tsk_debtor_nr": "1010101010319",
      "tsk_address_nr": "",
      "tsk_contact_nr": "",
      "tsk_timestamp_due": null,
      "tsk_timestamp_create": "2021-03-18 15:31:26",
      "tsk_timestamp_mutate": null,
      "tsk_timestamp_started": null,
      "tsk_timestamp_completed": "2021-04-23 14:30:07",
      "tsk_timestamp_start": "2021-03-18 15:31:26",
      "tsk_link": "",
      "tsk_project_nr": "",
      "tsk_project_activity_nr": "",
      "tsk_order_nr": "",
      "tsk_invoice_number": null,
      "tsk_quotation_number": null
    },
    {
      "tsk_id": "4",
      "tsk_tsk_id": null,
      "tsk_cus_id": "78",
      "tsk_type": "TASK",
      "tsk_name": "tsk_name",
      "tsk_description": "Gesproken met:<span style=\"color: rgb(152, 118, 170); background-color: rgb(43, 43, 43); font-family: \" jetbrains=\"\" mono\",=\"\" monospace;=\"\" font-size:=\"\" 13px;=\"\" letter-spacing:=\"\" 0.015rem;\"=\"\">CALL_LOG_DEFAULT_TEXT</span><br>\n<br>\nKlantvraag:<br>\n<br>\nUitgevoerde stappen om het op te lossen/escaleren:",
      "tsk_reference": "0611111111",
      "tsk_category": "CALL",
      "tsk_icon": "phone",
      "tsk_owner": "",
      "tsk_assigned_to": "",
      "tsk_priority": "NORMAL",
      "tsk_status": "IN_PROGRESS",
      "tsk_debtor_nr": null,
      "tsk_address_nr": null,
      "tsk_contact_nr": null,
      "tsk_timestamp_due": null,
      "tsk_timestamp_create": "2021-05-25 13:02:26",
      "tsk_timestamp_mutate": null,
      "tsk_timestamp_started": null,
      "tsk_timestamp_completed": null,
      "tsk_timestamp_start": null,
      "tsk_link": null,
      "tsk_project_nr": null,
      "tsk_project_activity_nr": null,
      "tsk_order_nr": null,
      "tsk_invoice_number": null,
      "tsk_quotation_number": null
    }
  ]
}

Add tasks

post
/tasks/

This api is used to sync tasks with OutSmart. Each task record can contain the following data:

Parameter
Required
Description

tsk_tsk_id

N

Parent tasks ID

tsk_type

Y

Type should be TASK

tsk_name

Y

Name description of the task

tsk_description

N

Long description, can contain HTML format

tsk_reference

Y

External reference used to update same task in the future

tsk_category

Y

Category used to group in OutSmart in general CALL or MAIL

tsk_icon

N

Icon used phone-square and envelope-o

tsk_owner

N

Employee number of the owner

tsk_assigned_to

N

Employee number of the assignee

tsk_priority

Y

LOW, NORMAL, HIGH

tsk_status

Y

YET_TO_START,IN_PROGRESS,COMPLETED,EXPIRED,CLOSED

tsk_debtor_nr

N

Connected customer debtor number

tsk_address_nr

N

Connected address code

tsk_contact_nr

N

Connected contactperson code

tsk_timestamp_due

N

Timestamp due

tsk_timestamp_create

N

Timestamp created

tsk_timestamp_mutate

N

Timestamp mutated

tsk_timestamp_started

N

Timestamp started

tsk_timestamp_completed

N

Timestamp completed

tsk_timestamp_start

N

Timestamp start

tsk_link

N

Link(href) to be rendered in the UI

tsk_project_nr

N

Connected project number

tsk_project_activity_nr

N

Connected project activity number

tsk_order_nr

N

Connected work order number

tsk_invoice_number

N

Connected invoice number

tsk_quotation_number

N

Connected quotation number

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
tokenstringOptionalExample: {{client_token}}
software_tokenstringOptionalExample: {{software_token}}
Responses
200

Response_200

No content

post/tasks/
POST /tasks/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Response_200

No content

Last updated

Was this helpful?