Changelog Version 2
Added damage service request support
2025-03-26
Added several endpoints to accommodate the creation and modification of damage service requests. These endpoints can be used to do everything you can already do for a service request.
For more detailed information, see damage service requests documentation.
The following features have been ADDED:
- GET /v2/damageservicerequests
- POST /v2/damageservicerequests
- GET /v2/damageservicerequests/{id}
- DELETE /v2/damageservicerequests/{id}
- PATCH /v2/damageservicerequests/{id}
- PUT /v2/damageservicerequests/{id}
- PUT /v2/damageservicerequests/{id}/attachments
- DELETE /v2/damageservicerequests/{id}/attachments/{attachmentId}
- GET /v2/damageservicerequests/{id}/attachments
- GET /v2/damageservicerequests/{id}/attachments/{attachmentId}
- GET /v2/damageservicerequests/{id}/invoices
- POST /v2/damageservicerequests/{id}/invoices
- GET /v2/damageservicerequests/{id}/invoices/{invoiceId}
- PUT /v2/damageservicerequests/{id}/invoices/{invoiceId}/pdf
- GET /v2/damageservicerequests/{id}/invoices/{invoiceId}/pdf
- POST /v2/damageservicerequests/{id}/invoices/status
- GET /v2/damageservicerequests/{id}/invoicetemplates
- PUT /v2/damageservicerequests/{id}/components/{componentId}
- DELETE /v2/damageservicerequests/{id}/components/{componentId}
- POST /v2/damageservicerequests/{id}/components/{componentId}/cancel
- GET /v2/damagecomponents
- GET /v2/contracts/:licensePlate/damagecomponents
- GET /v2/lessors/{lessorId}/contracts/{licensePlate}/damagecomponents
Added support for attachments to service request endpoint
2025-03-26
The following endpoints have been added to support retrieving, adding, and deleting attachments of service requests
For more detailed information, see attachments documentation.
The following features have been ADDED:
- GET /v2/servicerequests/{id}/attachments/{attachmentId}
- GET /v2/servicerequests/{id}/attachments
- PUT /v2/servicerequests/{id}/attachments
- DELETE /v2/servicerequests/{id}/attachments/{attachmentId}
Lessor notifications
2025-03-26
The following endpoint has been added to retrieve lessor notifications that are relevant to the requesting supplier.
For more detailed information, see notifications documentation.
The following features have been ADDED:
- GET /v2/lessors/notifications
Rental Vehicles
2025-03-26
The following endpoint has been added to retrieve rental vehicle class and details.
For more detailed information, see rental vehicle documentation.
The following features have been ADDED:
- GET /v2/rentalvehicle/{licenseplate}
Extend contract details
2025-02-17
The following fields have been added to the output of the contract methods:
- vehicle.secondaryFuelType: this optional field will be present for vehicles utilizing multiple fuels, for example plug in hybrid cars.
- leaseContract.startDate: the start date of the contract.
- leaseContract.tires.remarks: remarks for a tires service request.
- leaseContract.damage.remarks: remarks for a damage service request.
- leaseContract.tires.contractTireSpecifications: an optional set of tire specifications which the lessor expects to be adhered to when acquiring the first set of tires.
- supplierContract.damage.allowed: indicates whether damage service request are allowed.
- supplierContract.damage.firstDebitInvoiceRequiresCreditDiscountInvoice: indicates whether the first debit invoice requires a discount credit invoice.
The following features have been CHANGED:
- GET /v2/contracts/{licensePlate}
- GET /v2/lessors/{lessorId}/contracts/{licensePlate}
Warranty and the service request invoice status
2024-01-18
When all the lines of a service request are under warranty the amount to invoice is always zero. The endpoints listed below will reflect this by returning the invoice status WillNotBeInvoicedForWarrantyOrLeniencyReasons for the field invoicing.status in their responses.
-
The following features have been CHANGED:
- GET /v2/serviceRequests
- GET /v2/serviceRequests/{serviceRequestId}
Rate limiting
2023-08-07
An HTTP request limit of 5000 requests per minute has been added. Any requests submitted after this limit has been reached will be met with an HTTP 429 (Too Many Requests) response.
Validation on Invoice date
2023-07-21
A new invoice validation has been introduced that validates the invoice date. In case of an unarchived service request, the invoice date must be equal be greater than or equal to the workshop/checkout date of the service request. In case of an archived service request, the invoice date must be equal to the invoice date of the latest processed invoice. If such an invoice is sent, the API returns a 400 (Bad Request) with a specific error code:
- ROB-INV000105 - Invoicing a service request
- ROB-INV000106 - Invoicing a rental vehicle request
- ROB-INV000107 - Invoicing an archived service request
The following features have been CHANGED:
- POST /servicerequests/{id}/invoices
New Reason Code 38 (Dried Out)
2023-05-05
The new reason code 38 - Dried Out can be used with seasonal tire swaps (3199) and tire replacements (3198).
For seasonal tire swaps (3199) it can be used as reason with the following subcomponents:
- Disposed tire from storage
- Disposed unmounted tire
For tire replacements (3198) it can be used as reason with the following subcomponents:
- Disposed unmounted tire
The following features have been CHANGED:
-
The response of the following methods may contain subcomponents with the new reason code:
- GET /v2/components
- GET /v2/contracts/{licensePlate}/components
- GET /v2/lessors/{lessorId}/contracts/{licensePlate}/components
- GET /v2/servicerequests/{serviceRequestId}
-
The requests of the following methods may use subcomponents with the new reason code:
- POST /v2/servicerequests
- PUT /v2/servicerequests/{serviceRequestId}
- PATCH /v2/servicerequests/{serviceRequestId}
- PUT /v2/servicerequests/{requestId}/components/{componentId}
Component damage field validation change
2023-04-06
Damage service requests have been added to ROB-Net which may require users to use enter their damage pertaining service requests through the ROB-Net web interface instead of this API. A new field componentsWithDamageAllowed has been added to the output of the contract methods (see list(s) below) to determine before creating a service request if this is the case.
In order to enforce the above a new validation has been introduced that validates the damage field value of component(s). If components are incorrectly submitted with a damage field value of true where the contract field ComponentsWithDamageAllowed yields false the API will return a 400 (Bad Request) with a specific error code (ROB-SVC000177).
The following features have been ADDED:
-
The following methods now include the new field componentsWithDamageAllowed in their response:
- GET /v2/contracts/{licensePlate}
- GET /v2/lessors/{lessorId}/contracts/{licensePlate}
The following features have been CHANGED:
-
The following methods are affected by the new, previously described, validation on the optional field damage in their by request submitted components:
- POST /v2/servicerequests
- PUT /v2/servicerequests/{serviceRequestId}
- PATCH /v2/servicerequests/{serviceRequestId}
- PUT /v2/servicerequests/{requestId}/components/{componentId}
Invoices with invoice number "0" are rejected.
2023-02-27
A new invoice validation has been introduced that validates that the invoice number is not "0". If such an invoice is sent, the API returns a 400 (Bad Request) with a specific error code (ROB-INV000104).
The following features have been CHANGED:
- POST /servicerequests/{id}/invoices
Validation on Warranty and Leniency
2022-06-13
A new validation has been introduced that validates the warranty and leniency field values of the (sub)component(s). In case of an invalid enum value the API returns a 400 (Bad Request) with a specific error code (ROB-SVC000175 or ROB-SVC000176).
The following features have been CHANGED:
- POST /servicerequests
- PUT servicerequests/{serviceRequestId}
- PATCH servicerequests/{serviceRequestId}
- PUT servicerequests/{requestId}/components/{componentId}
Extend rentalclass response
2022-04-28
The hasEstateVariant field has been added to the rental classes response(s) which indicates if separate estate rates exist for the given rental class.
The following features have been CHANGED:
- GET /rentalclasses
New REST API Version
2021-05-21
With the upcoming Rental Car request support a new REST API version has been created in order to properly support the new features. This was also a good moment to fix a few inconsistencies, remove unused parts and improve processes from the old version. A full migration guide detailling the breaking changes between version 1 and 2 can be found here.
Any post-release changes of version 2 will be tracked here and, optionally, in the migration guide if they affect processes previously present in version 1.