# Índice

1. [Quando usar o endpoint de informações da conta](#quando-usar)
2. [Enviando uma requisição](#criacao-pedido)
3. [Parâmetros de configuração](#parametros-configuracao)
4. [Estrutura da resposta](#estrutura-de-resposta)
5. [Exemplo de utilização](#exemplo-de-utilizacao)

## [Quando usar o endpoint de informações da conta](#quando-usar)
Esse endpoint retorna informações importantes sobre a conta, tais como:

- Dados cadastrais básicos;
- Preço base e franquia mínima mensal;
- Valor parcial da fatura aberta do mês atual, no caso de conta pós-paga;
- Saldo disponível, no caso de conta pré-paga;
- Consumo no mês atual.

> Este endpoint não tem custo.


## [Enviando uma requisição](#criacao-pedido)
|                    |                                               |
| ------------------ | --------------------------------------------- |
| Método HTTP        | GET                                           |
| URL                | https://api.infosimples.com/api/admin/account |
| Formato do retorno | JSON                                          |


## [Parâmetros de configuração](#parametros-configuracao)
`*`: Parâmetro obrigatório
| Parâmetro | Descrição                                                                                                |
| --------- | -------------------------------------------------------------------------------------------------------- |
| token*    | Chave de autenticação da API. É com o token que a API reconhece e autoriza quem está fazendo a consulta. |


## [Estrutura da resposta](#estrutura-de-resposta)
Uma resposta deste endpoint possui, dentro da chave <code>data</code>, os seguintes campos:
| Campo             | Tipo    | Descrição                                                                                                                                                                          |
| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name              | string  | Nome da pessoa física ou jurídica titular da conta.                                                                                                                                |
| type              | string  | Indica se é a conta é de pessoa jurídica ou pessoa física.                                                                                                                         |
| cnpj              | string  | Número do CNPJ do titular, no caso de conta de pessoa jurídica.                                                                                                                    |
| cpf               | string  | Número mascarado do CPF do titular, no caso de conta de pessoa física.                                                                                                             |
| prepaid           | boolean | Indica se a conta é pré-paga ou não (e, portanto, pós-paga).                                                                                                                       |
| balance           | float   | Valor do saldo disponível, no caso de conta pré-paga.                                                                                                                              |
| balance_threshold | float   | Valor abaixo do qual é enviado um alerta de saldo baixo via e-mail. Este valor pode ser ajustado nas configurações da conta.                                                       |
| dynamic_price     | boolean | Indica se a conta utiliza o modelo de preço dinâmico ou não (e, portanto, utilza o modelo de preço fixo).                                                                          |
| base_price        | float   | Preço base da conta, no caso de conta com preço fixo.                                                                                                                              |
| min_bill          | float   | Franquia mínima mensal da conta.                                                                                                                                                   |
| default_timeout   | integer | Valor padrão do parâmetro <code>timeout</code> das requisições de consultas, caso este não seja explicitamente informado. Este valor pode ser ajustado nas configurações da conta. |
| current_bill      | float   | Valor atual da fatura em aberto do período corrente (mês atual), no caso de conta pós-paga.                                                                                        |
| current_usage     | float   | Valor atual do consumo de serviços no período corrente (mês atual).                                                                                                                |


## [Exemplo de utilização](#exemplo-de-utilizacao)
### Exemplo de requisição

#### Python
```python
# Testado com: Python 3.10.19, Python 3.14.0
import requests

url = "https://api.infosimples.com/api/admin/account"
args = {
  "token": "VALOR_DO_PARAMETRO"
}

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

print(response_json)
```


### Exemplo de resposta

#### Sucesso
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "data": [
    {
      "name": "Exemplo de nome",
      "type": "Pessoa jurídica",
      "cnpj": "00000000000000",
      "cpf": null,
      "prepaid": true,
      "balance": 111.11,
      "balance_threshold": 11.11,
      "dynamic_price": false,
      "base_price": 0.2,
      "min_bill": 100,
      "default_timeout": 600,
      "current_bill": 100,
      "current_usage": 11.11
    }
  ]
}
```


#### Erro
```json
{
    "code": 601,
    "code_message": "Não foi possível se autenticar com o token informado."
}
```



## Precisa de ajuda?
Ainda tem alguma dúvida ou precisa de ajuda na sua integração? Entre em contato em [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) e receba ajuda da nossa equipe técnica altamente qualificada.