Company car

Edit the details of a company car record

Activity name: <a href="https://developer.loket.nl/Activities/PutCompanyCarByCompanyCarId" target="_blank">PutCompanyCarByCompanyCarId</a>

Edit the details for a company car record.

Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.

put/v2/providers/employers/employees/employments/companycars/{companyCarId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/companycars/{companyCarId}
  • Auth
    none required

Path parameters

companyCarIdstring uuid required

The unique identifier of the company car

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

The start date of the entity.

endDatestring date nullable

The end date of the entity. The date is up to and including.

brandstring nullable

Brand of the vehicle.

modelstring nullable

Model of the vehicle.

licensePlateNumberstring

Vehicle registration number (license plate) of the company car. The number should be provided with or without any hyphens (-).

fuelCardNumberstring nullable

Registration number of the fuel card.

supplierstring nullable

Name of the company the delivered the company car.

catalogValuenumber double nullable

The catalog value of the car.

kilometersPrivateUseinteger nullable

The number kilometers per year the employee can use the car for private purposes.

commentsstring nullable

Any comments on the car or the contract.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2021-01-01",
  "endDate": "2023-10-23",
  "brand": "Volvo",
  "model": "V60",
  "licensePlateNumber": "GP586D",
  "fuelCardNumber": "B100.323.903",
  "leaseOrBuy": {
    "key": 1,
    "value": "Koop"
  },
  "supplier": "Leasemaatschappij Tilburg",
  "lease": {
    "startDate": "2021-01-01",
    "endDate": "2023-10-23",
    "contractNumber": "2021.323.903"
  },
  "catalogValue": 20000,
  "kilometersPrivateUse": 10000,
  "comments": "This car is very nice"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "startDate": "2021-01-01",
    "endDate": "2023-10-23",
    "brand": "Volvo",
    "model": "V60",
    "licensePlateNumber": "GP586D",
    "fuelCardNumber": "B100.323.903",
    "leaseOrBuy": {
      "key": 1,
      "value": "Koop"
    },
    "supplier": "Leasemaatschappij Tilburg",
    "lease": {
      "startDate": "2021-01-01",
      "endDate": "2023-10-23",
      "contractNumber": "2021.323.903"
    },
    "catalogValue": 20000,
    "kilometersPrivateUse": 10000,
    "comments": "This car is very nice"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.