Consultar Declaração/Recibo

Consulta uma declaração/recibo específica com o número identificador da declaração. Nos casos de Multa de Atraso na Entrega da Declaração (MAED) a Notificação e o DARF da MAED serão apresentados nos dados de saída.

Identificação no Pedido de Dados

idSistema: PGDASD
idServico: CONSDECREC15
versaoSistema: "1.0"

Dados de Entrada

Campo: dados

Campo	Descrição	Tipo	Obrigatório
numeroDeclaracao	Número identificador único da declaração.	Texto(17)	SIM

Exemplo: conteúdo body json de entrada

    {
      "contratante": {
        "numero": "00000000000000",
        "tipo": 2
      },
      "autorPedidoDados": {
        "numero": "00000000000000",
        "tipo": 2
      },
      "contribuinte": {
        "numero": "00000000000000",
        "tipo": 2
      },          
      "pedidoDados": {
        "idSistema": "PGDASD",
        "idServico": "CONSDECREC15",
        "versaoSistema": "1.0",
        "dados": "{ \"numeroDeclaracao\": \"00000000201801001\" }"
      }
    }

Dados de Saída (retorno)

Campo	Descrição	Tipo
status	Status HTTP retornado no acionamento do serviço.	Número(3)
mensagens	Mensagem explicativa retornada no acionamento do serviço. É um array composto de Código e texto da mensagem. O campo Código é um Texto de tamanho 5 que representa um código interno do negócio.	Lista de Texto
dados	Estrutura de dados de retorno.	Texto (SCAPED Texto JSON: Declaracao)

Objeto Declaracao:

Campo	Descrição	Tipo
numeroDeclaracao	Identificador único da declaração transmitida.	Texto(17)
recibo	Estrutura de dados do Recibo de entrega da declaração. A saída é um PDF.	Objeto: ArquivoRecibo
declaracao	Estrutura de dados completa da declaração entregue. A saída é um PDF	Objeto: ArquivoDeclaracao

Objeto ArquivoRecibo:

Campo	Descrição	Tipo
nomeArquivo	Nome do arquivo do recibo para ser utilizado no processo de decodificação do base64. Ex. “recibo-pgdasd-{numeroDeclaracao}.pdf”	Texto (28)
pdf	Obtém o arquivo em base 64 para conversão em PDF.	Texto (base64)

Objeto ArquivoDeclaracao:

Campo	Descrição	Tipo
nomeArquivo	Nome do arquivo da declaracao para ser utilizado no processo de decodificação do base64. Ex. “dec-pgdasd-{numeroDeclaracao}.pdf”	Texto (25)
pdf	Obtém o arquivo em base 64 para conversão em PDF.	Texto (base64)

Objeto ArquivoMaed:

Campo	Descrição	Tipo
nomeArquivoNotificacao	Nome do arquivo da notificação da multa da declaracao entregue em atraso. para ser utilizado no processo de decodificação do base64. Ex. “notificacao-maed-pgdasd-{numeroDeclaracao}.pdf”	Texto (50)
pdfNotificacao	Obtém o arquivo em base 64 para conversão em PDF da notificação da MAED.	Texto (base64)
nomeArquivoDarf	Nome do arquivo do DARF da multa da declaracao entregue em atraso. para ser utilizado no processo de decodificação do base64. Ex. “darf-maed-pgdasd-{numeroDeclaracao}.pdf”	Texto (50)
pdfDarf	Obtém o arquivo em base 64 para conversão em PDF da DARF da MAED.	Texto (base64)

Exemplo: conteúdo payload json de saída

Json de exemplo: consultar declaração recibo