| ... | ... | @@ -165,7 +165,105 @@ curl -X 'GET' \ |
|
|
|
"anoFabricacao": 0
|
|
|
|
}
|
|
|
|
```
|
|
|
|
### 5. Gerar Guia de Pagamento
|
|
|
|
### 5. Obter Débitos Por Lote de Placas
|
|
|
|
- **Endpoint**: `GET /internet-banking/v1/obter-lote-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 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.
|
|
|
|
|
|
|
|
- **Regras**:
|
|
|
|
- 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.
|
|
|
|
- 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.
|
|
|
|
|
|
|
|
- **Parâmetros**:
|
|
|
|
- `guid`(string, opcional) - Deve ser preenchido para consultar lotes já existentes.
|
|
|
|
- `proximaPagina`(string, opcional) - Deve ser preenchido para consultar lotes já existentes.
|
|
|
|
- `veiculos`(array, opcional) - Deve ser informado para criar o lote na primeira consulta e retornara a primeira página.
|
|
|
|
- placa (string, obrigatório)
|
|
|
|
- renavam (bigint, obrigatório)
|
|
|
|
- documentoProprietario (string, obrigatório)
|
|
|
|
|
|
|
|
- **Requisição Curl**
|
|
|
|
```bash
|
|
|
|
curl -X 'POST' \
|
|
|
|
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/obter-lote-debitos' \
|
|
|
|
-H 'accept: text/plain' \
|
|
|
|
-H 'Authorization: Bearer {token}' \
|
|
|
|
-H 'Content-Type: application/json' \
|
|
|
|
-d '{
|
|
|
|
"identificacao": "string",
|
|
|
|
"proximaPagina": 0,
|
|
|
|
"veiculos": [
|
|
|
|
{
|
|
|
|
"placa": "string",
|
|
|
|
"renavam": 0,
|
|
|
|
"documentoProprietario": "string"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
**Json Requisição**
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"guid": "string",
|
|
|
|
"proximaPagina": 0,
|
|
|
|
"veiculos": [
|
|
|
|
{
|
|
|
|
"placa": "string",
|
|
|
|
"renavam": 0,
|
|
|
|
"documentoProprietario": "string"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
- **Resposta**
|
|
|
|
- `guid` (string): Identificador do lote consultado.
|
|
|
|
- `paginaAtual` (int): A página atual consultada.
|
|
|
|
- `proximaPagina` (int): A próxima página a ser consultada.
|
|
|
|
- `fimLote` (bool): Retorna verdadeiro quando for a última página.
|
|
|
|
- `totalPaginas` (int): Total de páginas no lote.
|
|
|
|
- `totalRegistros` (int): Total de registros no lote.
|
|
|
|
- `veiculos` (array): Veículos consultados no lote.
|
|
|
|
- `placa` (string): Placa para identificação do veículo.
|
|
|
|
- `codigoErro` (string): Retorna um código quando não for possível consultar os débitos de algum veículo, para identificar o erro.
|
|
|
|
- `debitos` (array): A lista de débitos.
|
|
|
|
- `guid` (int): Identificação do débito.
|
|
|
|
- `exercicio` (int): Ano do exercício do débito.
|
|
|
|
- `descricaoServico` (string): Descrição do serviço referente ao débito.
|
|
|
|
- `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).
|
|
|
|
|
|
|
|
**Json Resposta**
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"guid": "string",
|
|
|
|
"paginaAtual": 0,
|
|
|
|
"proximaPagina": 0,
|
|
|
|
"fimLote": true,
|
|
|
|
"totalPaginas": 0,
|
|
|
|
"totalRegistros": 0,
|
|
|
|
"veiculos": [
|
|
|
|
{
|
|
|
|
"placa": "string",
|
|
|
|
"codigoErro": "string",
|
|
|
|
"debitos": [
|
|
|
|
{
|
|
|
|
"guid": 0,
|
|
|
|
"exercicio": 0,
|
|
|
|
"descricaoServico": "string",
|
|
|
|
"parcela": 0,
|
|
|
|
"valor": 0,
|
|
|
|
"dataVencimento": "2024-09-19T20:04:26.756Z"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
### 6. Gerar Guia de Pagamento
|
|
|
|
- **Endpoint**: `PUT/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**:
|
| ... | ... | |
