orders

Add a new order to the database.

POST

/order

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/order \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_daily_allowance": 123,
  "allow_nightly_allowance": 123,
  "allow_travel_time": 123,
  "budgetted_hours": 123,
  "budgetted_money": "<string>",
  "categories": [
    {
      "always_visible": 123,
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "sort_order": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "client_id": 123,
  "coordinates": "<string>",
  "copy_media": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "date": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": 123,
  "description": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "extra_data": {},
  "id": 123,
  "invoice_type": "<string>",
  "klic_links": [
    {
      "klic_link": "<string>"
    }
  ],
  "location": "<string>",
  "logbook": [
    {
      "comment": "<string>",
      "status": "<string>"
    }
  ],
  "name": "<string>",
  "number": "<string>",
  "order_reference": "<string>",
  "pricing_zone_id": 123,
  "quote_id": 123,
  "reference": "<string>",
  "revenue_settled": true,
  "sort_order": 123,
  "start_time": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "subcontractor_custom_name": "<string>",
  "subcontractor_id": 123,
  "suborders": [
    {
      "active": true,
      "coordinates": "<string>",
      "description": "<string>",
      "id": 123,
      "location": "<string>",
      "name": "<string>",
      "number": "<string>",
      "order_id": 123,
      "subcontractor_id": 123
    }
  ],
  "task_color": "<string>",
  "travel_time_default_minutes": 123,
  "travel_time_invoice": 123,
  "travel_time_pricing_id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": 123,
  "user_group_id": 123,
  "user_id": 123
}
'

{
  "data": {
    "order": {
      "allow_daily_allowance": 123,
      "allow_nightly_allowance": 123,
      "allow_travel_time": 123,
      "budgetted_hours": 123,
      "budgetted_money": "<string>",
      "categories": [
        {
          "always_visible": 123,
          "code": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "id": 123,
          "name": "<string>",
          "sort_order": 123,
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "client_id": 123,
      "coordinates": "<string>",
      "copy_media": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": 123,
      "date": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": 123,
      "description": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "extra_data": {},
      "id": 123,
      "invoice_type": "<string>",
      "klic_links": [
        {
          "klic_link": "<string>"
        }
      ],
      "location": "<string>",
      "logbook": [
        {
          "comment": "<string>",
          "status": "<string>"
        }
      ],
      "name": "<string>",
      "number": "<string>",
      "order_reference": "<string>",
      "pricing_zone_id": 123,
      "quote_id": 123,
      "reference": "<string>",
      "revenue_settled": true,
      "sort_order": 123,
      "start_time": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "subcontractor_custom_name": "<string>",
      "subcontractor_id": 123,
      "suborders": [
        {
          "active": true,
          "coordinates": "<string>",
          "description": "<string>",
          "id": 123,
          "location": "<string>",
          "name": "<string>",
          "number": "<string>",
          "order_id": 123,
          "subcontractor_id": 123
        }
      ],
      "task_color": "<string>",
      "travel_time_default_minutes": 123,
      "travel_time_invoice": 123,
      "travel_time_pricing_id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": 123,
      "user_group_id": 123,
      "user_id": 123
    },

Autorisaties

X-API-Keystringheaderverplicht

Body

Order object.

allow_daily_allowanceinteger

Whether a daily allowance can be registered on this order. Returned as 1 (yes) or 0 (no).

allow_nightly_allowanceinteger

Whether a night allowance can be registered on this order. Returned as 1 (yes) or 0 (no).

allow_travel_timeinteger

Whether travel time can be registered on this order. Returned as 1 (yes) or 0 (no).

budgetted_hoursinteger

The budgeted number of hours for this order.

budgetted_moneystring

The budgeted amount in euros for this order, as a numeric string.

categoriesobject[]

The order categories this order belongs to.

child attributes tonen

client_idinteger

The ID of the client this order is for.

coordinatesstring

The coordinates of the main location of this order as 'latitude,longitude'.

copy_mediainteger

Whether the media of this order is copied to new tasks of this order. Returned as 1 (yes) or 0 (no).

created_atstring

The date and time this order was created.

created_byinteger

The ID of the backend user that created this order, or 0 when it was created without one.

datestring

The start date of this order, as a date-time at midnight.

deleted_atstring

The date and time this order was archived, or null when it is active.

deleted_byinteger

The ID of the backend user that archived this order.

descriptionstring

The description of this order.

end_datestring

The end date of this order, as a date-time at midnight, set automatically when the order is finished.

end_timestring

The end time of this order.

extra_dataobject

The values of the custom fields, keyed by custom field code.

idintegerverplicht

The ID of this order (project).

invoice_typestring

The payment type of this order, either 'none', 'prepaid', 'recalculation' or 'fixed_price'.

klic_linksobject[]

The KLIC notification links and other links of this order, copied to its tasks.

child attributes tonen

locationstring

The name of the main location of this order.

logbookobject[]

The status history of this order.

child attributes tonen

namestring

The name of this order.

numberstring

The order number of this order, generated from the configured number structure when left empty.

order_referencestring

The reference of this order, such as the client's own project reference.

pricing_zone_idinteger

The ID of the pricing zone of this order.

quote_idinteger

The ID of the quote this order was created from.

referencestring

The reference of the main location of this order.

revenue_settledboolean

Whether the revenue of this fixed-price order has been settled in the connected accounting application.

sort_orderinteger

The sort order of this order.

start_timestring

The start time of this order.

statusstring

The status of this order, either 'quotation', 'in-progress', 'finished' or 'invoiced'.

subcontractor_custom_namestring

The name of the subcontractor when it is not one of the client's subcontractors.

subcontractor_idinteger

The ID of the subcontractor of this order.

subordersobject[]

The suborders of this order.

child attributes tonen

task_colorstring

The hex color used for the tasks of this order, e.g. '#e67e22'.

travel_time_default_minutesinteger

The default travel time in minutes for this order.

travel_time_invoiceinteger

Whether travel time on this order is invoiced. Returned as 1 (yes) or 0 (no).

travel_time_pricing_idinteger

The ID of the pricing used to invoice travel time on this order, or 0 when none is set.

updated_atstring

The date and time this order was last updated.

updated_byinteger

The ID of the backend user that last updated this order, or 0 when it was updated without one.

user_group_idinteger

The ID of the user group of this order.

user_idinteger

The ID of the backend user responsible for this order, defaulting to the user that created it.

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