... | ... | @@ -25,16 +25,81 @@ Esses débitos podem ser divididos nos seguintes tipos: |
|
|
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: string, obrigatório
|
|
|
- Renavam: string, obrigatório
|
|
|
- DocumentoProprietario: string, obrigatório
|
|
|
|
|
|
- `placa` (obrigatório)
|
|
|
|
|
|
- Tipo: `string`
|
|
|
- `renavam` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
- `documentoProprietario` (obrigatório)
|
|
|
- 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}' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
|
|
|
```
|
|
|
|
|
|
### Exemplo de Resposta
|
|
|
```json
|
|
|
[
|
|
|
"IPVAExercicio",
|
|
|
"LicenciamentoExercicio"
|
|
|
]
|
|
|
```
|
|
|
|
|
|
### 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.
|
|
|
- `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: '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.
|
|
|
|
|
|
### Parâmetros
|
|
|
|
|
|
- `placa` (obrigatório)
|
|
|
|
|
|
- Tipo: `string`
|
|
|
- `renavam` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
- `documentoProprietario` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
|
|
|
### Exemplo de 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'
|
|
|
```
|
|
|
|
|
|
### Exemplo de Resposta
|
|
|
```json
|
... | ... | @@ -50,11 +115,11 @@ 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
|
|
|
- `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
|
|
|
``` |
|
|
\ No newline at end of file |