|
|
### 1. Obter Débitos
|
|
|
- **Endpoint**: `GET /internet-banking/v1/obter-debitos/{placa}/{renavam}/{documentoProprietario}`
|
|
|
- **Endpoint**: `GET /banestes/internet-banking/v1/obter-debitos/{placa}/{renavam}/{documentoProprietario}`
|
|
|
- **Descrição**: Retorna todos os tipos de débitos em aberto agrupados.
|
|
|
- **Parâmetros**:
|
|
|
- `placa`(string, obrigatório): Identificação do veículo.
|
... | ... | @@ -9,7 +9,7 @@ |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'GET' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/obter-debitos/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/obter-debitos/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
```
|
... | ... | @@ -39,7 +39,7 @@ MRZ1737 965904008 10352411708 |
|
|
```
|
|
|
|
|
|
### 2. Detalhar Débito
|
|
|
- **Endpoint**: `GET /internet-banking/v1/detalhar-debito`
|
|
|
- **Endpoint**: `GET /banestes/internet-banking/v1/detalhar-debito/{placa}/{renavam}/{documentoProprietario}`
|
|
|
- **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
|
|
|
- **Parâmetros**:
|
|
|
- `placa`(string, obrigatório)
|
... | ... | @@ -49,7 +49,7 @@ MRZ1737 965904008 10352411708 |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'GET' \
|
|
|
'https://https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/detalhar-debito/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
|
|
|
'https://https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/detalhar-debito/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
```
|
... | ... | @@ -84,7 +84,7 @@ curl -X 'GET' \ |
|
|
```
|
|
|
|
|
|
### 3. Obter Todos de Débitos Detalhados
|
|
|
- **Endpoint**: `GET /internet-banking/v1/obter-todos-debitos-detalhados`
|
|
|
- **Endpoint**: `GET /banestes/internet-banking/v1/obter-todos-debitos/{placa}/{renavam}/{documentoProprietario}`
|
|
|
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
|
|
|
- **Parâmetros**:
|
|
|
- `placa`(string, obrigatório)
|
... | ... | @@ -93,7 +93,7 @@ curl -X 'GET' \ |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'GET' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/obter-todos-debitos-detalhados/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/obter-todos-debitos/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
```
|
... | ... | @@ -130,7 +130,7 @@ curl -X 'GET' \ |
|
|
```
|
|
|
|
|
|
### 4. Obter Dados do Veículo
|
|
|
- **Endpoint**: `GET /internet-banking/v1/obter-dados-veiculo`
|
|
|
- **Endpoint**: `GET /banestes/internet-banking/v1/obter-dados-veiculo/{placa}/{renavam}/{documentoProprietario}`
|
|
|
- **Descrição**: Retorna algumas informações do veículo.
|
|
|
- **Parâmetros**:
|
|
|
- `placa`(string, obrigatório)
|
... | ... | @@ -139,7 +139,7 @@ curl -X 'GET' \ |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'GET' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/obter-veiculo/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/obter-dados-veiculo/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
```
|
... | ... | @@ -166,12 +166,12 @@ curl -X 'GET' \ |
|
|
}
|
|
|
```
|
|
|
### 5. Obter Débitos a Vencer em Lote
|
|
|
- **Endpoint**: `GET /internet-banking/v1/obter-debitos-lote`
|
|
|
- **Descrição**: O método permite que a aplicação cliente execute consultas de débitos de veículos em lote, informando, na primeira chamada, a lista de veículos que deseja consultar, com um limite de 10.000 veículos por requisição. No retorno inicial, o método fornecerá a primeira página de débitos, limitada a 2.000 débitos por requisição. As demais páginas podem ser consultadas pelo mesmo método, informando a identificação do lote e a página desejada.
|
|
|
- **Endpoint**: `POST /banestes/internet-banking/v1/notificacao/obter-debitos`
|
|
|
- **Descrição**: O método permite que a aplicação cliente execute consultas de débitos de veículos em lote, informando, na primeira chamada, a lista de veículos que deseja consultar, com um limite de 10.000 veículos por requisição. No retorno inicial, o método fornecerá a primeira página de débitos, limitada a 2.000 veículos por requisição. As demais páginas podem ser consultadas pelo mesmo método, informando a identificação do lote e a página desejada.
|
|
|
|
|
|
- **Observações**:
|
|
|
- O limite máximo de veículos por lote é de 10.000.
|
|
|
- O limite máximo de débitos retornados por requisição é de 2.000.
|
|
|
- O limite máximo de veículos retornados por página é de 2.000.
|
|
|
- A requisição deve incluir ou a lista de veículos ou a identificação de um lote existente, mas não ambos.
|
|
|
- Um mesmo lote pode ser consultado por até 7 dias corridos, utilizando a identificação do lote fornecida.
|
|
|
- Ao fornecer a lista de veículos, o método sempre retornará a primeira página de resultados.
|
... | ... | @@ -189,7 +189,7 @@ curl -X 'GET' \ |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'POST' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/obter-debitos-lote' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/notificacao/obter-debitos' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}' \
|
|
|
-H 'Content-Type: application/json' \
|
... | ... | @@ -236,6 +236,7 @@ curl -X 'POST' \ |
|
|
- `parcela` (int): Parcela do débito.
|
|
|
- `valor` (decimal): Valor do débito até a data de vencimento.
|
|
|
- `dataVencimento` (datetime): Data de vencimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ).
|
|
|
- `TipoDebito` (Array<Enum<string>>):Tipo do débito devido: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
|
|
|
|
- **Detalhes de Paginação**
|
|
|
- `proximaPagina` (int): A próxima página a ser consultada. Este valor é dinâmico e se ajusta em tempo real conforme os débitos são consultados e podem variar de uma consulta para outra.
|
... | ... | @@ -280,7 +281,7 @@ Para não invalidar um lote inteiro iremos tratar os erro de validação dos ve |
|
|
}
|
|
|
```
|
|
|
### 6. Gerar Guia de Pagamento
|
|
|
- **Endpoint**: `PUT/internet-banking/v1/gerar-guia`
|
|
|
- **Endpoint**: `PUT/banestes/internet-banking/v1/gerar-guia`
|
|
|
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
|
|
|
- **Parâmetros**:
|
|
|
- `debitoDevido`(string, obrigatório)
|
... | ... | @@ -291,7 +292,7 @@ Para não invalidar um lote inteiro iremos tratar os erro de validação dos ve |
|
|
- **Requisição Curl**
|
|
|
```bash
|
|
|
curl -X 'PUT' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/gerar-guia' \
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/gerar-guia' \
|
|
|
-H 'accept: text/plain' \
|
|
|
-H 'Authorization: Bearer {token}' \
|
|
|
-H 'Content-Type: application/json' \
|
... | ... | |