post
https://gateway.besinky.com/api/sandbox/public-api/consulta/8
Descrição
A Consulta de Certidão do IRT retorna informações sobre débitos relativos a tributos federais e à dívida ativa da União vinculados a um Imóvel Rural.
O retorno pode indicar:
- “Nada Consta”, quando não há débitos ou pendências;
- Ou a existência de débitos inscritos, quando aplicável.
Para a realização desta consulta é obrigatório informar o NIRF em conjunto com o CPF. Caso o NIRF não seja fornecido, nenhuma informação será retornada
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
Campo Descrição Valores Possíveis Tipo de Campo document Documento de identificação CPF Obrigatório type Identificador do tipo de consulta ADVANCED, ADDITIONAL_INPUTS Obrigatório subproducts Array de Slugs dos subprodutos que serão inclusos na busca ["certidao-irt-pf"] Obrigatório
Quando o parâmetro type for definido como ADVANCED, a resposta incluirá os dados da Consulta Básica.
Quando definido como ADDITIONAL_INPUTS, a resposta conterá apenas os subprodutos e providers explicitamente informados na requisição.
Corpo da Resposta
| Campo | Tipo | Descrição | |
|---|---|---|---|
ticketId | string | Identificador da consulta | |
executadoEm | date | Data e hora da execução da consulta | |
status | string | 'Executado' | 'Executado com exceção'. Em caso de execução com exceção o campo exceptions será preenchido, porém a request retorna sucesso |
resultado | object | Resposta da Consulta Básica | |
exceptions | array<object> | Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando status = 'Executado com exceção' |
Estrutura de exceptions
exceptions| Campo | Tipo | Descrição |
|---|---|---|
message | string | Descrição do erro ocorrido. Exemplos: "Os slugs informados estão inativos.", "Os slugs informados não foram encontrados." |
slugs | array<string> | Lista dos slugs que ocasionaram a exceção |
Estrutura de resultado
resultado| Campo | Tipo | Descrição |
|---|---|---|
| certidao-irt-pf | object | Lista com os detalhes do documento consultado |
Estrutura de certidao-irt-pf
certidao-irt-pf| Campo | Tipo | Descrição |
|---|---|---|
| name | string | Nome do subproduto consultado |
| status | integer | Status Code da Requisição |
| Result | object | Lista com os detalhes da consulta |
Estrutura de Result
Result| Nome | Tipo | Descrição |
|---|---|---|
| QueryId | string | Id único identificador da chamada. |
| ElapsedMilliseconds | number | A quantidade de milissegundos decorridos durante a chamada. |
| QueryDate | string | A data de quando o request foi recebido e processado. |
| Status | object | Lista de status para cada dataset. |
| OnlineCertificates | array of objects | Lista de certificados online retornados pela consulta. |
Estrutura de OnlineCertificates
OnlineCertificates| Campo | Tipo | Descrição |
|---|---|---|
| Origin | string | Fonte dos Dados Entregues. |
| InputParameters | string | Parâmetros de entrada. |
| ProtocolNumber | string | Número de protocolo da certidão emitida. |
| BaseStatus | string | Status simplificado da certidão emitida. |
| AdditionalOutputData | object | Dados adicionais. |
| QueryDate | string | Data de realização da consulta. |