vehicles

Add a new vehicle to the database.

POST

/vehicle

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/vehicle \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apk": "2023-12-25",
  "ascription": "2023-12-25",
  "barcode": "<string>",
  "bpm": "<string>",
  "brand": "<string>",
  "builddate": "2023-12-25",
  "categories": [
    {
      "code": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "sort_order": 123
    }
  ],
  "client_id": 123,
  "code": "<string>",
  "color": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "default_operation_category_id": 123,
  "default_operation_id": 123,
  "default_subuser_id": 123,
  "default_user_id": 123,
  "deleted_at": "2023-11-07T05:31:56Z",
  "depreciation": 123,
  "descriptions": [
    {
      "added_by": "<string>",
      "date": "<string>",
      "description": "<string>"
    }
  ],
  "discount": "<string>",
  "external_ids": {},
  "extra_data": {},
  "id": 123,
  "insured": 123,
  "is_banned_from_zero_emission_zones": 123,
  "is_internal_vehicle": 123,
  "licenseplate": "<string>",
  "manure_transport_key": "<string>",
  "manure_transport_type": "<string>",
  "max_mass": "<string>",
  "mileage": 123,
  "mileages": [
    {
      "added_by": "<string>",
      "date": "<string>",
      "mileage": 123
    }
  ],
  "name": "<string>",
  "operating_hours": "<string>",
  "operating_hours_rep": [
    {
      "added_by": "<string>",
      "date": "<string>",
      "operating_hours": 123
    }
  ],
  "price": "<string>",
  "price_per": "<string>",
  "rdwdata": "<string>",
  "sort_order": 123,
  "stock": 123,
  "tiers": [
    {}
  ],
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_group_id": 123,
  "vehicle_number": "<string>",
  "vehicle_type": 123
}
'

{
  "data": {
    "result": "<string>",
    "vehicle": {
      "apk": "2023-12-25",
      "ascription": "2023-12-25",
      "barcode": "<string>",
      "bpm": "<string>",
      "brand": "<string>",
      "builddate": "2023-12-25",
      "categories": [
        {
          "code": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>",
          "sort_order": 123
        }
      ],
      "client_id": 123,
      "code": "<string>",
      "color": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "default_operation_category_id": 123,
      "default_operation_id": 123,
      "default_subuser_id": 123,
      "default_user_id": 123,
      "deleted_at": "2023-11-07T05:31:56Z",
      "depreciation": 123,
      "descriptions": [
        {
          "added_by": "<string>",
          "date": "<string>",
          "description": "<string>"
        }
      ],
      "discount": "<string>",
      "external_ids": {},
      "extra_data": {},
      "id": 123,
      "insured": 123,
      "is_banned_from_zero_emission_zones": 123,
      "is_internal_vehicle": 123,
      "licenseplate": "<string>",
      "manure_transport_key": "<string>",
      "manure_transport_type": "<string>",
      "max_mass": "<string>",
      "mileage": 123,
      "mileages": [
        {
          "added_by": "<string>",
          "date": "<string>",
          "mileage": 123
        }
      ],
      "name": "<string>",
      "operating_hours": "<string>",
      "operating_hours_rep": [
        {
          "added_by": "<string>",
          "date": "<string>",
          "operating_hours": 123
        }
      ],
      "price": "<string>",
      "price_per": "<string>",
      "rdwdata": "<string>",
      "sort_order": 123,
      "stock": 123,
      "tiers": [
        {}
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_group_id": 123,
      "vehicle_number": "<string>",
      "vehicle_type": 123
    }
  },
  "status": "<string>"

Autorisaties

X-API-Keystringheaderverplicht

Body

Vehicle object.

apkstring

The expiry date of the MOT (APK) of this vehicle.

ascriptionstring

The registration date (datum tenaamstelling) of this vehicle.

barcodestring

The barcode of this vehicle.

bpmstring

The gross BPM (Dutch vehicle tax) of this vehicle, as a numeric string.

brandstring

The make of this vehicle, filled from the RDW when a license plate is set.

builddatestring

The date of manufacture (first admission) of this vehicle.

categoriesobject[]

The categories of this vehicle.

child attributes tonen

client_idinteger

The ID of the client (klant) this vehicle belongs to when it is not from the own company.

codestring

The unique code of this vehicle, generated from the name when left empty.

colorstring

The color of this vehicle.

created_atstring

The date and time this vehicle was created.

default_operation_category_idinteger

The ID of the default operation category of this vehicle.

default_operation_idinteger

The ID of the default operation of this vehicle.

default_subuser_idinteger

The ID of the default subuser of this vehicle.

default_user_idinteger

The ID of the default employee of this vehicle.

deleted_atstring

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

depreciationinteger

The depreciation period of this vehicle in years.

descriptionsobject[]

The descriptions logged for this vehicle.

child attributes tonen

discountstring

The legacy discount of this vehicle, as a numeric string. Rates are managed through pricings.

external_idsobject

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

extra_dataobject

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

idintegerverplicht

The ID of this vehicle.

insuredinteger

Whether this vehicle is third-party insured. Returned as 1 (yes) or 0 (no).

is_banned_from_zero_emission_zonesinteger

Whether this vehicle is not allowed in zero-emission zones. Returned as 1 (yes) or 0 (no).

is_internal_vehicleinteger

Whether this vehicle is from the own company. Returned as 1 (yes) or 0 (no).

licenseplatestring

The license plate of this vehicle.

manure_transport_keystring

The GR/GPS identification of this vehicle: the serial or combination number it reports to rVDM under.

manure_transport_typestring

The means of transport of this vehicle as reported to rVDM.

max_massstring

The maximum permitted mass of this vehicle, as a numeric string.

mileageinteger

The mileage of this vehicle.

mileagesobject[]

The mileage readings logged for this vehicle.

child attributes tonen

namestringverplicht

The name of this vehicle.

operating_hoursstring

The operating hours of this vehicle.

operating_hours_repobject[]

The operating hour readings logged for this vehicle.

child attributes tonen

pricestring

The legacy price of this vehicle, as a numeric string. Rates are managed through pricings.

price_perstring

The legacy price unit of this vehicle. Rates are managed through pricings.

rdwdatastring

The vehicle registration data retrieved from the RDW for the license plate, as a JSON-encoded string.

sort_orderinteger

The position of this vehicle in sorted lists.

stockinteger

The stock of this vehicle.

tiersobject[]

The legacy price tiers of this vehicle. Rates are managed through pricings.

typestring

The vehicle kind (voertuigsoort), filled from the RDW when a license plate is set.

updated_atstring

The date and time this vehicle was last updated.

user_group_idinteger

The ID of the user group this vehicle belongs to.

vehicle_numberstring

The serial number of this vehicle.

vehicle_typeinteger

Which vehicle kind this is, either 1 (vehicle), 2 (vehicle2) or 3 (vehicle3).

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