Create lease contract

Request

POST http:///fleet.roadprotect.co.il/api/v1/lease-contract

Request body

The request body takes a complete CreateLeaseContractDto resource, containing the following writable properties:

{
    "document": "number",
    "endDate": "string",
    "owner": "string",
    "reference": "string",
    "startDate": "string",
    "user": "string",
    "vehicle": "string"
}

Properties

Name Type Description Additional
document number

The lease contract documentId

 Optional
endDate string

The lease contract end date

 Optional
owner string

The lease contract owner BRN
reference string

An optional reference Id for linking to batch file upload or your system Id

 Optional
startDate string

The lease contract start date
user string

The lease contract user BRN
vehicle string

The lease contract vehicle registration

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created LeaseContract
400 Bad Request
  • E026: Account with identifier accountIdentifier not found
  • E038: Provided contract dates overlap with existing contract(s)
  • E044: Could not find Document with id: documentId
  • E049: Could not find Vehicle with registration registration
  • E050: Contract with id contractId not found
500 Internal Server Error

Failed to create lease contract, please contact the developers.