## ECAC / DCTF WEB
Consulta a relação de declarações no Centro Virtual de Atendimento (eCAC) e emite a guia de pagamento para as declarações com situação ativa, utilizando o login GOV.br via certificado digital. O campo 'numero_paginas' tem um limite máximo de 15 páginas.


### Site URL
- https://cav.receita.fazenda.gov.br/ecac/Aplicacao.aspx?id=10015&origem=pesquisa

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/ecac/dctf-web`



| Parameter                  | Description                                                                                                                                                                                                                        |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*                     | The token that will authenticate and authorize the request.                                                                                                                                                                        |
| pkcs12_cert*               | Content of the encrypted A1 digital certificate file following <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">the encryption instructions</a>.                                                      |
| pkcs12_pass*               | Password of the encrypted A1 digital certificate following <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">the encryption instructions</a>.                                                          |
| data_inicial_apuracao**    | Data inicial da apuração deve estar no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido.   |
| data_final_apuracao**      | Data final da apuração deve estar no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido.     |
| data_inicial_transmissao** | Data inicial da tramitação deve estar no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido. |
| data_final_transmissao**   | Data final da tramitação deve estar no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido.   |
| perfil_procurador_cnpj**   | Caso deseje alterar o perfil de acesso no eCAC como procurador de uma pessoa jurídica, informe neste campo o CNPJ da empresa.                                                                                                      |
| perfil_procurador_cpf**    | Caso deseje alterar o perfil de acesso no eCAC como procurador de uma pessoa física, informe neste campo o CPF da pessoa.                                                                                                          |
| categoria_declaracao**     | Informe exatamente como é escrito no portal de origem. Se não for informado será retornado declarações de todas as categorias.                                                                                                     |
| situacoes_declaracao**     | Informe exatamente como é escrito no portal de origem. Para informar mais de uma situação separe-ás utilizando uma vírgula (,). Se não for informado será retornado declarações de todas as situações.                             |
| numero_recibo**            | Numero_recibo                                                                                                                                                                                                                      |
| pagina**                   | Informe a página que deseja consultar. Se não informado por padrão será retornada a página 1.                                                                                                                                      |

> * Required parameter.

> ** Optional parameter. Sometimes it is necessary to set at least one of the optional parameters for the service to work properly.


### Response examples (OK)
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": {
    "api_version": "v2",
    "api_version_full": "2.2.20-20240904174622",
    "product": "Consultas",
    "service": "ecac/dctf-web",
    "parameters": {
      "pkcs12_cert_md5": "aa25eae9298a43740f9a763477c20a1f",
      "pkcs12_pass_md5": "c9c59c5246576b81c3f2712100204dec"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.28",
    "requested_at": "2024-09-05T11:47:26.000-03:00",
    "elapsed_time_in_milliseconds": 421,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX19OKuLwl0WQdBVpE0mcD/UCICSCmHd9nf7n2daW17esi/EP+hCqH4D3aYFH8j3oD3qUK6mrYTfXmg=="
  },
  "data_count": 1,
  "data": [
    {
      "declaracoes": [
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "41.072,17",
          "origem": "eSocial",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "41.072,17",
          "situacao": "Em andamento",
          "tipo": "Original",
          "normalizado_saldo_pagar": 41072.17,
          "normalizado_debito_apurado": 41072.17
        },
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "42.336,30",
          "origem": "eSocial, REINF CP, REINF RET",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "42.336,30",
          "situacao": "Ativa",
          "tipo": "Retificadora",
          "normalizado_saldo_pagar": 42336.3,
          "normalizado_debito_apurado": 42336.3
        },
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "39.687,75",
          "origem": "eSocial, REINF CP, REINF RET",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "39.687,75",
          "situacao": "Ativa",
          "tipo": "Retificadora",
          "normalizado_saldo_pagar": 39687.75,
          "normalizado_debito_apurado": 39687.75
        },
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "37.746,06",
          "origem": "eSocial, REINF CP, REINF RET",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "37.746,06",
          "situacao": "Ativa",
          "tipo": "Retificadora",
          "normalizado_saldo_pagar": 37746.06,
          "normalizado_debito_apurado": 37746.06
        },
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "37.688,91",
          "origem": "eSocial, REINF CP, REINF RET",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "37.688,91",
          "situacao": "Ativa",
          "tipo": "Retificadora",
          "normalizado_saldo_pagar": 37688.91,
          "normalizado_debito_apurado": 37688.91
        },
        {
          "categoria": "Geral",
          "datahora_transmissao": "11/11/1111",
          "debito_apurado": "38.169,13",
          "origem": "eSocial, REINF CP, REINF RET",
          "periodo_apuracao": "1111-11-11",
          "saldo_pagar": "38.107,09",
          "situacao": "Ativa",
          "tipo": "Retificadora",
          "normalizado_saldo_pagar": 38107.09,
          "normalizado_debito_apurado": 38169.13
        }
      ],
      "relatorios_url": [
        {
          "url": "https://www.exemplo.com/exemplo-de-url",
          "data": "11/11/1111"
        }
      ],
      "declaracoes_url": [
        {
          "url": "https://www.exemplo.com/exemplo-de-url",
          "data": "11/11/1111"
        }
      ],
      "file_byte_size": 605,
      "numero_paginas": 1,
      "mensagem_emissao": "Exemplo de texto",
      "quantidade_declaracoes": 6,
      "zip_file_url": "https://www.exemplo.com/exemplo-de-url",
      "site_receipt": "https://www.exemplo.com/exemplo-de-url"
    }
  ],
  "site_receipts": [
    "https://www.exemplo.com/exemplo-de-url"
  ]
}
```


### Preview file

The preview file (`site_receipts`) in the response JSON is **generated by the source (website/app)** that processed the automation.

### Code snippets


#### Python
```python
# Tested with: Python 3.10.19, Python 3.14.0
import requests
import base64
# pip install aes-bridge
import aes_bridge

url = 'https://api.infosimples.com/api/v2/consultas/ecac/dctf-web'
args = {
  "pkcs12_cert":              aes_bridge.encrypt(base64.b64encode(open("certificate.pfx", "rb").read()).decode(), "ENCRYPTION_KEY").decode("ascii").replace("+", "-").replace("/", "_").rstrip("="),
  "pkcs12_pass":              aes_bridge.encrypt("CERTIFICATE_PASSWORD", "ENCRYPTION_KEY").decode("ascii").replace("+", "-").replace("/", "_").rstrip("="),
  "data_inicial_apuracao":    "VALUE_OF_PARAMETER_DATA_INICIAL_APURACAO",
  "data_final_apuracao":      "VALUE_OF_PARAMETER_DATA_FINAL_APURACAO",
  "data_inicial_transmissao": "VALUE_OF_PARAMETER_DATA_INICIAL_TRANSMISSAO",
  "data_final_transmissao":   "VALUE_OF_PARAMETER_DATA_FINAL_TRANSMISSAO",
  "perfil_procurador_cnpj":   "VALUE_OF_PARAMETER_PERFIL_PROCURADOR_CNPJ",
  "perfil_procurador_cpf":    "VALUE_OF_PARAMETER_PERFIL_PROCURADOR_CPF",
  "categoria_declaracao":     "VALUE_OF_PARAMETER_CATEGORIA_DECLARACAO",
  "situacoes_declaracao":     "VALUE_OF_PARAMETER_SITUACOES_DECLARACAO",
  "numero_recibo":            "VALUE_OF_PARAMETER_NUMERO_RECIBO",
  "pagina":                   "VALUE_OF_PARAMETER_PAGINA",
  "token":                    "WRITE_YOUR_TOKEN_HERE",
  "timeout":                  "300"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

if response_json['code'] == 200:
  print("Retorno com sucesso: ", response_json['data'])
elif response_json['code'] in range(600, 799):
  mensagem = "Resultado sem sucesso. Leia para saber mais: \n"
  mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message'])
  mensagem += "; ".join(response_json['errors'])
  print(mensagem)

print("Cabeçalho da consulta: ", response_json['header'])
print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts'])
```


## We are here to help
Do you still need to figure something out? Reach us at [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) and our highly qualified support team will be happy to help.
