DriveB

20. Cliente

Este módulo permite consultar, gerenciar e obter informações sobre os clientes cadastrados no sistema.

Obter cliente por ID

Recupera todas as informações de um cliente específico.

Endpoint: /api/clients/{id}

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador do cliente.

Response body:

{
"id": 0,
"clientCode": "string",
"sapId": "string",
"corporateName": "string",
"tradingName": "string",
"taxIdentifier": "string",
"isParent": true,
"parentId": 0,
"parent": { ... },
"responsable": { ... },
"subsidiaries": [ ... ],
"contacts": [ ... ],
"address": { ... },
"hasAdministrativeTax": true,
"administrativeTax": 0,
"billingCutOffDay": 0,
"isIurdClient": true,
"responsibleConsultant": { ... },
"daysAdvanceForAppointments": 0,
"version": 0,
"isAutomaticTag": true,
"isNewPreventiveFlow": true,
"currentContractId": 0,
"tags": [ ... ]
}

Agendar manutenção futura

Registra que o cliente deseja agendar um serviço de manutenção futuramente.

Endpoint: /api/clients/{id}/wants-maintenance/{type}

Método: PUT

Parâmetros:

  • id (path, obrigatório) — Identificador do cliente.
  • type (path, obrigatório) — Tipo do serviço de manutenção futura.

Listar carteira de oficinas do cliente

Retorna a lista de oficinas associadas à carteira do cliente.

Endpoint: /api/v2/clients/wallet-carworkshop

Método: GET

Parâmetros:

  • clientId (query, opcional) — Identificador do cliente.

Adicionar oficinas à carteira do cliente

Adiciona oficinas à carteira do cliente por meio de um arquivo.

Endpoint: /api/v2/clients/wallet-carworkshop

Método: POST

Request payload:

{
"file": "string"
}

Response body:

{
"hasError": true,
"errors": [
{
"linePosition": 0,
"rowValues": "string",
"errorMessage": "string"
}
],
"carWorkshopIds": [
0
]
}

Pesquisar contatos do cliente

Retorna os contatos cadastrados para um cliente.

Endpoint: /api/clients/{id}/contacts

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador do cliente.

Response body:

[
{
"id": 0,
"sub": "string",
"name": "string",
"email": "string",
"username": "string",
"...": "..."
}
]

Listar oficinas bloqueadas

Retorna as oficinas bloqueadas para um cliente.

Endpoint: /api/clients/{id}/blocked-carworkshop

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador do cliente.
  • pageable (query, obrigatório) — Configuração da paginação.

Response body:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"carWorkshopAddressNumber": "string",
"carWorkshopAddressCityName": "string",
"carWorkshopFranchiseName": "string",
"carWorkshopAddressStreet": "string",
"clientId": 0,
"carWorkshopId": 0,
"carWorkshopTradingName": "string"
}
]
}

Listar clientes sem tenants associados

Lista os clientes que ainda não possuem tenants vinculados.

Endpoint: /api/v2/clients/without-tenants/{integrationType}

Método: GET

Parâmetros:

  • integrationType (path, obrigatório) — Tipo de integração.
  • filter (query, opcional) — Texto para filtro.
  • page (query, obrigatório) — Configuração da paginação.

Exportar clientes para o módulo de vendas

Exporta todos os clientes para o módulo de vendas.

Endpoint: /api/v2/clients/export-to-sales-module

Método: GET

Response body:

"string"

Listar todos os clientes (simplificado)

Retorna os principais dados de todos os clientes, sem paginação.

Endpoint: /api/v2/clients/allSimplified

Método: GET

Parâmetros:

  • clientProjectionFilterDTO (query, obrigatório) — Filtros da consulta.

Response body:

[
{
"id": 0,
"address": { ... },
"isParent": true,
"tradingName": "string",
"clientCode": "string",
"taxIdentifier": "string",
"corporateName": "string",
"sapId": "string"
}
]

Pesquisar blocos do cliente

Retorna os blocos associados a um cliente.

Endpoint: /api/clients/{id}/blocks

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador do cliente.
  • isParent (query, opcional) — Indica se deve pesquisar apenas matriz.
  • ignoreBlocksAlreadyRegistered (query, opcional) — Ignora blocos já cadastrados.

Response body:

[
{
"id": 0,
"blockCode": "string",
"tag": "string",
"parentId": 0,
"parent": { ... },
"address": { ... }
}
]

Listar todos os clientes (simplificado)

Retorna os principais dados de todos os clientes, sem paginação.

Endpoint: /api/v2/clients/allSimplified

Método: GET

Parâmetros:

  • clientProjectionFilterDTO (query, obrigatório) — Filtros da consulta.

Response body:

[
{
"id": 0,
"address": { ... },
"isParent": true,
"tradingName": "string",
"clientCode": "string",
"taxIdentifier": "string",
"corporateName": "string",
"sapId": "string"
}
]

Autocompletar clientes

Pesquisa clientes pelo nome corporativo para preenchimento automático.

Endpoint: /api/clients/autocomplete

Método: GET

Parâmetros:

  • clientFilterDTO (query, obrigatório) — Filtros da pesquisa.

Response body:

[
{
"display": "string",
"value": 0
}
]