## Prefeitura / RS / Farroupilha / NFS-e (Nota Fiscal Eletrônica de Serviços)
Consulta uma Nota Fiscal Eletrônica de Serviços na Prefeitura do município de Farroupilha (RS) e retorna os dados da nota obtidos a partir da aplicação de um OCR.


### Site URL
- https://nfse.farroupilha.rs.gov.br/nfse/consultaExterna

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/pref/rs/farroupilha/nfs`



| Parameter | Description                                                 |
| --------- | ----------------------------------------------------------- |
| token*    | The token that will authenticate and authorize the request. |
| chave*    | Chave                                                       |

> * 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.17-20240416150308",
    "product": "Consultas",
    "service": "pref/rs/farroupilha/nfs",
    "parameters": {
      "chave": "111111111111"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.2",
    "requested_at": "2024-04-17T13:46:31.000-03:00",
    "elapsed_time_in_milliseconds": 681,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX19phNzSooqqfL/iH7bdQWpFlrs6lHj+NkVL3yMJ6vHbGLlpxIlSVPe7OLDm/+hxMxnvPG0rlX4OCQ=="
  },
  "data_count": 1,
  "data": [
    {
      "ocr_calculo_base": "0,00",
      "ocr_calculo_deducoes": "0,00",
      "ocr_calculo_desconto_condicional": "0,00",
      "ocr_calculo_issqn": "0,00",
      "ocr_calculo_nao_tributaveis": "0,00",
      "ocr_calculo_reducao_base": "0,00",
      "ocr_calculo_tributos_aproximado": "0,00",
      "ocr_calculo_valor_servico": "550,00",
      "ocr_chave_acesso": "11-11111111111111-11-SUB-111111111/111111111",
      "ocr_codigo_autenticidade": "AAA.111.A1A",
      "ocr_data_competencia": "01/04/2024 12:22",
      "ocr_data_emissao": "01/04/2024 12:24",
      "ocr_informacoes_adicionais": "Exemplo de Informação Adicional",
      "ocr_numero": "00000000",
      "ocr_obra_art": "0",
      "ocr_obra_cei_cno": "0",
      "ocr_obra_endereco": "0",
      "ocr_obra_matricula": "0",
      "ocr_obra_municipio": "Farroupilha / RS",
      "ocr_obra_pais": "Brasil",
      "ocr_obra_projeto": "0",
      "ocr_prestador_cpf_cnpj": "12345678901234",
      "ocr_prestador_email": "exemplo@email.com",
      "ocr_prestador_endereco": "Avenida Paulista, 807. São Paulo. SP. Brasil.",
      "ocr_prestador_inscricao_estadual": "-",
      "ocr_prestador_inscricao_municipal": "11111111",
      "ocr_prestador_local_tributacao": "Farroupilha / RS",
      "ocr_prestador_municipio": "São Paulo",
      "ocr_prestador_nome": "Exemplo de Nome",
      "ocr_prestador_nome_fantasia": "Exemplo de Nome Fantasia",
      "ocr_prestador_regime_tributario": "Simples Nacional",
      "ocr_prestador_responsavel_issqn": "Prestador de Serviço",
      "ocr_prestador_site": "",
      "ocr_prestador_telefone": "(11) 1111 1111",
      "ocr_retencoes_cofins": "0,00",
      "ocr_retencoes_csll": "0,00",
      "ocr_retencoes_inss": "0,00",
      "ocr_retencoes_ir": "0,00",
      "ocr_retencoes_pis_pasep": "0,00",
      "ocr_retencoes_valor_liquido": "550,00",
      "ocr_servico_aliquota": "0,00",
      "ocr_servico_desconto": "0,00",
      "ocr_servico_descricao": "9010110 - Instalações elétricas e hidráulicas",
      "ocr_servico_issqn": "0,00",
      "ocr_servico_lc_116": "07.02",
      "ocr_servico_quantidade_unidade": "1,00 / UN",
      "ocr_servico_valor": "550,00",
      "ocr_servico_valor_total": "550,00",
      "ocr_servico_valor_unitario": "550,00",
      "ocr_tomador_cpf_cnpj": "12345678901234",
      "ocr_tomador_email": "exemplo@email.com",
      "ocr_tomador_endereco": "Avenida Paulista, 807. São Paulo. SP. Brasil.",
      "ocr_tomador_inscricao_estadual": "-",
      "ocr_tomador_inscricao_municipal": "11111111",
      "ocr_tomador_municipio": "São Paulo",
      "ocr_tomador_nome": "Exemplo de Nome",
      "ocr_tomador_pais": "BRASIL",
      "ocr_tomador_telefone": "(11) 1111 1111",
      "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

url = 'https://api.infosimples.com/api/v2/consultas/pref/rs/farroupilha/nfs'
args = {
  "chave":   "VALUE_OF_PARAMETER_CHAVE",
  "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.