Este documento reúne endpoints auxiliares relacionados ao gerenciamento de manutenções preventivas, propostas de manutenção, histórico de faturamento de clientes e geração de relatórios de notas fiscais. Esses recursos complementam os módulos principais da plataforma, oferecendo consultas específicas e operações de apoio aos processos de manutenção e faturamento.

Funcionalidades Principais

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

Consultar última manutenção preventiva
Consultar histórico de faturamento do cliente
Gerar relatório de notas fiscais

Consultar última manutenção preventiva

Retorna as informações da última manutenção preventiva realizada, bem como o status da próxima manutenção planejada para o veículo.

Endpoint: /api/vehicles/{id}/preventives

Método: GET

Parâmetros:

id (path, obrigatório, integer) — Identificador do veículo.

Response body:

{
  "id": 0,
  "odometer": 0,
  "lastOdometerUpdateDate": "2024-01-01T00:00:00Z",
  "isOdometerUpToDate": true,
  "lastFinishedPreventive": {
    "id": 0,
    "finishDate": "2024-01-01T00:00:00Z",
    "odometer": 0,
    "maintenancePlanPackage": 0,
    "carWorkshopTradingName": "string"
  },
  "nextMaintenancePlan": {
    "maintenancePlanPackage": 0,
    "maintenancePlanMonths": 0,
    "maintenancePlanMonthYear": "string"
  },
  "isPreventiveUpToDate": true,
  "telemetryCapable": true,
  "warning": true,
  "danger": true
}

Consultar histórico de faturamento do cliente

Retorna o histórico de alterações e registros de faturamento associados ao cliente informado.

Endpoint: /api/client-billing-history/{clientId}

Método: GET

Parâmetros:

id (path, obrigatório, integer) — Identificador do veículo.

Response body:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "username": "string",
      "paymentTerm": 0,
      "closingBillingDates": [
        0
      ],
      "clientId": 0,
      "description": "string",
      "date": "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
}

Gerar relatório de notas fiscais

Gera um relatório consolidado de notas fiscais de acordo com os filtros informados.

Endpoint: /api/invoices-report/invoices-report

Método: POST

Request body:

{
  "requestId": "string",
  "clientId": 0,
  "carWorkshopId": 0,
  "vehicleLicensePlate": "string",
  "partsNfNumber": 0,
  "servicesNfNumber": 0,
  "nfIssueInitialDate": "2024-01-01",
  "nfIssueFinalDate": "2024-01-01",
  "blockCode": "string",
  "invoiceStatus": "INVOICE_WAITING_UPLOAD",
  "isInvoiceRecorded": true,
  "isPartsInvoiceAvailable": "AVAILABLE",
  "isServiceInvoiceAvailable": "AVAILABLE",
  "clientPriceNfParts": 0,
  "billingId": 0,
  "franchiseIds": [
    0
  ],
  "partsNfIssueInitialDate": "2024-01-01",
  "partsNfIssueFinalDate": "2024-01-01"
}

Response body (payload de exemplo vazio na documentação de origem):

{}