Please enable JavaScript to view this site.

Navigation: Schema: CompanyCar > Tables

CompanyCarByCompanyCarId

Details of a company car record__Activity name:__ GetCompanyCarByCompanyCarIdGet the details of a company car 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.

Catalog: LoketNlRest

Schema: CompanyCar

This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.

Select loket.nl (REST) API URL: /providers/employers/employees/employments/companycars/{companyCarId}

Insert loket.nl (REST) API URL: /providers/employers/employees/employments/companycars/{companyCarId}

Update loket.nl (REST) API URL: /providers/employers/employees/employments/companycars/{companyCarId}

Delete loket.nl (REST) API URL: /providers/employers/employees/employments/companycars/{companyCarId}

Field Selection Method: NotRequired

Base Path: content

Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/companycars/{companyCarId}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CompanyCarByCompanyCarId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

companyCarId

guid

 

The unique identifier of the company car

 

Table Function Columns

The columns of the table function CompanyCarByCompanyCarId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

brand

string

 

Brand of the vehicle.

catalogValue

double

 

The catalog value of the car.

comments

string

 

Any comments on the car or the contract.

endDate

datetime

 

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

fuelCardNumber

string

 

Registration number of the fuel card.

id

guid

 

The unique identifier of an object (GUID/UUID)

kilometersPrivateUse

int32

 

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

lease_contractNumber

string

 

Registration number of the lease contract.

lease_endDate

datetime

 

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

lease_startDate

datetime

 

The start date of the entity.

leaseOrBuy_key

int32

 

 

leaseOrBuy_value

string

 

 

licensePlateNumber

string(8)

 

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

model

string

 

Model of the vehicle.

startDate

datetime

 

The start date of the entity.

supplier

string

 

Name of the company the delivered the company car.

 

25-05-2022 14:15 Version 22.1.46-BETA+3385