DriveB

21. Configuração do Cliente

Este módulo permite consultar e configurar as preferências do cliente no sistema.

Obter configurações do cliente

Retorna as configurações atualmente definidas para o cliente.

Endpoint: /api/client-config

Método: GET

Response body:

{
"canDriverBook": true,
"enableWeeklyEmails": true,
"enableWorkshopUpdateEmails": true,
"enableDamageReportEmails": true,
"pressureUnit": "BAR",
"enableGps": true
}

Salvar ou atualizar configurações do cliente

Cria ou atualiza as configurações do cliente.

Endpoint: /api/client-config

Método: POST

Request payload:

{
"canDriverBook": true,
"enableWeeklyEmails": true,
"enableWorkshopUpdateEmails": true,
"enableDamageReportEmails": true,
"pressureUnit": "BAR",
"enableGps": true
}

Response body:

{
"canDriverBook": true,
"enableWeeklyEmails": true,
"enableWorkshopUpdateEmails": true,
"enableDamageReportEmails": true,
"pressureUnit": "BAR",
"enableGps": true
}

Todos os motivos de não aprovação de notas fiscais

Retorna todos os motivos possíveis para a não aprovação de notas fiscais.

Endpoint: /api/billings/reasons-not-approval-invoices

Método: GET

Respostas possíveis:

  • 200 — All the reasons for not approving invoices
  • 403 — Unauthorized
  • 500 — Unknown Server Error

Response body:

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

Consultar fila de validação de notas fiscais

Retorna a fila de validação de notas fiscais, paginada e filtrável.

Endpoint: /api/billings/invoice-validation-queue

Método: GET

Parâmetros:

  • filters (query, obrigatório) — Filtros da consulta.
  • page (query, obrigatório) — Configuração da paginação.

Respostas possíveis:

  • 200 — Get invoice validation queue
  • 403 — Unauthorized
  • 500 — Unknown Server Error

Response body:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"id": 0,
"billingId": 0,
"serviceRequestId": 0,
"requestId": "string",
"clientId": 0,
"clientName": "string",
"vehicleLicensePlate": "string",
"carWorkshopName": "string",
"budgetId": 0,
"carWorkshopPartsValue": 0,
"carWorkshopServiceValue": 0,
"invoiceStatus": "string",
"partsNfStatus": "string",
"partsNfNumber": 0,
"partsNfIssueDate": "2024-01-01T00:00:00Z",
"partsNfApprovalDate": "2024-01-01T00:00:00Z",
"serviceNfStatus": "string",
"blockCode": "string",
"partsNfSendFileDate": "2024-01-01T00:00:00Z",
"serviceNfSendFileDate": "2024-01-01T00:00:00Z",
"invoiceSendFileDate": "2024-01-01T00:00:00Z",
"isInvoiceRecorded": true,
"isServiceInvoiceAvailable": "AVAILABLE",
"isPartsInvoiceAvailable": "AVAILABLE",
"wasInvoiceRecorded": true,
"isInvoicePartPdfReplaced": true,
"isInvoicePartXmlReplaced": true,
"isInvoiceServicePdfReplaced": true,
"clientPriceNfPart": 0,
"approvalCode": "string",
"provider": "string",
"partsNfPdfFilename": "string",
"partsNfXmlFilename": "string",
"partsNfPdfFilepath": "string",
"partsNfXmlFilepath": "string",
"partsNfExpirationDate": "2024-01-01T00:00:00Z",
"serviceInvoiceForCustomer": true,
"isFee": true
}
],
"number": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"pageNumber": 0,
"unpaged": true,
"paged": true,
"pageSize": 0
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

Consultar fila de validação de notas fiscais de peças e serviços

Retorna a fila de validação de notas fiscais de peças e serviços, paginada e filtrável.

Endpoint: /api/billings/invoice-parts-services-queue

Método: GET

Parâmetros:

  • filters (query, obrigatório) — Filtros da consulta.
  • page (query, obrigatório) — Configuração da paginação.

Respostas possíveis:

  • 200 — Get invoice validation queue of parts and services
  • 403 — Unauthorized
  • 500 — Unknown Server Error

Response body:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"billingId": 0,
"serviceRequestId": 0,
"requestId": "string",
"clientId": 0,
"clientName": "string",
"clientType": "string",
"clientCountryId": 0,
"vehicleLicensePlate": "string",
"invoiceStatus": "string",
"partsNfStatus": "string",
"serviceNfStatus": "string",
"partsNfNumber": 0,
"partsNfIssueDate": "2024-01-01T00:00:00Z",
"serviceNfNumber": 0,
"serviceNfIssueDate": "2024-01-01T00:00:00Z",
"budgetId": 0,
"carWorkshopId": 0,
"carWorkshopName": "string",
"blockCode": "string",
"isInvoiceRecorded": true,
"isInvoicePartPdfReplaced": true,
"isInvoicePartXmlReplaced": true,
"isInvoiceServicePdfReplaced": true,
"status": "string",
"wasInvoiceRecorded": true,
"isServiceInvoiceAvailable": "AVAILABLE",
"isPartsInvoiceAvailable": "AVAILABLE",
"approvalCode": "string",
"provider": "string",
"clientPriceNfService": 0,
"serviceNfExpirationDate": "2024-01-01T00:00:00Z",
"partsNfExpirationDate": "2024-01-01T00:00:00Z",
"serviceNfPdfFilename": "string",
"partsNfPdfFilename": "string",
"partsNfXmlFilename": "string",
"serviceNfPdfFilepath": "string",
"partsNfPdfFilepath": "string",
"partsNfXmlFilepath": "string",
"partsNfSendFileDate": "2024-01-01T00:00:00Z",
"serviceNfSendFileDate": "2024-01-01T00:00:00Z",
"osServiceValue": 0,
"osPartsValue": 0,
"serviceInvoiceForCustomer": true,
"isFee": true,
"createdAt": "2024-01-01T00:00:00Z"
}
],
"number": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"pageNumber": 0,
"unpaged": true,
"paged": true,
"pageSize": 0
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}