## FGTS / Emissão de Guia Rápida
Emite a Guia Rápida de Arrecadação de FGTS no portal do FGTS Digital.


### Site URL
- https://fgtsdigital.sistema.gov.br/portal/login

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/fgts/guia-rapida`



| Parameter      | Description                                                                                                                                                                                                                                                               |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*         | The token that will authenticate and authorize the request.                                                                                                                                                                                                               |
| representado** | Deve ser informado o CNPJ representado em caso de acesso como Procurador.                                                                                                                                                                                                 |
| periodo**      | Período da guia do FGTS, deve ser informado no formato "YYYYMM", por exemplo: 202412. Se não informado, por padrão será utilizado o primeiro mês disponível no site.                                                                                                      |
| login_cpf**    | Deve ser informado o CPF para fazer login no GOV.BR.                                                                                                                                                                                                                      |
| login_senha**  | Deve ser informada a senha para fazer login no GOV.BR.                                                                                                                                                                                                                    |
| pkcs12_cert**  | Este parâmetro é necessário caso o login no GOV.BR seja feito com certificado digital. Conteúdo do arquivo do certificado digital A1 encriptado seguindo <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">as instruções de criptografia</a>. |
| pkcs12_pass**  | Este parâmetro é necessário caso o login no GOV.BR seja feito com certificado digital. Senha do certificado digital A1 encriptada seguindo <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">as instruções de criptografia</a>.               |

> * 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-20240906125839",
    "product": "Consultas",
    "service": "fgts/guia-rapida",
    "parameters": {
      "pkcs12_cert_md5": "aa25eae9298a43740f9a763477c20a1f",
      "pkcs12_pass_md5": "c9c59c5246576b81c3f2712100204dec",
      "representado": "11111111111111"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.26",
    "requested_at": "2024-09-06T16:15:29.000-03:00",
    "elapsed_time_in_milliseconds": 145,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX1+DQ08LvaH4Yol8Js6XIK2qz593v69ovsySPkogkBMsj09A4mnFnLZvZLLk2/IO/dDKureRIBXWxw=="
  },
  "data_count": 1,
  "data": [
    {
      "consignado": {
        "competencia": "111111",
        "data_vencimento": "11/11/1111",
        "valor_mensal": 1234.56,
        "valor_total": 1234.56
      },
      "competencia": "111111",
      "data_vencimento": "11/11/1111",
      "empregador": "Exemplo de Nome",
      "guia_pdf_url": "https://www.exemplo.com/exemplo-de-url",
      "procurador": "Exemplo de Nome",
      "quantidade_trabalhadores": "1",
      "total_paginas_pdf": 1,
      "valor_compensatorio": 0.0,
      "valor_encargos": 100.0,
      "valor_mensal": 240.0,
      "valor_rescisorio": 0.0,
      "valor_total": 240.0,
      "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 may be **synthesized by Infosimples** using data from the source (website/app) that processed the automation if the file generated by the source is not suitable for viewing.

### 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/fgts/guia-rapida'
args = {
  "representado": "VALUE_OF_PARAMETER_REPRESENTADO",
  "periodo":      "VALUE_OF_PARAMETER_PERIODO",
  "login_cpf":    "VALUE_OF_PARAMETER_LOGIN_CPF",
  "login_senha":  "VALUE_OF_PARAMETER_LOGIN_SENHA",
  "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("="),
  "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.