... | ... | @@ -11,10 +11,9 @@ Aqui estão os principais endpoints da nossa API: |
|
|
# Detalhes do Endpoint: 'v1/verificar-debitos'
|
|
|
|
|
|
### Descrição
|
|
|
Retorna a lista dos tipos de débitos em aberto que o veículo possui.
|
|
|
Retorna a lista dos tipos de débitos devidos do veículo consultado. Está lista pode conter um ou mais registros, pois para cada tipo de débito devido existem os débitos que são obrigatórios para a quitação dos débitos.
|
|
|
|
|
|
### Parâmetros
|
|
|
|
|
|
- `placa` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
- `renavam` (obrigatório)
|
... | ... | @@ -30,9 +29,8 @@ curl -X 'GET' \ |
|
|
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
|
|
|
```
|
|
|
|
|
|
### Exemplo de Resposta
|
|
|
- `DebitoDevido` (obrigatório)
|
|
|
- Tipo: `Array<string>`
|
|
|
### Resposta
|
|
|
- DebitoDevido (Array<Enum>): Tipo do débito devido, neste caso, "IPVAExercicio" e "LicenciamentoExercicio".
|
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
|
```json
|
|
|
[
|
... | ... | @@ -56,7 +54,7 @@ Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma |
|
|
- `503 Service Unavailable` - Servidor não está pronto para requisição
|
|
|
```
|
|
|
|
|
|
# Detalhes do Endpoint: 'GET guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado'
|
|
|
# Detalhes do Endpoint: 'v1/obter-tipo-debito-detalhado'
|
|
|
|
|
|
### Descrição
|
|
|
Retorna a lista de débitos de um tipo especifico.
|
... | ... | @@ -70,11 +68,11 @@ Retorna a lista de débitos de um tipo especifico. |
|
|
- `documentoProprietario` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
- `debitoDevido` (obrigatório)
|
|
|
- Tipo: `string`
|
|
|
- Tipo: `Enum<string>`
|
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
|
- Observação: Deve-se informar apenas um tipo de débito devido.
|
|
|
|
|
|
### Exemplo de Requisição
|
|
|
### Requisição
|
|
|
|
|
|
```bash
|
|
|
curl -X 'GET' \
|
... | ... | @@ -83,7 +81,17 @@ curl -X 'GET' \ |
|
|
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
|
|
|
```
|
|
|
|
|
|
### Exemplo de Resposta
|
|
|
### Resposta
|
|
|
- Descricao (string): Uma breve descrição do débito devido.
|
|
|
- Exercicio (integer): Ano do exercício referente ao débito.
|
|
|
- DebitoDevido (Enum): Tipo do débito devido, neste caso, "IPVAExercicio".
|
|
|
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
|
|
|
- Debitos (array): Lista de débitos associados.
|
|
|
- Guid (integer): Identificador único do débito.
|
|
|
- Descricao (string): Descrição do débito.
|
|
|
- DataVencimento (string, formato datetime): Data de vencimento do débito.
|
|
|
- Valor (decimal): Valor do débito.
|
|
|
- PagamentoObrigatorio (boolean): Indica se o pagamento é obrigatório.
|
|
|
```json
|
|
|
{
|
|
|
"descricao": "string",
|
... | ... | |