End-Points.md

@@ -115,6 +115,72 @@ curl -X 'GET' \
 
 Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma requisição.
 
+- `401 Unauthorized` - Falha na autenticação.
+- `403 Forbidden` - Sem permissão
+- `404 Not Found` - O recurso solicitado não foi encontrado.
+- `422 Unprocessable Entity` - Erro de validação.
+- `500 Internal Server Error` - Erro no servidor.
+- `502 Bad Gateway` - Erro de proxy
+- `503 Service Unavailable` - Servidor não está pronto para requisição
+```
+
+# Detalhes do Endpoint: 'v1/obter-todos-debitos-detalhados'
+
+### Descrição
+Retorna a lista de todos os tipo de débitos detalhados.
+
+### Parâmetros
+
+- `placa` (obrigatório)
+  - Tipo: `string`
+- `renavam` (obrigatório)
+  - Tipo: `string`
+- `documentoProprietario` (obrigatório)
+  - Tipo: `string`
+
+### Requisição 
+
+```bash
+curl -X 'GET' \
+  'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
+  -H 'accept: text/plain' \
+  -H 'Authorization: Bearer SEU_TOKEN_DE_API'
+```
+
+### Resposta
+- Descricao (string): Uma breve descrição do débito devido.
+- Exercicio (integer): Ano do exercício referente ao débito.
+- DebitoDevido (Enum): Tipo do débito devido, neste caso, "IPVAExercicio".
+  - Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
+- Debitos (array): Lista de débitos associados.
+  - Guid (integer): Identificador único do débito.
+  - Descricao (string): Descrição do débito.
+  - DataVencimento (string, formato datetime): Data de vencimento do débito.
+  - Valor (decimal): Valor do débito.
+  - PagamentoObrigatorio (boolean): Indica se o pagamento é obrigatório.
+```json
+{
+  "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
+```markdown
+# Tratamento de Erros
+
+Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma requisição.
+
 - `401 Unauthorized` - Falha na autenticação.
 - `403 Forbidden` - Sem permissão
 - `404 Not Found` - O recurso solicitado não foi encontrado.