|
|
|
### 1. Verificar Débitos
|
|
|
|
- **Endpoint**: `GET /guia-pagamento/cd/v1/verificar-debitos/{placa}/{renavam}/{documentoProprietario}`
|
|
|
|
- **Descrição**: Retorna todos os tipos de débitos que o veículo possui.
|
|
|
|
- **Parâmetros**:
|
|
|
|
- `placa`(string, obrigatório): Identificação do veículo.
|
|
|
|
- `renavam`(string, obrigatório): Registro Nacional de Veículos Automotores.
|
|
|
|
- `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/cd/v1/verificar-debitos/{placa}/{renavam}/{documentoProprietario}' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
|
```
|
|
|
|
- **Resposta**
|
|
|
|
- Array<Enum<string>>
|
|
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
|
|
**Json Resposta**
|
|
|
|
```json
|
|
|
|
[
|
|
|
|
"IPVAExercicio",
|
|
|
|
"LicenciamentoExercicio"
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
### 2. Obter Tipo de Débito Detalhado
|
|
|
|
- **Endpoint**: `GET /guia-pagamento/cd/v1/obter-tipo-debito-detalhado`
|
|
|
|
- **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
|
|
|
|
- **Parâmetros**:
|
|
|
|
- `placa`(string, obrigatório)
|
|
|
|
- `renavam`(string, obrigatório)
|
|
|
|
- `documentoProprietario`(string, obrigatório)
|
|
|
|
- `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/cd/v1/obter-tipo-debito-detalhado/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}'
|
|
|
|
```
|
|
|
|
- **Resposta**
|
|
|
|
- `descricao`(string): Descrição do débito principal.
|
|
|
|
- `exercicio`(int): Exercício do pagamento do débito principal.
|
|
|
|
- `debitoDevido`(string): Tipo de débito que foi detalhado
|
|
|
|
- `debitos`(array): A lista de débito que compoem o tipo de débito que foi detalhando.
|
|
|
|
- `guid`(int): Identificação do débito.
|
|
|
|
- `descricao`(string): Descrição do débito.
|
|
|
|
- `dataVencimento`(DateTime): Data de vencimento do débito.
|
|
|
|
- `valor`(decimal): Valor do débito.
|
|
|
|
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
|
|
|
|
**Json Resposta**
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"descricao": "string",
|
|
|
|
"exercicio": 0,
|
|
|
|
"debitoDevido": "IPVAExercicio",
|
|
|
|
"debitos": [
|
|
|
|
{
|
|
|
|
"guid": 0,
|
|
|
|
"descricao": "string",
|
|
|
|
"dataVencimento": "2024-06-03T18:21:00.965Z",
|
|
|
|
"valor": 0,
|
|
|
|
"pagamentoObrigatorio": true
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
### 3. Gerar Guia de Pagamento
|
|
|
|
- **Endpoint**: `PUT/guia-pagamento/cd/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)
|
|
|
|
- `placa`(string, obrigatório)
|
|
|
|
- `renavam`(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.
|
|
|
|
- **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
|
|
|
|
{
|
|
|
|
"debitoDevido": "IPVAExercicio",
|
|
|
|
"placa": "string",
|
|
|
|
"renavam": "string",
|
|
|
|
"documentoProprietario": "string",
|
|
|
|
"guidsDebito": [
|
|
|
|
0
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
- **Resposta**
|
|
|
|
- `nome` (string): Nome associado ao registro.
|
|
|
|
- `placa` (string): Placa do veículo.
|
|
|
|
- `renavam` (string): Número do Registro Nacional de Veículos Automotores.
|
|
|
|
- `marcaModelo` (string): Marca e modelo do veículo.
|
|
|
|
- `pixCode` (string): Código PIX para realização de pagamentos.
|
|
|
|
- `codigoBarra` (base64): Código de barras para pagamento.
|
|
|
|
- `linhaDigitavel` (string): Linha digitável do código de barras.
|
|
|
|
- `numero` (string): Número do documento ou do registro.
|
|
|
|
- `dataVencimento` (string): Data de vencimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ).
|
|
|
|
- `valor` (decimal): Valor total a ser pago.
|
|
|
|
- `guid` (string): Identificador único global para o registro.
|
|
|
|
- `pdfBase64` (base64): Documento associado em formato PDF codificado em base64.
|
|
|
|
- `composicao` (array<object>, obrigatório): Lista detalhando a composição do débito.
|
|
|
|
- `descricaoDebito` (string): Descrição do débito.
|
|
|
|
- `datavencimento` (string): Data de vencimento específica do débito no formato ISO 8601.
|
|
|
|
- `valorvencimento` (decimal): Valor original de vencimento.
|
|
|
|
- `valorCorrigido` (decimal): Valor corrigido com acréscimos ou deduções.
|
|
|
|
- `valorDesconto` (decimal): Valor de desconto aplicado.
|
|
|
|
- `valorJuros` (decimal): Valor de juros aplicados.
|
|
|
|
- `valorMulta` (decimal): Valor da multa aplicada.
|
|
|
|
- `valorAtualizado` (decimal): Valor total atualizado após correções.
|
|
|
|
|
|
|
|
**Json Resposta**
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"nome": "string",
|
|
|
|
"placa": "string",
|
|
|
|
"renavam": "string",
|
|
|
|
"marcaModelo": "string",
|
|
|
|
"pixCode": "string",
|
|
|
|
"codigoBarra": "string",
|
|
|
|
"linhaDigitavel": "string",
|
|
|
|
"numero": "string",
|
|
|
|
"dataVencimento": "2024-06-04T11:05:24.653Z",
|
|
|
|
"valor": 0,
|
|
|
|
"guid": "string",
|
|
|
|
"pdfBase64": "string",
|
|
|
|
"composicao": [
|
|
|
|
{
|
|
|
|
"descricaoDebito": "string",
|
|
|
|
"datavencimento": "2024-06-04T11:05:24.653Z",
|
|
|
|
"valorvencimento": 0,
|
|
|
|
"valorCorrigido": 0,
|
|
|
|
"valorDesconto": 0,
|
|
|
|
"valorJuros": 0,
|
|
|
|
"valorMulta": 0,
|
|
|
|
"valorAtualizado": 0
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
``` |
|
|
|
\ No newline at end of file |
