... | @@ -9,16 +9,25 @@ |
... | @@ -9,16 +9,25 @@ |
|
- `placa`(string, obrigatório): Identificação do veículo.
|
|
- `placa`(string, obrigatório): Identificação do veículo.
|
|
- `renavam`(string, obrigatório): Registro Nacional de Veículos Automotores.
|
|
- `renavam`(string, obrigatório): Registro Nacional de Veículos Automotores.
|
|
- `documentoProprietario`(string, obrigatório): Documento do proprietário do veículo.
|
|
- `documentoProprietario`(string, obrigatório): Documento do proprietário do veículo.
|
|
|
|
|
|
|
|
- **Requisição Curl**
|
|
|
|
```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 {token}'
|
|
|
|
```
|
|
- **Resposta**
|
|
- **Resposta**
|
|
- Array<Enum<string>>
|
|
- Array<Enum<string>>
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
- **Json Resposta**
|
|
**Json Resposta**
|
|
```json
|
|
```json
|
|
[
|
|
[
|
|
"IPVAExercicio",
|
|
"IPVAExercicio",
|
|
"LicenciamentoExercicio"
|
|
"LicenciamentoExercicio"
|
|
]
|
|
]
|
|
```
|
|
```
|
|
|
|
|
|
### 2. Obter Tipo de Débito Detalhado
|
|
### 2. Obter Tipo de Débito Detalhado
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado`
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado`
|
|
- **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
|
|
- **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
|
... | @@ -27,6 +36,13 @@ |
... | @@ -27,6 +36,13 @@ |
|
- `renavam`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `debitoDevido`(string, obrigatório): Tipo de débito a ser detalhado.
|
|
- `debitoDevido`(string, obrigatório): Tipo de débito a ser detalhado.
|
|
|
|
- - **Requisição Curl**
|
|
|
|
```bash
|
|
|
|
curl -X 'GET' \
|
|
|
|
'https://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 {token}'
|
|
|
|
```
|
|
- **Resposta**
|
|
- **Resposta**
|
|
- `descricao`(string): Descrição do débito principal.
|
|
- `descricao`(string): Descrição do débito principal.
|
|
- `exercicio`(int): Exercício do pagamento do débito principal.
|
|
- `exercicio`(int): Exercício do pagamento do débito principal.
|
... | @@ -37,6 +53,7 @@ |
... | @@ -37,6 +53,7 @@ |
|
- `dataVencimento`(DateTime): Data de vencimento do débito.
|
|
- `dataVencimento`(DateTime): Data de vencimento do débito.
|
|
- `valor`(decimal): Valor do débito.
|
|
- `valor`(decimal): Valor do débito.
|
|
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
|
|
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
|
|
|
|
**Json Resposta**
|
|
```json
|
|
```json
|
|
{
|
|
{
|
|
"descricao": "string",
|
|
"descricao": "string",
|
... | @@ -53,13 +70,21 @@ |
... | @@ -53,13 +70,21 @@ |
|
]
|
|
]
|
|
}
|
|
}
|
|
```
|
|
```
|
|
|
|
|
|
### 3. Obter Todos Tipos de Débitos Detalhados
|
|
### 3. Obter Todos Tipos de Débitos Detalhados
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-todos-tipos-debitos-detalhados`
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-todos-tipos-debitos-detalhados`
|
|
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
|
|
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
|
|
- **Parâmetros**:
|
|
- **Parâmetros**:
|
|
- `placa`(string, obrigatório)
|
|
- `placa`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
|
|
- **Requisição Curl**
|
|
|
|
```bash
|
|
|
|
curl -X 'GET' \
|
|
|
|
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/obter-todos-debitos-detalhados/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
|
```
|
|
- **Resposta**
|
|
- **Resposta**
|
|
- `lista`(array)
|
|
- `lista`(array)
|
|
- `descricao`(string): Descrição do débito principal.
|
|
- `descricao`(string): Descrição do débito principal.
|
... | @@ -71,6 +96,8 @@ |
... | @@ -71,6 +96,8 @@ |
|
- `dataVencimento`(DateTime): Data de vencimento do débito.
|
|
- `dataVencimento`(DateTime): Data de vencimento do débito.
|
|
- `valor`(decimal): Valor do débito.
|
|
- `valor`(decimal): Valor do débito.
|
|
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
|
|
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
|
|
|
|
|
|
|
|
**Json Resposta**
|
|
```json
|
|
```json
|
|
[
|
|
[
|
|
{
|
|
{
|
... | @@ -89,13 +116,21 @@ |
... | @@ -89,13 +116,21 @@ |
|
}
|
|
}
|
|
]
|
|
]
|
|
```
|
|
```
|
|
### 4. Obter Todos Tipos de Débitos Detalhados
|
|
|
|
|
|
### 4. Obter Dados do Veículo
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-veiculo`
|
|
- **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-veiculo`
|
|
- **Descrição**: Retorna algumas informações do veículo.
|
|
- **Descrição**: Retorna algumas informações do veículo.
|
|
- **Parâmetros**:
|
|
- **Parâmetros**:
|
|
- `placa`(string, obrigatório)
|
|
- `placa`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
|
|
- **Requisição Curl**
|
|
|
|
```bash
|
|
|
|
curl -X 'GET' \
|
|
|
|
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/obter-veiculo/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
|
```
|
|
- **Resposta**
|
|
- **Resposta**
|
|
- `proprietario` (object): Detalhes do proprietário do veículo.
|
|
- `proprietario` (object): Detalhes do proprietário do veículo.
|
|
- `nome` (string): Nome do proprietário.
|
|
- `nome` (string): Nome do proprietário.
|
... | @@ -104,6 +139,8 @@ |
... | @@ -104,6 +139,8 @@ |
|
- `renavam` (string): Número do Registro Nacional de Veículos Automotores.
|
|
- `renavam` (string): Número do Registro Nacional de Veículos Automotores.
|
|
- `marcaModelo` (string): Marca e modelo do veículo.
|
|
- `marcaModelo` (string): Marca e modelo do veículo.
|
|
- `anoFabricacao` (int): Ano de fabricação do veículo.
|
|
- `anoFabricacao` (int): Ano de fabricação do veículo.
|
|
|
|
|
|
|
|
**Json Resposta**
|
|
```json
|
|
```json
|
|
{
|
|
{
|
|
"proprietario": {
|
|
"proprietario": {
|
... | @@ -125,6 +162,24 @@ |
... | @@ -125,6 +162,24 @@ |
|
- `renavam`(string, obrigatório)
|
|
- `renavam`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `documentoProprietario`(string, obrigatório)
|
|
- `guidsDebito`(array<int>, obrigatório): lista dos guids de débitos que serão pagos. Sendo obrigatório informar todos os guids debitos que estão marcados como pagamento obrigatório.
|
|
- `guidsDebito`(array<int>, obrigatório): lista dos guids de débitos que serão pagos. Sendo obrigatório informar todos os guids debitos que estão marcados como pagamento obrigatório.
|
|
|
|
- **Requisição Curl**
|
|
|
|
```bash
|
|
|
|
curl -X 'PUT' \
|
|
|
|
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/gerar-guia' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}' \
|
|
|
|
-H 'Content-Type: application/json' \
|
|
|
|
-d '{
|
|
|
|
"debitoDevido": "IPVAExercicio",
|
|
|
|
"placa": "string",
|
|
|
|
"renavam": "string",
|
|
|
|
"documentoProprietario": "string",
|
|
|
|
"guidsDebito": [
|
|
|
|
0
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
**Json Requisição**
|
|
```json
|
|
```json
|
|
{
|
|
{
|
|
"debitoDevido": "IPVAExercicio",
|
|
"debitoDevido": "IPVAExercicio",
|
... | @@ -158,6 +213,8 @@ |
... | @@ -158,6 +213,8 @@ |
|
- `valorJuros` (decimal): Valor de juros aplicados.
|
|
- `valorJuros` (decimal): Valor de juros aplicados.
|
|
- `valorMulta` (decimal): Valor da multa aplicada.
|
|
- `valorMulta` (decimal): Valor da multa aplicada.
|
|
- `valorAtualizado` (decimal): Valor total atualizado após correções.
|
|
- `valorAtualizado` (decimal): Valor total atualizado após correções.
|
|
|
|
|
|
|
|
**Json Resposta**
|
|
```json
|
|
```json
|
|
{
|
|
{
|
|
"nome": "string",
|
|
"nome": "string",
|
... | | ... | |