tasks

Add a new task to the database.

POST

/task

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/task \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additionalwork": [
    {
      "item_id": 123,
      "item_type": "<string>",
      "pricings": [
        {
          "amount": "<string>",
          "price_per": "<string>",
          "unit_custom_name": "<string>",
          "unit_id": 123
        }
      ]
    }
  ],
  "administration_id": 123,
  "amount_amount": "<string>",
  "amount_custom_name": "<string>",
  "amount_id": 123,
  "amount_unit_custom_name": "<string>",
  "amount_unit_id": 123,
  "amounts": [
    {
      "amount": "<string>",
      "amount_custom_name": "<string>",
      "amount_id": 123,
      "unit_custom_name": "<string>",
      "unit_id": 123
    }
  ],
  "arrangements": {
    "commute": "<string>",
    "daily_allowance": "<string>",
    "distance_amount": "<string>",
    "foreman_allowance": "<string>",
    "nightly_allowance": "<string>",
    "parking_fees": "<string>",
    "travel_allowance_personal": "<string>"
  },
  "arrival_load_location": "2023-11-07T05:31:56Z",
  "arrival_unload_location": "2023-11-07T05:31:56Z",
  "at_same_time": 123,
  "buyer_custom_name": "<string>",
  "buyer_id": 123,
  "capacity_plan_capacity_id": 123,
  "capacity_plan_id": 123,
  "client_custom_name": "<string>",
  "client_id": 123,
  "color": "<string>",
  "components": [
    {
      "amount": "<string>",
      "material_custom_name": "<string>",
      "material_id": 123,
      "unit_custom_name": "<string>",
      "unit_id": 123
    }
  ],
  "conceptdate": "2023-11-07T05:31:56Z",
  "confirmed": 123,
  "confirmed_date": "2023-12-25",
  "coordinates": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_id": 123,
  "created_by_type": "<string>",
  "custom_status1": 123,
  "custom_status2": 123,
  "customfield1": "<string>",
  "customfield2": "<string>",
  "customfield3": "<string>",
  "customfield4": "<string>",
  "customfield5": "<string>",
  "date": "2023-12-25",
  "debits": [
    {
      "amount": "<string>",
      "expense_custom_name": "<string>",
      "expense_id": 123
    }
  ],
  "deleted_at": "2023-11-07T05:31:56Z",
  "departure_load_location": "2023-11-07T05:31:56Z",
  "departure_unload_location": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "distances": [
    {
      "amount": "<string>",
      "amounts": [
        {
          "amount": "<string>",
          "pricing_id": 123
        }
      ],
      "at_same_time": "<string>",
      "end_mileage": 123,
      "hours_stand": 123,
      "operating_hours": "<string>",
      "start_mileage": 123,
      "vehicle_custom_name": "<string>",
      "vehicle_id": 123
    }
  ],
  "distances2": [
    {
      "amount": "<string>",
      "amounts": [
        {
          "amount": "<string>",
          "pricing_id": 123
        }
      ],
      "at_same_time": "<string>",
      "end_mileage": 123,
      "hours_stand": 123,
      "operating_hours": "<string>",
      "start_mileage": 123,
      "vehicle_custom_name": "<string>",
      "vehicle_id": 123
    }
  ],
  "distances3": [
    {
      "amount": "<string>",
      "amounts": [
        {
          "amount": "<string>",
          "pricing_id": 123
        }
      ],
      "at_same_time": "<string>",
      "end_mileage": 123,
      "hours_stand": 123,
      "operating_hours": "<string>",
      "start_mileage": 123,
      "vehicle_custom_name": "<string>",
      "vehicle_id": 123
    }
  ],
  "drawee_custom_name": "<string>",
  "drawee_id": 123,
  "end_mileage": 123,
  "end_time": "2023-11-07T05:31:56Z",
  "entry": {
    "comment": "<string>",
    "date": "2023-12-25",
    "id": 123,
    "user": {
      "activated_at": "2023-11-07T05:31:56Z",
      "activation_code": "<string>",
      "add_hours_mail": 123,
      "address": "<string>",
      "avatar_url": "<string>",
      "banned_at": "2023-11-07T05:31:56Z",
      "banned_reason": "<string>",
      "clock_type": "<string>",
      "contactperson": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_ip_address": "<string>",
      "custom_message": 123,
      "custom_message_history": "<string>",
      "date_of_birth": "2023-12-25",
      "default_administration_id": 123,
      "default_client_id": 123,
      "default_extrawork_id": 123,
      "default_operation_category_id": 123,
      "default_operation_id": 123,
      "default_order_id": 123,
      "default_task_type_slug": "<string>",
      "default_travel_time": 123,
      "default_user_group_id": 123,
      "default_vehicle2_id": 123,
      "default_vehicle3_id": 123,
      "default_vehicle_id": 123,
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": 123,
      "description": "<string>",
      "dont_save_images_to_gallery": 123,
      "email": "<string>",
      "employee_number": "<string>",
      "extra_data": {},
      "first_name": "<string>",
      "groups": [
        {
          "code": "<string>",
          "color": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>",
          "pivot": {
            "user_group_id": 123,
            "user_id": 123
          },
          "sort_order": 123
        }
      ],
      "house_number": "<string>",
      "id": 123,
      "initials": "<string>",
      "is_guest": 123,
      "is_mail_blocked": 123,
      "is_support_active": 123,
      "keep_screen_active": 123,
      "language_preference": "<string>",
      "last_ip_address": "<string>",
      "last_name": "<string>",
      "last_seen": "2023-11-07T05:31:56Z",
      "location_administration": 123,
      "location_automatic": 123,
      "location_coordinates": "<string>",
      "location_lastseen": "2023-11-07T05:31:56Z",
      "location_whoiswhere": 123,
      "mails": {},
      "new_tasks_mail": 123,
      "note_entries": [
        {
          "date": "<string>",
          "description": "<string>",
          "title": "<string>"
        }
      ],
      "notes": "<string>",
      "notification_frequency": "<string>",
      "open_pdf_external": 123,
      "open_url_external": 123,
      "phone": "<string>",
      "postal_code": "<string>",
      "primary_group_id": 123,
      "push_token": "<string>",
      "residence": "<string>",
      "settings_location": 123,
      "settings_notification": 123,
      "social_security_number": "<string>",
      "sort_order": 123,
      "superadmin_description": "<string>",
      "supplier_id": 123,
      "task_color": "<string>",
      "task_newtask": 123,
      "task_showclients": 123,
      "task_showoperations": 123,
      "task_workedhours": 123,
      "tasktypes_blocked": [
        "<any>"
      ],
      "times_enable_minimal_pause_minutes": 123,
      "times_enable_minimal_work_hours": 123,
      "times_minimal_pause_minutes": "<string>",
      "times_minimal_work_hours": "<string>",
      "two_factor_confirmed_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "username": "<string>",
      "version": "<string>"
    },
    "user_id": 123
  },
  "entry_id": 123,
  "expense_amount": "<string>",
  "expense_custom_name": "<string>",
  "expense_id": 123,
  "external_ids": {},
  "extrawork_custom_name": "<string>",
  "extrawork_id": 123,
  "finished": 123,
  "from_portal": 123,
  "group_identifier": "<string>",
  "has_read": 123,
  "has_sent": 123,
  "hours_stand": 123,
  "id": 123,
  "identifier": "<string>",
  "internal_description": "<string>",
  "invoice_items": [
    {
      "customfield1": "<string>",
      "customfield2": "<string>",
      "customfield3": "<string>",
      "customfield4": "<string>",
      "customfield5": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "discount": 123,
      "external_ids": {},
      "id": 123,
      "invoice_id": 123,
      "invoice_item_id": 123,
      "item_id": 123,
      "item_pricing_id": 123,
      "item_type": "<string>",
      "price": 123,
      "quantity": 123,
      "source_id": 123,
      "source_type": "<string>",
      "unit": "<string>",
      "vat_rate_id": 123
    }
  ],
  "invoiced": 123,
  "invoiced_time": "2023-11-07T05:31:56Z",
  "klic_links": [
    {
      "klic_link": "<string>"
    }
  ],
  "last_edited_by": 123,
  "load_amount": "<string>",
  "load_coordinates": "<string>",
  "load_location": "<string>",
  "load_location_id": 123,
  "load_material_custom_name": "<string>",
  "load_material_id": 123,
  "load_reference": "<string>",
  "load_storage_number": "<string>",
  "load_unit_custom_name": "<string>",
  "load_unit_id": 123,
  "load_unload_customfield1": "<string>",
  "loading_unloading": [
    {
      "arrival_load_location": "2023-11-07T05:31:56Z",
      "arrival_unload_location": "2023-11-07T05:31:56Z",
      "buyer_custom_name": "<string>",
      "buyer_id": 123,
      "departure_load_location": "2023-11-07T05:31:56Z",
      "departure_unload_location": "2023-11-07T05:31:56Z",
      "drawee_custom_name": "<string>",
      "drawee_id": 123,
      "load_amount": "<string>",
      "load_coordinates": "<string>",
      "load_location": "<string>",
      "load_material_custom_name": "<string>",
      "load_material_id": 123,
      "load_reference": "<string>",
      "load_storage_number": "<string>",
      "load_unit_custom_name": "<string>",
      "load_unit_id": 123,
      "load_unload_customfield1": "<string>",
      "supplier_custom_name": "<string>",
      "supplier_id": 123,
      "unload_amount": "<string>",
      "unload_coordinates": "<string>",
      "unload_location": "<string>",
      "unload_reference": "<string>",
      "unload_storage_number": "<string>"
    }
  ],
  "location": "<string>",
  "locations": [
    {
      "coordinates": "<string>",
      "location": "<string>",
      "reference": "<string>"
    }
  ],
  "logbook": [
    {
      "comment": "<string>",
      "date": "<string>"
    }
  ],
  "man_day_id": 123,
  "manure_code": "<string>",
  "manure_codes": [
    {
      "code": "<string>"
    }
  ],
  "material_amount": "<string>",
  "material_custom_name": "<string>",
  "material_id": 123,
  "material_unit_custom_name": "<string>",
  "material_unit_id": 123,
  "operating_hours": "2023-11-07T05:31:56Z",
  "operation_amount": "<string>",
  "operation_amounts": [
    {
      "amount": "<string>",
      "pricing_id": 123
    }
  ],
  "operation_category_id": 123,
  "operation_custom_name": "<string>",
  "operation_id": 123,
  "operations": [
    {
      "amounts": [
        {
          "amount": "<string>",
          "pricing_id": 123
        }
      ],
      "at_same_time": "<string>",
      "operation_category_id": 123,
      "operation_custom_name": "<string>",
      "operation_id": 123,
      "operation_type": "<string>",
      "time": "<string>"
    }
  ],
  "order_id": 123,
  "ordernumber": "<string>",
  "parent_id": 123,
  "part_amount": "<string>",
  "part_custom_name": "<string>",
  "part_id": 123,
  "part_unit_custom_name": "<string>",
  "part_unit_id": 123,
  "parts": [
    {
      "amount": "<string>",
      "description": "<string>",
      "part_custom_name": "<string>",
      "part_id": 123,
      "unit_custom_name": "<string>",
      "unit_id": 123
    }
  ],
  "pause_time": 123,
  "pause_times": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "pricelist_id": 123,
  "pricing_zone_double_calculate_transport": 123,
  "pricing_zone_id": 123,
  "pricing_zone_locked": 123,
  "pricing_zone_price": "<string>",
  "processed": 123,
  "processed_time": "2023-11-07T05:31:56Z",
  "range_end_date": "2023-12-25",
  "reference": "<string>",
  "repair_time": 123,
  "repair_times": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "repeats": 123,
  "row_id": "<string>",
  "send_changes": 123,
  "sent_by_mail": 123,
  "sign_off_sheet_id": 123,
  "start_mileage": 123,
  "start_time": "2023-11-07T05:31:56Z",
  "storage_number": 123,
  "subcontractor_custom_email": "<string>",
  "subcontractor_custom_name": "<string>",
  "subcontractor_custom_phone": "<string>",
  "subcontractor_id": 123,
  "suborder_custom_name": "<string>",
  "suborder_id": 123,
  "subuser_id": 123,
  "supplier_custom_name": "<string>",
  "supplier_id": 123,
  "timer_is_running": 123,
  "timer_start_time": "2023-11-07T05:31:56Z",
  "timer_type": "<string>",
  "travel_time": 123,
  "travel_time_machine": "2023-11-07T05:31:56Z",
  "travel_times": [
    {
      "from": "<string>",
      "to": "<string>",
      "type": "<string>"
    }
  ],
  "type": "<string>",
  "unload_amount": "<string>",
  "unload_coordinates": "<string>",
  "unload_location": "<string>",
  "unload_location_id": 123,
  "unload_reference": "<string>",
  "unload_storage_number": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_group_id": 123,
  "users": [
    {
      "confirmed": "<string>",
      "end_time": "2023-11-07T05:31:56Z",
      "has_read": true,
      "has_sent": true,
      "operation_id": 123,
      "pause_time": 123,
      "start_time": "2023-11-07T05:31:56Z",
      "subuser_id": 123,
      "travel_time": 123,
      "user_id": 123,
      "vehicle_id": 123
    }
  ],
  "vehicle2_amount": "<string>",
  "vehicle2_amounts": [
    {
      "amount": "<string>",
      "pricing_id": 123
    }
  ],
  "vehicle2_at_same_time": 123,
  "vehicle2_custom_name": "<string>",
  "vehicle2_end_mileage": 123,
  "vehicle2_hours_stand": 123,
  "vehicle2_id": 123,
  "vehicle2_operating_hours": "2023-11-07T05:31:56Z",
  "vehicle2_start_mileage": 123,
  "vehicle3_amount": "<string>",
  "vehicle3_amounts": [
    {
      "amount": "<string>",
      "pricing_id": 123
    }
  ],
  "vehicle3_at_same_time": 123,
  "vehicle3_custom_name": "<string>",
  "vehicle3_end_mileage": 123,
  "vehicle3_hours_stand": 123,
  "vehicle3_id": 123,
  "vehicle3_operating_hours": "2023-11-07T05:31:56Z",
  "vehicle3_start_mileage": 123,
  "vehicle_amount": "<string>",
  "vehicle_amounts": [
    {
      "amount": "<string>",
      "pricing_id": 123
    }
  ],
  "vehicle_custom_name": "<string>",
  "vehicle_id": 123,
  "version": 123,
  "wait_time": 123,
  "wait_times": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "weather": "<string>",
  "work_description": "<string>",
  "work_inventory_id": 123
}
'

{
  "data": {
    "result": "<string>",
    "task": {
      "additionalwork": [
        {
          "item_id": 123,
          "item_type": "<string>",
          "pricings": [
            {
              "amount": "<string>",
              "price_per": "<string>",
              "unit_custom_name": "<string>",
              "unit_id": 123
            }
          ]
        }
      ],
      "administration_id": 123,
      "amount_amount": "<string>",
      "amount_custom_name": "<string>",
      "amount_id": 123,
      "amount_unit_custom_name": "<string>",
      "amount_unit_id": 123,
      "amounts": [
        {
          "amount": "<string>",
          "amount_custom_name": "<string>",
          "amount_id": 123,
          "unit_custom_name": "<string>",
          "unit_id": 123
        }
      ],
      "arrangements": {
        "commute": "<string>",
        "daily_allowance": "<string>",
        "distance_amount": "<string>",
        "foreman_allowance": "<string>",
        "nightly_allowance": "<string>",
        "parking_fees": "<string>",
        "travel_allowance_personal": "<string>"
      },
      "arrival_load_location": "2023-11-07T05:31:56Z",
      "arrival_unload_location": "2023-11-07T05:31:56Z",
      "at_same_time": 123,
      "buyer_custom_name": "<string>",
      "buyer_id": 123,
      "capacity_plan_capacity_id": 123,
      "capacity_plan_id": 123,
      "client_custom_name": "<string>",
      "client_id": 123,
      "color": "<string>",
      "components": [
        {
          "amount": "<string>",
          "material_custom_name": "<string>",
          "material_id": 123,
          "unit_custom_name": "<string>",
          "unit_id": 123
        }
      ],
      "conceptdate": "2023-11-07T05:31:56Z",
      "confirmed": 123,
      "confirmed_date": "2023-12-25",
      "coordinates": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_id": 123,
      "created_by_type": "<string>",
      "custom_status1": 123,
      "custom_status2": 123,
      "customfield1": "<string>",
      "customfield2": "<string>",
      "customfield3": "<string>",
      "customfield4": "<string>",
      "customfield5": "<string>",
      "date": "2023-12-25",
      "debits": [
        {
          "amount": "<string>",
          "expense_custom_name": "<string>",

Autorisaties

X-API-Keystringheaderverplicht

Body

Task object.

additionalworkobject[]

The extra work (meerwerk) lines of this task.

child attributes tonen

administration_idinteger

The administration ID of this task.

amount_amountstring

The quantity of the main quantity line, as a numeric string.

amount_custom_namestring

A custom name, used when amount_id is zero (0).

amount_idinteger

The material (artikel) ID of the main quantity (aantallen) line.

amount_unit_custom_namestring

A custom unit name, used when amount_unit_id is zero (0).

amount_unit_idinteger

The unit (eenheid) ID of the main quantity line.

amountsobject[]

Additional quantity (aantallen) lines of this task.

child attributes tonen

arrangementsobject

The allowances (regelingen) of the employee on this task.

child attributes tonen

arrival_load_locationstring

The date and time of arrival at the loading location.

arrival_unload_locationstring

The date and time of arrival at the unloading location.

at_same_timeinteger

Whether the main vehicle is used for the entire task. Returned as 1 (yes) or 0 (no).

buyer_custom_namestring

A custom buyer name, used when buyer_id is zero (0).

buyer_idinteger

The buyer (afnemer) client ID for unloading.

capacity_plan_capacity_idinteger

The ID of the capacity plan capacity this task is planned on.

capacity_plan_idinteger

The ID of the capacity plan (capaciteitsplanning) of this task.

client_custom_namestring

A custom client name, used when client_id is zero (0).

client_idinteger

The client (klant) ID.

colorstring

The color of this task on the planboard, as a hexadecimal color code.

componentsobject[]

Additional materials (artikelen) used on this task.

child attributes tonen

conceptdatestring

The draft date of this task while it is not scheduled, which is also the start of the work inventory period.

confirmedinteger

Whether this task is confirmed. Returned as 1 (yes) or 0 (no).

confirmed_datestring

The date this task was confirmed.

coordinatesstring

The coordinates of the location of this task, as latitude and longitude.

created_atstring

The date and time this task was created.

created_by_idinteger

The ID of the backend user or user who created this task.

created_by_typestring

The type of who created this task, either 'backend_user' or 'user'.

custom_status1integer

Whether the first custom status of this task is set. Returned as 1 (yes) or 0 (no).

custom_status2integer

Whether the second custom status of this task is set. Returned as 1 (yes) or 0 (no).

customfield1string

The first additional field of this task.

customfield2string

The second additional field of this task.

customfield3string

The third additional field of this task.

customfield4string

The fourth additional field of this task.

customfield5string

The fifth additional field of this task.

datestring

The date of this task, derived from start_time.

debitsobject[]

Additional expenses (kosten) for this task.

child attributes tonen

deleted_atstring

The date and time this task was deleted; empty when it is not deleted.

departure_load_locationstring

The date and time of departure from the loading location.

departure_unload_locationstring

The date and time of departure from the unloading location.

descriptionstring

The description of this task.

distancesobject[]

Additional vehicles (voertuigen) for the first vehicle slot of this task.

child attributes tonen

distances2object[]

Additional vehicles (voertuigen) for the second vehicle slot of this task.

child attributes tonen

distances3object[]

Additional vehicles (voertuigen) for the third vehicle slot of this task.

child attributes tonen

drawee_custom_namestring

A custom drawee name, used when drawee_id is zero (0).

drawee_idinteger

The drawee (betrokkene) client ID.

end_mileageinteger

The mileage of the main vehicle at the end of the task.

end_timestringverplicht

The date and time this task ends.

entryobject

The entry (planning) this task is scheduled on, including its user; empty when the task is unassigned work.

child attributes tonen

entry_idinteger

The ID of the entry (planning) this task is scheduled on; empty when the task is unassigned work.

expense_amountstring

The amount of the main expense in euros, as a numeric string.

expense_custom_namestring

A custom expense name, used when expense_id is zero (0).

expense_idinteger

The main expense (kosten) ID.

external_idsobject

The IDs of this task in connected third party applications, keyed by connection.

extrawork_custom_namestring

A custom extrawork name, used when extrawork_id is zero (0).

extrawork_idinteger

The extrawork (bedrijfswerkzaamheid) operation ID.

finishedinteger

Whether this task is finished, which also marks it as processed and invoiced. Returned as 1 (yes) or 0 (no).

from_portalinteger

Whether this task was created in the portal. Returned as 1 (yes) or 0 (no).

group_identifierstring

The identifier shared by tasks that are grouped together.

has_readinteger

Whether the employee has read this task in the app. Returned as 1 (yes) or 0 (no).

has_sentinteger

Whether this task has been sent to the app of the employee. Returned as 1 (yes) or 0 (no).

hours_standinteger

The hour meter reading (urenstand) of the main vehicle.

idintegerverplicht

The task (bon) ID.

identifierstring

A unique identifier (UUID) of this task.

internal_descriptionstring

The internal description of this task, not shown to the client.

invoice_itemsobject[]

The sales invoice items of this task.

child attributes tonen

invoicedinteger

Whether this task is invoiced. Returned as 1 (yes) or 0 (no).

invoiced_timestring

A legacy invoice timestamp that is no longer filled.

klic_linksobject[]

KLIC notifications and other links of this task.

child attributes tonen

last_edited_byinteger

The ID of the backend user who last edited this task.

load_amountstring

The loaded quantity, as a numeric string.

load_coordinatesstring

The coordinates of the loading location.

load_locationstring

The name or address of the loading location.

load_location_idinteger

The ID of the saved location used as loading location.

load_material_custom_namestring

A custom material name, used when load_material_id is zero (0).

load_material_idinteger

The material (artikel) ID that is loaded.

load_referencestring

The reference of the loading location.

load_storage_numberstring

The storage number (opslagnummer) at the loading location.

load_unit_custom_namestring

A custom unit name, used when load_unit_id is zero (0).

load_unit_idinteger

The unit (eenheid) ID of the loaded quantity.

load_unload_customfield1string

An additional field for loading and unloading.

loading_unloadingobject[]

Additional loading and unloading rows of this task.

child attributes tonen

locationstring

The name or address of the location where this task takes place.

locationsobject[]

Additional locations of this task.

child attributes tonen

logbookobject[]

The logbook of this task, with an entry for every creation and change.

child attributes tonen

man_day_idinteger

The ID of the man-day statement (mandagenstaat) this task is on.

manure_codestring

The manure code (mestcode) of this task.

manure_codesobject[]

Additional manure codes (mestcodes) of this task.

child attributes tonen

material_amountstring

The quantity of the main material, as a numeric string.

material_custom_namestring

A custom material name, used when material_id is zero (0).

material_idinteger

The main material (artikel) ID.

material_unit_custom_namestring

A custom unit name, used when material_unit_id is zero (0).

material_unit_idinteger

The unit (eenheid) ID of the main material.

operating_hoursstring

The operating hours (draaiuren) of the main vehicle, as a duration in the time part of the value.

operation_amountstring

A readable summary of all operation quantities of this task, generated from operation_amounts, operations and users.

operation_amountsobject[]

The quantities per rate line for the main operation.

child attributes tonen

operation_category_idinteger

The operation category ID of the main operation.

operation_custom_namestring

A custom operation name, used when operation_id is zero (0).

operation_idinteger

The main operation (werkzaamheid) ID.

operationsobject[]

Extra operations (werkzaamheden) for this task.

child attributes tonen

order_idinteger

The ID of the order (project) connected to this task.

ordernumberstring

The order number of this task.

parent_idinteger

The ID of the parent task this task is linked to.

part_amountstring

The quantity of the main part, as a numeric string.

part_custom_namestring

A custom part name, used when part_id is zero (0).

part_idinteger

The main part (onderdeel) ID.

part_unit_custom_namestring

A custom unit name, used when part_unit_id is zero (0).

part_unit_idinteger

The unit (eenheid) ID of the main part.

partsobject[]

Additional parts (onderdelen) used on this task.

child attributes tonen

pause_timeinteger

The pause time of this task in minutes.

pause_timesobject[]

The individual pause periods of this task.

child attributes tonen

pricelist_idinteger

The price list (prijslijst) ID used for this task.

pricing_zone_double_calculate_transportinteger

Whether the rate zone is calculated twice for transport. Returned as 1 (yes) or 0 (no).

pricing_zone_idinteger

The rate zone (tariefzone) ID of this task.

pricing_zone_lockedinteger

Whether the rate zone is locked, so it is not recalculated. Returned as 1 (yes) or 0 (no).

pricing_zone_pricestring

A custom rate zone price in euros. Returned as a numeric string, e.g. "12.50".

processedinteger

Whether this task is processed. Returned as 1 (yes) or 0 (no).

processed_timestring

A legacy processing timestamp that is no longer filled.

range_end_datestring

The end date of the work inventory period of this task.

referencestring

The reference of the location of this task.

repair_timeinteger

The repair time of this task in minutes.

repair_timesobject[]

The individual repair periods of this task.

child attributes tonen

repeatsinteger

The number of times this task is to be scheduled.

row_idstring

The identifier of the plan row this task belongs to; tasks with the same row_id are planned as one row.

send_changesinteger

Whether changes to this task still have to be mailed to the hired employee. Returned as 1 (yes) or 0 (no).

sent_by_mailinteger

Whether this task was sent by mail. Returned as 1 (yes) or 0 (no).

sign_off_sheet_idinteger

The ID of the sign-off sheet (aftekenlijst) this task is on.

start_mileageinteger

The mileage of the main vehicle at the start of the task.

start_timestringverplicht

The date and time this task starts.

storage_numberinteger

The storage number (opslagnummer) of this task.

subcontractor_custom_emailstring

The email address of a custom subcontractor, used when subcontractor_id is zero (0).

subcontractor_custom_namestring

The name of a custom subcontractor, used when subcontractor_id is zero (0).

subcontractor_custom_phonestring

The phone number of a custom subcontractor, used when subcontractor_id is zero (0).

subcontractor_idinteger

The subcontractor (uitvoerder) ID.

suborder_custom_namestring

A custom suborder name, used when suborder_id is zero (0).

suborder_idinteger

The ID of a single legacy suborder (subproject) of this task.

subuser_idinteger

The hired employee (inhuurmedewerker) ID of this task.

supplier_custom_namestring

A custom supplier name, used when supplier_id is zero (0).

supplier_idinteger

The supplier (leverancier) client ID for loading.

timer_is_runninginteger

Whether the app timer of this task is running. Returned as 1 (yes) or 0 (no).

timer_start_timestring

The date and time the app timer was started.

timer_typestring

The type of time the app timer is tracking, either 'work_time', 'pause_time', 'travel_time', 'travel_time_start', 'travel_time_end', 'travel_time_machine', 'repair_time' or 'wait_time'.

travel_timeinteger

The travel time of this task in minutes.

travel_time_machinestring

The travel time of the vehicle (reistijd voertuig), as a duration in the time part of the value.

travel_timesobject[]

The individual travel periods of this task.

child attributes tonen

typestringverplicht

The task type (bonsoort) of this task, which is the slug_single of a task type.

unload_amountstring

The unloaded quantity, as a numeric string.

unload_coordinatesstring

The coordinates of the unloading location.

unload_locationstring

The name or address of the unloading location.

unload_location_idinteger

The ID of the saved location used as unloading location.

unload_referencestring

The reference of the unloading location.

unload_storage_numberstring

The storage number (opslagnummer) at the unloading location.

updated_atstring

The date and time this task was last updated.

user_group_idinteger

The user group ID of this task.

usersobject[]

Extra employees on this task; every row holds the same kind of time, operation, vehicle and material fields as the task itself.

child attributes tonen

vehicle2_amountstring

The distance driven with the second vehicle in kilometers, as a numeric string.

vehicle2_amountsobject[]

The quantities per rate line for the second vehicle.

child attributes tonen

vehicle2_at_same_timeinteger

Whether the second vehicle is used for the entire task. Returned as 1 (yes) or 0 (no).

vehicle2_custom_namestring

A custom vehicle name, used when vehicle2_id is zero (0).

vehicle2_end_mileageinteger

The mileage of the second vehicle at the end of the task.

vehicle2_hours_standinteger

The hour meter reading (urenstand) of the second vehicle.

vehicle2_idinteger

The second vehicle (voertuig) ID.

vehicle2_operating_hoursstring

The operating hours (draaiuren) of the second vehicle, as a duration in the time part of the value.

vehicle2_start_mileageinteger

The mileage of the second vehicle at the start of the task.

vehicle3_amountstring

The distance driven with the third vehicle in kilometers, as a numeric string.

vehicle3_amountsobject[]

The quantities per rate line for the third vehicle.

child attributes tonen

vehicle3_at_same_timeinteger

Whether the third vehicle is used for the entire task. Returned as 1 (yes) or 0 (no).

vehicle3_custom_namestring

A custom vehicle name, used when vehicle3_id is zero (0).

vehicle3_end_mileageinteger

The mileage of the third vehicle at the end of the task.

vehicle3_hours_standinteger

The hour meter reading (urenstand) of the third vehicle.

vehicle3_idinteger

The third vehicle (voertuig) ID.

vehicle3_operating_hoursstring

The operating hours (draaiuren) of the third vehicle, as a duration in the time part of the value.

vehicle3_start_mileageinteger

The mileage of the third vehicle at the start of the task.

vehicle_amountstring

The distance driven with the main vehicle in kilometers, as a numeric string.

vehicle_amountsobject[]

The quantities per rate line for the main vehicle.

child attributes tonen

vehicle_custom_namestring

A custom vehicle name, used when vehicle_id is zero (0).

vehicle_idinteger

The main vehicle (voertuig) ID.

versioninteger

The version number of this task, raised by one on every save.

wait_timeinteger

The wait time of this task in minutes.

wait_timesobject[]

The individual wait periods of this task.

child attributes tonen

weatherstring

A JSON string with the weather forecast for this task, holding temperature, humidity, wind_speed, precipitation_chance, condition, icon, forecast_time and forecast_location.

work_descriptionstring

The work description of this task.

work_inventory_idinteger

The work inventory (werkvoorraad) ID of this task.

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