tasktypes

Add a new task type to the database.

POST

/tasktype

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/tasktype \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": 123,
  "active_for_user": 123,
  "app": {},
  "attachments": {},
  "color_planned": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "default_client_id": 123,
  "default_extrawork_id": 123,
  "default_operation_id": 123,
  "default_order_id": 123,
  "default_status": [
    "<string>"
  ],
  "default_vehicle2_id": 123,
  "default_vehicle3_id": 123,
  "default_vehicle_id": 123,
  "deleted_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "direct_send": 123,
  "extras": {},
  "fields": {},
  "icon_backend": "<string>",
  "id": 123,
  "is_absence": 123,
  "is_sickness": 123,
  "menu": {},
  "name_multiple": "<string>",
  "name_single": "<string>",
  "print": {},
  "questions": [
    {
      "answer_type": "<string>",
      "answer_values": [
        {
          "value": "<string>"
        }
      ],
      "continuous": true,
      "id": 123,
      "question": "<string>",
      "required": true,
      "sort_order": 123
    }
  ],
  "show_planboard": 123,
  "show_prices": 123,
  "slug_multiple": "<string>",
  "slug_single": "<string>",
  "sort_order": 123,
  "times": {
    "clock": 123,
    "default_pause_time": 123,
    "default_repair_time": 123,
    "default_travel_time": 123,
    "default_travel_time_machine": 123,
    "default_wait_time": 123,
    "number": 123,
    "totals_operation": [
      "<string>"
    ],
    "totals_process": [
      "<string>"
    ]
  },
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "data": {
    "result": "<string>",
    "tasktype": {
      "active": 123,
      "active_for_user": 123,
      "app": {},
      "attachments": {},
      "color_planned": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "default_client_id": 123,
      "default_extrawork_id": 123,
      "default_operation_id": 123,
      "default_order_id": 123,
      "default_status": [
        "<string>"
      ],
      "default_vehicle2_id": 123,
      "default_vehicle3_id": 123,
      "default_vehicle_id": 123,
      "deleted_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "direct_send": 123,
      "extras": {},
      "fields": {},
      "icon_backend": "<string>",
      "id": 123,
      "is_absence": 123,
      "is_sickness": 123,
      "menu": {},
      "name_multiple": "<string>",
      "name_single": "<string>",
      "print": {},
      "questions": [
        {
          "answer_type": "<string>",
          "answer_values": [
            {
              "value": "<string>"
            }
          ],
          "continuous": true,
          "id": 123,
          "question": "<string>",
          "required": true,
          "sort_order": 123
        }
      ],
      "show_planboard": 123,
      "show_prices": 123,
      "slug_multiple": "<string>",
      "slug_single": "<string>",
      "sort_order": 123,
      "times": {
        "clock": 123,
        "default_pause_time": 123,
        "default_repair_time": 123,
        "default_travel_time": 123,
        "default_travel_time_machine": 123,
        "default_wait_time": 123,
        "number": 123,
        "totals_operation": [
          "<string>"
        ],
        "totals_process": [
          "<string>"
        ]
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Body

TaskType object.

activeinteger

Whether this task type is active in the backend. Returned as 1 (yes) or 0 (no).

active_for_userinteger

Whether this task type is activated for newly created employees. Returned as 1 (yes) or 0 (no).

appobject

The app settings of this task type, such as 'show_in_app', 'timer', 'icon', 'hide_options' and the required and read-only fields.

attachmentsobject

The sections shown under media in the app instead of in the task form, keyed by section name (for example 'medias', 'signatures' or 'questions') with '1' for shown and '0' for hidden.

color_plannedstring

The hex color of planned tasks of this task type.

created_atstring

The date and time this task type was created.

default_client_idinteger

The ID of the default client (klant) for new tasks of this task type.

default_extrawork_idinteger

The ID of the default extra work for new tasks of this task type.

default_operation_idinteger

The ID of the default operation for new tasks of this task type.

default_order_idinteger

The ID of the default order (project) for new tasks of this task type.

default_statusstring[]

The statuses set by default on new tasks of this task type, each either 'confirmed', 'processed', 'invoiced', 'finished', 'custom_status1' or 'custom_status2'.

default_vehicle2_idinteger

The ID of the default second vehicle (vehicle2) for new tasks of this task type.

default_vehicle3_idinteger

The ID of the default third vehicle (vehicle3) for new tasks of this task type.

default_vehicle_idinteger

The ID of the default vehicle for new tasks of this task type.

deleted_atstring

The date and time this task type was archived, or null when it is not archived.

descriptionstring

The description of this task type.

direct_sendinteger

Whether tasks of this task type are sent directly to the employee. Returned as 1 (yes) or 0 (no).

extrasobject

The extra settings of this task type, such as the duplicate and move actions, the visible codes and prices, and the planning board options.

fieldsobject

The task fields enabled for this task type, keyed by field name (for example 'start_time', 'client_id' or 'pause_time') with '1' for enabled and '0' for disabled.

icon_backendstring

The icon shown in the backend menu for this task type.

idintegerverplicht

The ID of this task type.

is_absenceinteger

Whether the hours of tasks of this task type are calculated as leave hours. Returned as 1 (yes) or 0 (no).

is_sicknessinteger

Whether the hours of tasks of this task type are calculated as sick leave hours. Returned as 1 (yes) or 0 (no).

The status filters shown in the menu for this task type, keyed by status (for example 'confirmed' or 'processed') with a matching '<status>_for' list.

name_multiplestringverplicht

The plural name of this task type.

name_singlestringverplicht

The singular name of this task type.

printobject

The print and overview settings of this task type, such as 'legenda', 'description_position', 'client_custom_name' and 'show_totals'.

questionsobject[]

The questions asked on tasks of this task type.

child attributes tonen

show_planboardinteger

Whether tasks of this task type are shown in the planning. Returned as 1 (yes) or 0 (no).

show_pricesinteger

Whether rates are shown on tasks of this task type. Returned as 1 (yes) or 0 (no).

slug_multiplestringverplicht

The unique plural slug of this task type.

slug_singlestringverplicht

The unique singular slug of this task type, stored as the type of the tasks (bonnen) that use it.

sort_orderinteger

The position of this task type in sorted lists.

timesobject

The time settings of this task type.

child attributes tonen

updated_atstring

The date and time this task type was last updated.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team