DriveB

04. Solicitação de Serviço

Este módulo é o coração operacional da plataforma. Ele permite criar, atualizar e consultar ordens de serviço, conectando diretamente os veículos às oficinas credenciadas para execução das manutenções.

O módulo de Notas Fiscais permite a integração com os documentos fiscais gerados durante os processos de manutenção. Aqui você pode consultar, registrar e acompanhar notas fiscais eletrônicas associadas aos serviços realizados


Funcionalidades Principais

Abaixo estão os atalhos para as operações mais utilizadas neste módulo:



Nova Solicitação

Crie uma nova ordem de serviço para manutenção de veículos, conectando-se à rede de oficinas credenciadas.


Serviços oferecidos

Consulte os serviços oferecidos para cada veículo.

Enpoint: /api/service-categories

Método: GET

Response:

[
{
"id": 0,
"code": "string"
}
]



Listagem Oficinas

Consulte oficinas disponíveis com base em localização, tipo de serviço e disponibilidade.

Enpoint: /api/car-workshops/nearby-paginated?page=0&pageSize=5

Método: POST

Response:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"id": 0,
"tradingName": "string",
"address": {
"id": 0,
"district": "string",
"street": "string",
"number": "string",
"city": "string",
"state": "string",
"country": "string"
},
"serviceCompletionDate": "2025-08-29T11:57:04.796Z",
"distance": 0,
"provideDesiredServices": true,
"acceptVehicleBrand": true,
"provideServiceType": true,
"latitude": 0.1,
"longitude": 0.1,
"networkName": "string",
"maintenancePrice": 0.1,
"email": "string",
"phone": "string",
"name": "string",
"conversations": [
{
"id": 0,
"active": true,
"status": "string",
"conversations": [
{
"id": 0,
"subject": "string",
"body": "string",
"sentBy": "string",
"fromEmail": "string",
"createdDate": "2025-08-29T11:57:04.796Z",
"files": [
{
"id": 0,
"name": "string",
"type": "string"
}
]
}
]
}
]
}
],
"number": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"pageNumber": 0,
"unpaged": true,
"paged": true,
"pageSize": 0
},
"first": true,
"last": true,
"numberOfElements": 0,
"empty": true
}

Novo Agendamento

Envie uma solicitação de agendamento de manutenção com os dados do veículo, tipo de serviço e oficina escolhida.

Endpoint: /api/scheduling-requests

Método: POST

Request payload:

{
"clientId": 0,
"parentId": null,
"vehicleId": 0,
"drivers": [],
"currentKm": 0,
"preventiveReviewKm": "",
"correctiveDescription": string,
"observations": "",
"requestId": "",
"id": "",
"serviceType": "CORRECTIVE",
"status": "SCHEDULED",
"tiresAmount": "",
"tiresDescription": "",
"carWorkshopId": 2893,
"date": "2025-09-26T03:00:00.000Z",
"period": "AFTERNOON"
}

Response:

{
"message": "Solicitação de Serviço salvo(a) com sucesso.",
"payLoad": {
"id": 10038,
"requestId": "CDFBR_AAA5656_202508290848",
"stepStatus": "BACKOFFICE_PENDING",
"vehicleId": 17273,
"clientId": 2414,
"parentId": null,
"budgetId": null,
"parentServiceRequestId": null,
"parentRequestId": null,
"currentKm": 999999999,
"correctiveDescription": "d",
"tiresDescription": "666666666666",
"tiresAmount": 2,
"observations": "",
"observationRemoveVehicle": null,
"serviceType": "TIRES",
"status": "SCHEDULED",
"displayConfirmedScheduling": "26/09/2025 - Tarde",
"carWorkshopName": null,
"carWorkshopId": 2893,
"carWorkshopCityName": null,
"preventiveReviewKm": null,
"modifiedAt": null,
"modifiedBy": "system",
"serviceConfirmedDrive": false,
"isEmptyBudgetFlow": false,
"isComplementary": false,
"reasonCancel": null,
"reasonsToCancel": null,
"displayReasonCancel": null,
"observationCancel": null,
"date": "2025-09-26T00:00:00.000-03:00",
"period": "AFTERNOON",
"serviceRequestRatingId": null,
"serviceRequestRating": null,
"completionPrediction": null,
"completionPredictionPeriod": null,
"displayCompletionPredictionPeriod": null,
"isPreApproved": false,
"isPreApprovedCarworkshop": false,
"checkinChecklistFilled": false,
"checkoutChecklistFilled": false,
"carWorkshopKm": null,
"periodLimitCancel": null,
"vehicleArrivalConfirmationDate": null,
"vehicleArrivalConfirmationDateByUser": null,
"drivers": [],
"serviceStartedAt": null,
"endedIn": null,
"vehicleArrived": null,
"isPuc": false,
"hadIntentionOnComplementaryService": false,
"workshopQuotationPrevisionDate": null,
"workshopQuotationPrevisionPeriod": null,
"workshopCompletionPrevisionDate": null,
"workshopCompletionPrevisionPeriod": null,
"vehicleAttendanceWorkshopStatus": "OUTSIDE_WORKSHOP",
"confirmedUnattendanceDate": null,
"billingCheckNfByBotPart": false,
"billingCheckNfByBotService": false,
"timeService": null,
"orderId": null,
"serviceRecommendationPlans": null,
"createdAt": null,
"serviceInvoiceForCustomer": true,
"fee": true,
"preventive": false,
"isFee": true
},
"warning": false
}



Consultar Orçamento

Receba orçamentos para validação

Endpoint: /api/budgets/{id}

Método: GET

Response:

{
"id": 0,
"serviceRequestId": 0,
"billingId": 0,
"status": "string",
"displayStatus": "string",
"approvalCode": 0,
"creatorUser": "string",
"perfil": "string",
"createdAt": "2025-09-11T18:48:28.375Z",
"modifiedAt": "2025-09-11T18:48:28.375Z",
"clientApprovalAvailableAt": "2025-09-11T18:48:28.375Z",
"modifiedBy": "string",
"observationApproveOrCancel": "string",
"observationRemoveVehicle": "string",
"observationBackoffice": "string",
"observationCarWorkshop": "string",
"generatedCarWorkshop": true,
"approvedDate": "2025-09-11T18:48:28.375Z",
"budgetServiceItems": [
{
"id": 0,
"budgetId": 0,
"serviceId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"serviceName": "string",
"serviceCode": "string",
"amountOfHours": 0.1,
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true
}
],
"budgetPartItems": [
{
"id": 0,
"budgetId": 0,
"partId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"partAmount": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"partManufacturerName": "string",
"partCode": "string",
"partName": "string",
"measurementUnit": "string",
"budgetServiceItem": {
"id": 0,
"budgetId": 0,
"serviceId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"serviceName": "string",
"serviceCode": "string",
"amountOfHours": 0.1,
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true
},
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true,
"pnErpCode": "string",
"isInternalReferenceBase": true
}
],
"budgetValidations": [
{
"id": 0,
"budgetId": 0,
"status": "string",
"observation": "string",
"creatorUser": "string",
"createdAt": "2025-09-11T18:48:28.375Z"
}
],
"carWorkshopPdfFilename": "string",
"carWorkshopPdfFilepath": "string",
"clientApproverProfile": "DRIVER",
"clientApproverUsername": "string",
"approvalLimitId": 0,
"workflowClientApprovalsCount": 0,
"workflowClientApprovalsTotal": 0,
"workflowClientIsLastApprover": true,
"workflowClientNextApprovalUserType": "APPROVAL_USER_1",
"inRenegotiation": true,
"version": 0,
"hasChangedValue": true,
"empty": true
}

Aprovar orçamentos

Endpoint: api/budgets/{budgetId}/approve

Request body:

{
"id": 0,
"removedPartsIds": [
0
],
"removedServicesIds": [
0
],
"approvalCode": 0,
"observations": "string"
}

Response:

{
"message": "string",
"payLoad": {
"id": 0,
"serviceRequestId": 0,
"billingId": 0,
"status": "string",
"displayStatus": "string",
"approvalCode": 0,
"creatorUser": "string",
"perfil": "string",
"createdAt": "2025-09-11T19:32:21.968Z",
"modifiedAt": "2025-09-11T19:32:21.968Z",
"clientApprovalAvailableAt": "2025-09-11T19:32:21.968Z",
"modifiedBy": "string",
"observationApproveOrCancel": "string",
"observationRemoveVehicle": "string",
"observationBackoffice": "string",
"observationCarWorkshop": "string",
"generatedCarWorkshop": true,
"approvedDate": "2025-09-11T19:32:21.968Z",
"budgetServiceItems": [
{
"id": 0,
"budgetId": 0,
"serviceId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"serviceName": "string",
"serviceCode": "string",
"amountOfHours": 0.1,
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true
}
],
"budgetPartItems": [
{
"id": 0,
"budgetId": 0,
"partId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"partAmount": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"partManufacturerName": "string",
"partCode": "string",
"partName": "string",
"measurementUnit": "string",
"budgetServiceItem": {
"id": 0,
"budgetId": 0,
"serviceId": 0,
"clientPrice": 0.1,
"carWorkshopPrice": 0.1,
"intermediationFee": 0.1,
"admFee": 0.1,
"driveBMargin": 0.1,
"serviceName": "string",
"serviceCode": "string",
"amountOfHours": 0.1,
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true
},
"modifiedBy": "string",
"isPreventiveVerification": true,
"isPreventiveVerificationConfirmed": true,
"pnErpCode": "string",
"isInternalReferenceBase": true
}
],
"budgetValidations": [
{
"id": 0,
"budgetId": 0,
"status": "string",
"observation": "string",
"creatorUser": "string",
"createdAt": "2025-09-11T19:32:21.968Z"
}
],
"carWorkshopPdfFilename": "string",
"carWorkshopPdfFilepath": "string",
"clientApproverProfile": "DRIVER",
"clientApproverUsername": "string",
"approvalLimitId": 0,
"workflowClientApprovalsCount": 0,
"workflowClientApprovalsTotal": 0,
"workflowClientIsLastApprover": true,
"workflowClientNextApprovalUserType": "APPROVAL_USER_1",
"inRenegotiation": true,
"version": 0,
"hasChangedValue": true,
"empty": true
},
"warning": true
}



Listagem de Manutenções

Consulte todas as manutenções realizadas ou em andamento, com filtros por status, data, veículo e oficina.

Endpoint: /api/service-requests/filters

Método: POST

Response:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"id": 0,
"requestId": "string",
"modelName": "string",
"clientBlockName": "string",
"displayConfirmedScheduling": "string",
"serviceType": "string",
"carWorkshopId": 0,
"carWorkshopName": "string",
"carWorkshopAddress": "string",
"categoryName": "string",
"cityStateName": "string",
"tags": [
{
"name": "string",
"tagType": "string"
}
],
"orderId": "string",
"status": "string",
"displayStatus": "string",
"backofficePendency": true,
"carWorkshopPendency": true,
"date": "2025-08-29",
"period": "string",
"partValue": 0.1,
"serviceValue": 0.1,
"blockId": 0,
"clientType": "DEFAULT",
"callToAction": "BACKOFFICE_PENDING_SCHEDULED",
"vehicleId": 0,
"clientId": 0,
"checkoutType": "YES",
"workshopRefused": true,
"timeService": "2025-08-29T12:00:38.422Z",
"serviceRecommendationTypes": [
{
"id": 0,
"key": "string",
"enableModel": true,
"enableExecutionPeriod": true,
"enableTimeFrequency": true,
"enableCountry": true,
"mandatoryFields": "string",
"displayValue": "string",
"enableFirstInspectionTime": true,
"enableTimesSubsequence": true,
"enableSubsequentInspectionTime": true,
"enableMileageFrequency": true,
"enableDescription": true,
"enableClient": true,
"localeCode": "string"
}
],
"serviceRecommendations": [
{
"serviceRecommendationTypeId": 0,
"name": "string",
"displayName": "string"
}
],
"endedIn": "2025-08-29",
"observations": "string",
"drivers": "string",
"whiteLabelClient": true,
"puc": true,
"complementary": true,
"clientQuestioningPending": true,
"isFee": true
}
],
"number": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"pageNumber": 0,
"unpaged": true,
"paged": true,
"pageSize": 0
},
"first": true,
"last": true,
"numberOfElements": 0,
"empty": true
}



Reagendamento

É possível reagendar solicitações de manutenção alterando a oficina ou alterando a data.


Enpoint: /api/service-requests/{id}/rescheduling

Método: PUT

Request body:

{
"carWorkshopId": 0,
"date": "2025-09-16T23:01:00.160Z",
"period": "string",
"timeService": "2025-09-16T23:01:00.160Z"
}

Response:

{
"message": "string",
"payLoad": {
"id": 0,
"requestId": "string",
"stepStatus": "string",
"vehicleId": 0,
"clientId": 0,
"parentId": 0,
"budgetId": 0,
"parentServiceRequestId": 0,
"parentRequestId": "string",
"currentKm": 0,
"correctiveDescription": "string",
"tiresDescription": "string",
"tiresAmount": 0,
"observations": "string",
"observationRemoveVehicle": "string",
"serviceType": "string",
"status": "string",
"displayConfirmedScheduling": "string",
"carWorkshopName": "string",
"carWorkshopId": 0,
"carWorkshopCityName": "string",
"preventiveReviewKm": 0,
"modifiedAt": "2025-09-16T23:01:00.445Z",
"modifiedBy": "string",
"serviceConfirmedDrive": true,
"isEmptyBudgetFlow": true,
"isComplementary": true,
"reasonCancel": "string",
"reasonsToCancel": [
"REASON_CAR_WORKSHOP_DOESNT_ATTEND_ME"
],
"displayReasonCancel": "string",
"observationCancel": "string",
"date": "2025-09-16T23:01:00.445Z",
"period": "string",
"serviceRequestRatingId": 0,
"serviceRequestRating": {
"id": 0,
"createdAt": "2025-09-16T23:01:00.445Z",
"username": "string",
"carWorkshopAttendanceRating": 0,
"carWorkshopCleaningRating": 0,
"serviceRating": 0,
"platformRating": 0,
"observation": "string"
},
"completionPrediction": "2025-09-16T23:01:00.445Z",
"completionPredictionPeriod": "string",
"displayCompletionPredictionPeriod": "string",
"isPreApproved": true,
"isPreApprovedCarworkshop": true,
"checkinChecklistFilled": true,
"checkoutChecklistFilled": true,
"carWorkshopKm": 0,
"periodLimitCancel": "2025-09-16T23:01:00.445Z",
"vehicleArrivalConfirmationDate": "2025-09-16T23:01:00.445Z",
"vehicleArrivalConfirmationDateByUser": "2025-09-16T23:01:00.445Z",
"drivers": [
{
"id": 0,
"serviceRequestId": 0,
"driverId": 0,
"name": "string",
"telephoneNumber": "string"
}
],
"serviceStartedAt": "2025-09-16T23:01:00.445Z",
"endedIn": "2025-09-16T23:01:00.445Z",
"vehicleArrived": true,
"isPuc": true,
"hadIntentionOnComplementaryService": true,
"workshopQuotationPrevisionDate": "2025-09-16T23:01:00.445Z",
"workshopQuotationPrevisionPeriod": "MORNING",
"workshopCompletionPrevisionDate": "2025-09-16T23:01:00.445Z",
"workshopCompletionPrevisionPeriod": "MORNING",
"vehicleAttendanceWorkshopStatus": "OUTSIDE_WORKSHOP",
"confirmedUnattendanceDate": "2025-09-16T23:01:00.445Z",
"billingCheckNfByBotPart": true,
"billingCheckNfByBotService": true,
"timeService": "2025-09-16T23:01:00.445Z",
"orderId": "string",
"serviceRecommendationPlans": [
{
"id": 0,
"key": "string",
"displayValue": "string",
"enabled": true,
"mandatoryFields": "string",
"days": 0,
"nextServiceStatus": "SCHEDULED",
"damageReports": [
{
"id": 0,
"defectDescription": "string",
"createdAt": "2025-09-16T23:01:00.445Z",
"reporterName": "string",
"isSelected": true
}
],
"seasonalNeeds": [
{
"serviceRecommendationPlanPeriodId": 0,
"description": "string",
"periodExecutionMonth": 0,
"periodExecutionDay": 0,
"isSelected": true
}
],
"oemServices": [
{
"serviceRecommendationPlanOemId": 0,
"description": "string",
"mileageFrequency": 0,
"timeFrequency": 0,
"isSelected": true
}
],
"isSelected": true
}
],
"createdAt": "2025-09-16T23:01:00.445Z",
"serviceInvoiceForCustomer": true,
"periodServiceCompleted": "2025-09-16T23:01:00.445Z",
"purchaseOrderPart": 0,
"isWhiteLabelClient": true,
"clientType": "DEFAULT",
"fee": true,
"preventive": true,
"isFee": true
},
"warning": true
}



Cancelamento

Cancele solicitações de manutenção antes da execução do serviço.


Motivo para cancelamento

Enpoint: /api/service-requests/reasons-cancellation?type=CANCELLATION

Método: GET

Response:

[
{
"name": "string",
"value": "string"
}
]


Cancelar solicitação

Endpoint: / api/service-requests/{id}/cancel

Método: PUT

Parameters:

  • reason

  • observation

Response:

{
"message": "string",
"payLoad": {
"id": 0,
"requestId": "string",
"stepStatus": "string",
"vehicleId": 0,
"clientId": 0,
"parentId": 0,
"budgetId": 0,
"parentServiceRequestId": 0,
"parentRequestId": "string",
"currentKm": 0,
"correctiveDescription": "string",
"tiresDescription": "string",
"tiresAmount": 0,
"observations": "string",
"observationRemoveVehicle": "string",
"serviceType": "string",
"status": "string",
"displayConfirmedScheduling": "string",
"carWorkshopName": "string",
"carWorkshopId": 0,
"carWorkshopCityName": "string",
"preventiveReviewKm": 0,
"modifiedAt": "2025-09-16T23:09:16.723Z",
"modifiedBy": "string",
"serviceConfirmedDrive": true,
"isEmptyBudgetFlow": true,
"isComplementary": true,
"reasonCancel": "string",
"reasonsToCancel": [
"REASON_CAR_WORKSHOP_DOESNT_ATTEND_ME"
],
"displayReasonCancel": "string",
"observationCancel": "string",
"date": "2025-09-16T23:09:16.723Z",
"period": "string",
"serviceRequestRatingId": 0,
"serviceRequestRating": {
"id": 0,
"createdAt": "2025-09-16T23:09:16.723Z",
"username": "string",
"carWorkshopAttendanceRating": 0,
"carWorkshopCleaningRating": 0,
"serviceRating": 0,
"platformRating": 0,
"observation": "string"
},
"completionPrediction": "2025-09-16T23:09:16.723Z",
"completionPredictionPeriod": "string",
"displayCompletionPredictionPeriod": "string",
"isPreApproved": true,
"isPreApprovedCarworkshop": true,
"checkinChecklistFilled": true,
"checkoutChecklistFilled": true,
"carWorkshopKm": 0,
"periodLimitCancel": "2025-09-16T23:09:16.723Z",
"vehicleArrivalConfirmationDate": "2025-09-16T23:09:16.723Z",
"vehicleArrivalConfirmationDateByUser": "2025-09-16T23:09:16.723Z",
"drivers": [
{
"id": 0,
"serviceRequestId": 0,
"driverId": 0,
"name": "string",
"telephoneNumber": "string"
}
],
"serviceStartedAt": "2025-09-16T23:09:16.723Z",
"endedIn": "2025-09-16T23:09:16.723Z",
"vehicleArrived": true,
"isPuc": true,
"hadIntentionOnComplementaryService": true,
"workshopQuotationPrevisionDate": "2025-09-16T23:09:16.723Z",
"workshopQuotationPrevisionPeriod": "MORNING",
"workshopCompletionPrevisionDate": "2025-09-16T23:09:16.723Z",
"workshopCompletionPrevisionPeriod": "MORNING",
"vehicleAttendanceWorkshopStatus": "OUTSIDE_WORKSHOP",
"confirmedUnattendanceDate": "2025-09-16T23:09:16.723Z",
"billingCheckNfByBotPart": true,
"billingCheckNfByBotService": true,
"timeService": "2025-09-16T23:09:16.723Z",
"orderId": "string",
"serviceRecommendationPlans": [
{
"id": 0,
"key": "string",
"displayValue": "string",
"enabled": true,
"mandatoryFields": "string",
"days": 0,
"nextServiceStatus": "SCHEDULED",
"damageReports": [
{
"id": 0,
"defectDescription": "string",
"createdAt": "2025-09-16T23:09:16.723Z",
"reporterName": "string",
"isSelected": true
}
],
"seasonalNeeds": [
{
"serviceRecommendationPlanPeriodId": 0,
"description": "string",
"periodExecutionMonth": 0,
"periodExecutionDay": 0,
"isSelected": true
}
],
"oemServices": [
{
"serviceRecommendationPlanOemId": 0,
"description": "string",
"mileageFrequency": 0,
"timeFrequency": 0,
"isSelected": true
}
],
"isSelected": true
}
],
"createdAt": "2025-09-16T23:09:16.723Z",
"serviceInvoiceForCustomer": true,
"periodServiceCompleted": "2025-09-16T23:09:16.723Z",
"purchaseOrderPart": 0,
"isWhiteLabelClient": true,
"clientType": "DEFAULT",
"fee": true,
"preventive": true,
"isFee": true
},
"warning": true
}