Ir para o conteúdo

Consultar Declarações Transmitidas por Ano-Calendário ou Período de Apuração

Essa consulta lista um índice com todas as declarações transmitidas na base de dados da RFB de um contribuinte para um determinado ano-calendário ou período de apuração mensal do PGDAS-D por tipo de operação (Declaração Original, Declaração Retificadora, Geração de DAS, DAS Avulso, DAS Medida Judicial).

PedidoDados

idSistema: PGDASD
idServico: CONSDECLARACAO13
versaoSistema: "1.0"

Dados de Entrada

Quando pesquisado por ano-calendário:

Objeto Dados:

Campo Descrição Tipo Obrigatório
anoCalendario Ano-calendário da declaração. Quando for utilizado o ano-calendário no parâmetro da realização da consulta. Texto(4) 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": "CONSDECLARACAO13",
        "versaoSistema": "1.0",
        "dados": "{ \"anoCalendario\": \"2018\" }"
      }
    }

Quando pesquisado por período de apuração:

Objeto Dados:

Campo Descrição Tipo Obrigatório
periodoApuracao Período da apuração mensal. Quando for utilizado o periodo da apuração no parâmetro da realização da consulta. Texto(6) 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": "CONSDECLARACAO13",
        "versaoSistema": "1.0",
        "dados": "{ \"periodoApuracao\": \"201801\" }"
      }
    }

Dados de Saída

A estrutura de dados retornada é a mesma nos casos de pesquisa por ano-calendário ou período de apuração. O que muda é a quantidade itens retornados.

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: DeclaracoesEntregues)

Objeto: DeclaracoesEntregues

Campo Descrição Tipo
anoCalendario Ano-calendário. Número (4)
periodos Contém uma lista de declarações em um determinado período de apuração (PA). Quando for utilizado o ano-calendário no parâmetro da realização da consulta. Lista de Objeto: Periodo
periodo Contém apenas um período de apuração (PA). Quando for utilizado o periodo da apuração no parâmetro da realização da consulta. Objeto: Periodo

Objeto Periodo:

Campo Descrição Tipo
periodoApuracao Período da apuração, formato AAAAMM. Número (6)
operacoes Lista todas as operações realizadas no período de apuração. Lista de Objeto: Operacao

Objeto Operacao:

Campo Descrição Tipo
tipoOperacao Tipo da operação realizada: (Declaração Original; Declaração Retificadora; Geração de DAS; DAS Avulso, DAS Medida Judicial ou DAS Cobrança). Texto (30)
indiceDeclaracao Estrutura de dados da declaração.Objeto: IndiceDeclaracao indiceDas Estrutura de dados do DAS. Objeto: IndiceDas

Objeto IndiceDeclaracao:

Campo Descrição Tipo
numeroDeclaracao Identificador único da declaração transmitida. Texto (17)
dataHoraTransmissao Data e hora da entrega à RFB. Formato yyyyMMddHHmmss. Número(14)
malha Situação da malha quando aplicável: (Retida em Malha; Liberada, Intimada ou Rejeitada). A situação Liberada contempla 3 situações diferentes, liberada sem análise, liberada por alteração de parâmetros e aceita. Quando não está em Malha o campo retorna null. Texto (30)

Objeto IndiceDas:

Campo Descrição Tipo
numeroDas Número do DAS (Documento de Arrecadação do Simples Nacional). Texto(17)
dataHoraEmissaoDas Data e hora da emissão do DAS. Formato yyyyMMddHHmmss. Número(14)
dasPago Informa se houve ou não pagamento do DAS até o momento da consulta. Pago (true) e não consta pagamento até o momento (false). Boleano

Exemplo: conteúdo payload json de saída

Json de exemplo: índice de declarações recibo