End-Points.md

@@ -8,26 +8,14 @@ Aqui estão os principais endpoints da nossa API:
 - 'PUT guia-pagamento/internet-banking/v1/gerar-guia' - Gera a guia de pagamento de um tipo de débito.
 - 'GET guia-pagamento/internet-banking/v1/obter-veiculo' - Retorna dados do veículo consultado.
 
-# Detalhes do Endpoint: 'GET guia-pagamento/internet-banking/v1/verificar-debitos'
+# Detalhes do Endpoint: 'v1/verificar-debitos'
 
 ### Descrição
 Retorna a lista dos tipos de débitos em aberto que o veículo possui. 
 
-Esses débitos podem ser divididos nos seguintes tipos:
-- IPVAExercicio, 
-- IPVAAnterior, 
-- DPVATExercicio, 
-- DPVATAnterior, 
-- LicenciamentoExercicio, 
-- LicenciamentoAnterior, 
-- Multa.
-
-Cada tipo de débito possui os débitos que são obrigatórios o pagamento e os débitos que o pagamento é opcional.
-
 ### Parâmetros
 
 - `placa` (obrigatório)
-
   - Tipo: `string`
 - `renavam` (obrigatório)
   - Tipo: `string`
@@ -35,7 +23,6 @@ Cada tipo de débito possui os débitos que são obrigatórios o pagamento e os
   - Tipo: `string`
 
 ### Exemplo de Requisição 
-
 ```bash
 curl -X 'GET' \
   'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/verificar-debitos/{placa}/{renavam}/{documentoProprietario}' \
@@ -44,6 +31,9 @@ curl -X 'GET' \
 ```
 
 ### Exemplo de Resposta
+- `DebitoDevido` (obrigatório)
+  - Tipo: `Array<string>`
+  - Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
 ```json
 [
   "IPVAExercicio",
@@ -69,28 +59,20 @@ Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma
 # Detalhes do Endpoint: 'GET guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado'
 
 ### Descrição
-Retorna a lista dos tipos de débitos em aberto que o veículo possui. 
-
-Esses débitos podem ser divididos nos seguintes tipos:
-- IPVAExercicio, 
-- IPVAAnterior, 
-- DPVATExercicio, 
-- DPVATAnterior, 
-- LicenciamentoExercicio, 
-- LicenciamentoAnterior, 
-- Multa.
-
-Cada tipo de débito possui os débitos que são obrigatórios o pagamento e os débitos que o pagamento é opcional.
+Retorna a lista de débitos de um tipo especifico. 
 
 ### Parâmetros
 
 - `placa` (obrigatório)
-
   - Tipo: `string`
 - `renavam` (obrigatório)
   - Tipo: `string`
 - `documentoProprietario` (obrigatório)
   - Tipo: `string`
+- `debitoDevido` (obrigatório)
+  - Tipo: `string`
+  - Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
+  - Observação: Deve-se informar apenas um tipo de débito devido.
 
 ### Exemplo de Requisição 
 
@@ -103,10 +85,20 @@ curl -X 'GET' \
 
 ### Exemplo de Resposta
 ```json
-[
-  "IPVAExercicio",
-  "LicenciamentoExercicio"
-]
+{
+  "descricao": "string",
+  "exercicio": 0,
+  "debitoDevido": "IPVAExercicio",
+  "debitos": [
+    {
+      "guid": 0,
+      "descricao": "string",
+      "dataVencimento": "2024-06-03T18:21:00.965Z",
+      "valor": 0,
+      "pagamentoObrigatorio": true
+    }
+  ]
+}
 ```
 
 ### Tratamento de Erro