Skip to content

Changes

Page history
Update End Points authored by Augusto Barbosa Layber's avatar Augusto Barbosa Layber
Hide whitespace changes
Inline Side-by-side
End-Points.md
View page @ c4986e1d
### 1. Obter Débitos ### 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. - **Descrição**: Retorna todos os tipos de débitos em aberto agrupados.
- **Parâmetros**: - **Parâmetros**:
- `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** - **Requisição Curl**
```bash ```bash
curl -X 'GET' \ 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 'accept: text/plain' \
-H 'Authorization: Bearer {token}' -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"
] ]
``` ```
**Dados de Teste** **Dados de Teste**
``` ```
Placa Renavam Doc. Proprietario Placa Renavam Doc. Proprietario
PPB7B27 1315049861 59370761098 PPB7B27 1315049861 59370761098
MRH8258 922129797 05402930759 MRH8258 922129797 05402930759
MRS0714 945304552 57453349753 MRS0714 945304552 57453349753
MRO5418 941435636 01715031717 MRO5418 941435636 01715031717
MRK5021 930044703 08395206704 MRK5021 930044703 08395206704
MRL0822 275593150 33185573749 MRL0822 275593150 33185573749
MRZ1737 965904008 10352411708 MRZ1737 965904008 10352411708
``` ```
### 2. Detalhar Débito ### 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. - **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
- **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)
- `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** - **Requisição Curl**
```bash ```bash
curl -X 'GET' \ 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 'accept: text/plain' \
-H 'Authorization: Bearer {token}' -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.
- `debitoDevido`(string): Tipo de débito que foi detalhado - `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. - `debitos`(array): A lista de débito que compoem o tipo de débito que foi detalhando.
- `guid`(int): Identificação do débito. - `guid`(int): Identificação do débito.
- `descricao`(string): Descrição do débito. - `descricao`(string): Descrição do débito.
- `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 Resposta**
```json ```json
{ {
"descricao": "string", "descricao": "string",
"exercicio": 0, "exercicio": 0,
"debitoDevido": "IPVAExercicio", "debitoDevido": "IPVAExercicio",
"debitos": [ "debitos": [
{ {
"guid": 0, "guid": 0,
"descricao": "string", "descricao": "string",
"dataVencimento": "2024-06-03T18:21:00.965Z", "dataVencimento": "2024-06-03T18:21:00.965Z",
"valor": 0, "valor": 0,
"pagamentoObrigatorio": true "pagamentoObrigatorio": true
} }
] ]
} }
``` ```
### 3. Obter Todos de Débitos Detalhados ### 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. - **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** - **Requisição Curl**
```bash ```bash
curl -X 'GET' \ 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 'accept: text/plain' \
-H 'Authorization: Bearer {token}' -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.
- `exercicio`(int): Exercício do pagamento do débito principal. - `exercicio`(int): Exercício do pagamento do débito principal.
- `debitoDevido`(string): Tipo de débito que foi detalhado - `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. - `debitos`(array): A lista de débito que compoem o tipo de débito que foi detalhando.
- `guid`(int): Identificação do débito. - `guid`(int): Identificação do débito.
- `descricao`(string): Descrição do débito. - `descricao`(string): Descrição do débito.
- `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 Resposta**
```json ```json
[ [
{ {
"descricao": "string", "descricao": "string",
"exercicio": 0, "exercicio": 0,
"debitoDevido": "IPVAExercicio", "debitoDevido": "IPVAExercicio",
"debitos": [ "debitos": [
{ {
"guid": 0, "guid": 0,
"descricao": "string", "descricao": "string",
"dataVencimento": "2024-06-04T11:03:36.336Z", "dataVencimento": "2024-06-04T11:03:36.336Z",
"valor": 0, "valor": 0,
"pagamentoObrigatorio": true "pagamentoObrigatorio": true
} }
] ]
} }
] ]
``` ```
### 4. Obter Dados do Veículo ### 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. - **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** - **Requisição Curl**
```bash ```bash
curl -X 'GET' \ 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 'accept: text/plain' \
-H 'Authorization: Bearer {token}' -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.
- `docPrincipal` (string): Documento principal do proprietário (CPF ou CNPJ). - `docPrincipal` (string): Documento principal do proprietário (CPF ou CNPJ).
- `placa` (string): Placa do veículo. - `placa` (string): Placa do veículo.
- `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 Resposta**
```json ```json
{ {
"proprietario": { "proprietario": {
"nome": "string", "nome": "string",
"docPrincipal": "string" "docPrincipal": "string"
}, },
"placa": "string", "placa": "string",
"renavam": "string", "renavam": "string",
"marcaModelo": "string", "marcaModelo": "string",
"anoFabricacao": 0 "anoFabricacao": 0
} }
``` ```
### 5. Obter Débitos a Vencer em Lote ### 5. Obter Débitos a Vencer em Lote
- **Endpoint**: `GET /internet-banking/v1/obter-debitos-lote` - **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 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. - **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**: - **Observações**:
- O limite máximo de veículos por lote é de 10.000. - 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. - 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. - 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. - Ao fornecer a lista de veículos, o método sempre retornará a primeira página de resultados.
- **Parâmetros**: - **Parâmetros**:
- `guid`(string, opcional) - Deve ser preenchido para consultar lotes já existentes. - `guid`(string, opcional) - Deve ser preenchido para consultar lotes já existentes.
- `proximaPagina`(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. - `veiculos`(array, opcional) - Deve ser informado para criar o lote na primeira consulta e retornara a primeira página.
- placa (string, obrigatório) - placa (string, obrigatório)
- renavam (bigint, obrigatório) - renavam (bigint, obrigatório)
- documentoProprietario (string, obrigatório) - documentoProprietario (string, obrigatório)
- **Arquivo Para Teste** - **Arquivo Para Teste**
- Um arquivo para teste poderá ser fornecido por e-mail com 10.000 veículos para testar a performasse. - Um arquivo para teste poderá ser fornecido por e-mail com 10.000 veículos para testar a performasse.
- **Requisição Curl** - **Requisição Curl**
```bash ```bash
curl -X 'POST' \ 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 'accept: text/plain' \
-H 'Authorization: Bearer {token}' \ -H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-d '{ -d '{
"guid": "string", "guid": "string",
"proximaPagina": 0, "proximaPagina": 0,
"veiculos": [ "veiculos": [
{ {
"placa": "string", "placa": "string",
"renavam": 0, "renavam": 0,
"documentoProprietario": "string" "documentoProprietario": "string"
} }
] ]
} }
``` ```
**Json Requisição** **Json Requisição**
```json ```json
{ {
"guid": "string", "guid": "string",
"proximaPagina": 0, "proximaPagina": 0,
"veiculos": [ "veiculos": [
{ {
"placa": "string", "placa": "string",
"renavam": 0, "renavam": 0,
"documentoProprietario": "string" "documentoProprietario": "string"
} }
] ]
} }
``` ```
- **Resposta** - **Resposta**
- `guid` (string): Identificador do lote consultado. - `guid` (string): Identificador do lote consultado.
- `paginaAtual` (int): A página atual consultada. - `paginaAtual` (int): A página atual consultada.
- `proximaPagina` (int): A próxima página a ser consultada. - `proximaPagina` (int): A próxima página a ser consultada.
- `fimLote` (bool): Retorna verdadeiro quando for a última página. - `fimLote` (bool): Retorna verdadeiro quando for a última página.
- `totalPaginas` (int): Total de páginas no lote. - `totalPaginas` (int): Total de páginas no lote.
- `totalRegistros` (int): Total de registros no lote. - `totalRegistros` (int): Total de registros no lote.
- `veiculos` (array): Veículos consultados no lote. - `veiculos` (array): Veículos consultados no lote.
- `placa` (string): Placa para identificação do veículo. - `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. - `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. - `debitos` (array): A lista de débitos.
- `guid` (int): Identificação do débito. - `guid` (int): Identificação do débito.
- `exercicio` (int): Ano do exercício do débito. - `exercicio` (int): Ano do exercício do débito.
- `descricaoServico` (string): Descrição do serviço referente ao débito. - `descricaoServico` (string): Descrição do serviço referente ao débito.
- `parcela` (int): Parcela do débito. - `parcela` (int): Parcela do débito.
- `valor` (decimal): Valor do débito até a data de vencimento. - `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). - `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. - **Detalhes de Paginação**
- `fimLote` (bool): Retorna verdadeiro quando a página atual é a última do lote. Isso indica que não há mais páginas para serem consultadas. - `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.
- `fimLote` (bool): Retorna verdadeiro quando a página atual é a última do lote. Isso indica que não há mais páginas para serem consultadas.
Essas propriedades são necessárias porque o número de páginas e de débitos pode variar de uma consulta para outra, já que cada página busca os débitos em aberto em tempo real.
Essas propriedades são necessárias porque o número de páginas e de débitos pode variar de uma consulta para outra, já que cada página busca os débitos em aberto em tempo real.
- **Tratamento de Erro**
- **Tratamento de Erro**
Para não invalidar um lote inteiro iremos tratar os erro de validação dos veículos no retorno de cada veiculo. Os códigos de erros serão:
| Código | Mensagem | Para não invalidar um lote inteiro iremos tratar os erro de validação dos veículos no retorno de cada veiculo. Os códigos de erros serão:
|---------|-------------------------------------------------------------------------------------------------------------------------| | Código | Mensagem |
| JHL09B2 | Veículo não foi encontrado na base do DETRAN-ES. | |---------|-------------------------------------------------------------------------------------------------------------------------|
| GF4L97H | O RENAVAM informado não é do veículo consultado. | | JHL09B2 | Veículo não foi encontrado na base do DETRAN-ES. |
| BN63UL7 | O Documento informado não é do proprietário do veículo. | | GF4L97H | O RENAVAM informado não é do veículo consultado. |
| BN63UL7 | O Documento informado não é do proprietário do veículo. |
**Json Resposta**
```json **Json Resposta**
{ ```json
"guid": "string", {
"paginaAtual": 0, "guid": "string",
"proximaPagina": 0, "paginaAtual": 0,
"fimLote": true, "proximaPagina": 0,
"totalPaginas": 0, "fimLote": true,
"totalRegistros": 0, "totalPaginas": 0,
"veiculos": [ "totalRegistros": 0,
{ "veiculos": [
"placa": "string", {
"codigoErro": "string", "placa": "string",
"debitos": [ "codigoErro": "string",
{ "debitos": [
"guid": 0, {
"exercicio": 0, "guid": 0,
"descricaoServico": "string", "exercicio": 0,
"parcela": 0, "descricaoServico": "string",
"valor": 0, "parcela": 0,
"dataVencimento": "2024-09-19T20:04:26.756Z" "valor": 0,
} "dataVencimento": "2024-09-19T20:04:26.756Z"
] }
} ]
] }
} ]
``` }
### 6. Gerar Guia de Pagamento ```
- **Endpoint**: `PUT/internet-banking/v1/gerar-guia` ### 6. Gerar Guia de Pagamento
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito. - **Endpoint**: `PUT/banestes/internet-banking/v1/gerar-guia`
- **Parâmetros**: - **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
- `debitoDevido`(string, obrigatório) - **Parâmetros**:
- `placa`(string, obrigatório) - `debitoDevido`(string, obrigatório)
- `renavam`(string, obrigatório) - `placa`(string, obrigatório)
- `documentoProprietario`(string, obrigatório) - `renavam`(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. - `documentoProprietario`(string, obrigatório)
- **Requisição Curl** - `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.
```bash - **Requisição Curl**
curl -X 'PUT' \ ```bash
'https://api.guia.detrannet.hom.es.gov.br/internet-banking/v1/gerar-guia' \ curl -X 'PUT' \
-H 'accept: text/plain' \ 'https://api.guia.detrannet.hom.es.gov.br/banestes/internet-banking/v1/gerar-guia' \
-H 'Authorization: Bearer {token}' \ -H 'accept: text/plain' \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {token}' \
-d '{ -H 'Content-Type: application/json' \
"debitoDevido": "IPVAExercicio", -d '{
"placa": "string", "debitoDevido": "IPVAExercicio",
"renavam": "string", "placa": "string",
"documentoProprietario": "string", "renavam": "string",
"guidsDebito": [ "documentoProprietario": "string",
0 "guidsDebito": [
] 0
} ]
``` }
**Json Requisição** ```
```json **Json Requisição**
{ ```json
"debitoDevido": "IPVAExercicio", {
"placa": "string", "debitoDevido": "IPVAExercicio",
"renavam": "string", "placa": "string",
"documentoProprietario": "string", "renavam": "string",
"guidsDebito": [ "documentoProprietario": "string",
0 "guidsDebito": [
] 0
} ]
``` }
- **Resposta** ```
- `nome` (string): Nome associado ao registro. - **Resposta**
- `placa` (string): Placa do veículo. - `nome` (string): Nome associado ao registro.
- `renavam` (string): Número do Registro Nacional de Veículos Automotores. - `placa` (string): Placa do veículo.
- `marcaModelo` (string): Marca e modelo do veículo. - `renavam` (string): Número do Registro Nacional de Veículos Automotores.
- `pixCode` (string): Código PIX para realização de pagamentos. - `marcaModelo` (string): Marca e modelo do veículo.
- `codigoBarra` (base64): Código de barras para pagamento. - `pixCode` (string): Código PIX para realização de pagamentos.
- `linhaDigitavel` (string): Linha digitável do código de barras. - `codigoBarra` (base64): Código de barras para pagamento.
- `numero` (string): Número do documento ou do registro. - `linhaDigitavel` (string): Linha digitável do código de barras.
- `dataVencimento` (string): Data de vencimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ). - `numero` (string): Número do documento ou do registro.
- `valor` (decimal): Valor total a ser pago. - `dataVencimento` (string): Data de vencimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ).
- `guid` (string): Identificador único global para o registro. - `valor` (decimal): Valor total a ser pago.
- `pdfBase64` (base64): Documento associado em formato PDF codificado em base64. - `guid` (string): Identificador único global para o registro.
- `composicao` (array<object>, obrigatório): Lista detalhando a composição do débito. - `pdfBase64` (base64): Documento associado em formato PDF codificado em base64.
- `descricaoDebito` (string): Descrição do débito. - `composicao` (array<object>, obrigatório): Lista detalhando a composição do débito.
- `datavencimento` (string): Data de vencimento específica do débito no formato ISO 8601. - `descricaoDebito` (string): Descrição do débito.
- `valorvencimento` (decimal): Valor original de vencimento. - `datavencimento` (string): Data de vencimento específica do débito no formato ISO 8601.
- `valorCorrigido` (decimal): Valor corrigido com acréscimos ou deduções. - `valorvencimento` (decimal): Valor original de vencimento.
- `valorDesconto` (decimal): Valor de desconto aplicado. - `valorCorrigido` (decimal): Valor corrigido com acréscimos ou deduções.
- `valorJuros` (decimal): Valor de juros aplicados. - `valorDesconto` (decimal): Valor de desconto aplicado.
- `valorMulta` (decimal): Valor da multa aplicada. - `valorJuros` (decimal): Valor de juros aplicados.
- `valorAtualizado` (decimal): Valor total atualizado após correções. - `valorMulta` (decimal): Valor da multa aplicada.
- `valorAtualizado` (decimal): Valor total atualizado após correções.
**Json Resposta**
```json **Json Resposta**
{ ```json
"nome": "string", {
"placa": "string", "nome": "string",
"renavam": "string", "placa": "string",
"marcaModelo": "string", "renavam": "string",
"pixCode": "string", "marcaModelo": "string",
"codigoBarra": "string", "pixCode": "string",
"linhaDigitavel": "string", "codigoBarra": "string",
"numero": "string", "linhaDigitavel": "string",
"dataVencimento": "2024-06-04T11:05:24.653Z", "numero": "string",
"valor": 0, "dataVencimento": "2024-06-04T11:05:24.653Z",
"guid": "string", "valor": 0,
"pdfBase64": "string", "guid": "string",
"composicao": [ "pdfBase64": "string",
{ "composicao": [
"descricaoDebito": "string", {
"datavencimento": "2024-06-04T11:05:24.653Z", "descricaoDebito": "string",
"valorvencimento": 0, "datavencimento": "2024-06-04T11:05:24.653Z",
"valorCorrigido": 0, "valorvencimento": 0,
"valorDesconto": 0, "valorCorrigido": 0,
"valorJuros": 0, "valorDesconto": 0,
"valorMulta": 0, "valorJuros": 0,
"valorAtualizado": 0 "valorMulta": 0,
} "valorAtualizado": 0
] }
} ]
}
``` ```
\ No newline at end of file