v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pessoas

Retorna os dados financeiros das pessoas

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta api retorna os valores dos dados financeiros das pessoas (PJ) a partir dos filtros solicitados.

get/pessoas/financeiros

Query parameters

paginainteger

Página que deseja visualizar os registros

registros_por_paginainteger

Quantidade de registro por página, máximo 500 registros

a_partir_referenciainteger

Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.

a_partir_data_referenciastring

Retornará os registros com data referência a partir da data informada

ate_data_referenciastring

Retornará os registros com data referência até a data informada

Headers

emailstring required

E-mail de autenticação do usuário administrativo

tokenstring required

Token criado no usuário administrativo do e-mail

Response

Resposta do get de pessoas

paginainteger

Página atual do retorno dos registros

registrosinteger

Quantidade de registro da página, máximo 500 registros

total_de_registrosinteger

Total de registros encontrados

total_de_paginasinteger

Total de páginas encontradas

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "referencia": "193 ou 193_30",
      "referencia_data": "2023-12-29 16:12:52",
      "ativo": "S",
      "idpessoa": 269,
      "idpessoa_int": "726",
      "dados_financeiro_pj": "Dados do banco",
      "valor_faturamento_mensal_pj": "1231.23",
      "valor_lucro_liquido_mensal_pj": "1231.23",
      "valor_contas_receber_pj": "1231.23",
      "valor_estoque_pj": "1232.13",
      "valor_instalacoes_pj": "1232130.00",
      "valor_moveis_pj": "1230.00",
      "valor_emprestimos_pj": "21.21",
      "valor_inicial_pj": "12.12",
      "valor_capital_registrado_atual_pj": "12.12",
      "valor_capital_integralizado_pj": "22.21",
      "reservas_pj": "Reservas feitas",
      "valor_total_vendas_ultimo_exercicio_pj": "123.12",
      "porcentagem_a_vista_vendas_ultimo_exercicio_pj": "0.21",
      "medio_prazo_dias_vendas_ultimo_exercicio_pj": 12,
      "valor_media_mensal_vendas_pj": "0.12",
      "porcentagem_a_vista_media_mensal_vendas_pj": "0.12",
      "preco_medio_dias_media_mensal_vendas_pj": 12,
      "valor_media_mensal_compras_pj": "0.12",
      "porcentagem_a_vista_media_mensal_compras_pj": "0.12",
      "preco_medio_dias_media_mensal_compras_pj": 12,
      "principais_clientes_pj": "Empresa X",
      "concorrentes_diretos_pj": "Empresa Y",
      "despesas_fixas_mensais_pj": "Água, luz, energia",
      "predio_proprio_pj": "Sim",
      "valor_aluguel_mes_pj": "2323.23",
      "data_vigencia_aluguel_pj": "2024-01-19"
    }
  ]
}