orders

Find a single order by ID.

GET

/order/{orderId}

curl --request GET \
  --url https://api-sandbox.timeking.nl/api/external/v1/order/{orderId} \
  --header 'X-API-Key: <api-key>'

{
  "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

Padparameters

orderIdstringverplicht

The id of the order to perform the action on.

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