Contract resource

Methods

  • delete - Delete contract by contractId
  • get - Get contract (either lease / ownership) by contractId
  • get - Get contracts for a vehicle by vehicleId
  • post - Update contract end date
  • post - Update contract end date by reference
  • post - Update contract reference by contractId
  • get - Query and filter contracts

Resource

{
    "contractId": "number",
    "createdAt": "string",
    "document": {},
    "endDate": "string",
    "infringements": {},
    "owner": {},
    "redirectionTargetAddress": "string",
    "reference": "string",
    "startDate": "string",
    "status": "string",
    "type": "string",
    "updatedAt": "string",
    "vehicle": {}
}

Properties

Name Type Description Additional
contractId number
createdAt string
document object

Document
endDate string
infringements object

Infringement[]
owner object

Account
redirectionTargetAddress string

This is a calculated field
reference string
startDate string
status string

Possible values are:

  • Upcoming
  • Expired
  • Expiring soon
  • Valid
type string
updatedAt string
vehicle object

Vehicle