For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Comece aqui
    • Visão geral
    • Guia de integração REST
    • Primeira chamada
    • Filtros e paginação
    • Modelo de integração e performance
    • Exemplos práticos
  • APIs privadas
    • Lista de APIs privadas
    • Comercial · criar e atualizar
    • Comercial · oportunidades
    • Comercial · vendas
    • Cadastros CRM · criar e atualizar
    • Atividades e follow-ups · criar e agir
    • Reuniões · criar e agir
    • Consultório · criar e agir
    • Financeiro · cadastros
    • Financeiro · receitas
    • Financeiro · despesas
  • Integrações públicas
    • API Lead
LogoLogo
On this page
  • Lista de APIs privadas
  • Como acessar
  • O que esta página entrega
  • Regra desta fase
  • Convenções gerais
  • CRM
  • Listar Leads via Integração
  • Listar atividades
  • Listar follow-ups de atividade
  • Listar motivos de atividade
  • Listar motivos padrão de atividade
  • Listar categorias CRM
  • Listar consultores
  • Listar endereços
  • Listar pessoas
  • Listar motivos de inativação de pessoa
  • Listar origens de pessoa
  • Listar segmentos
  • Listar tags
  • Reuniões
  • Listar reuniões
  • Listar motivos de reunião
  • Listar motivos de cancelamento de reunião
  • Comercial
  • Listar categorias de produto
  • Listar etapas de negociação
  • Listar motivos de cancelamento comercial
  • Listar oportunidades
  • Listar itens de oportunidade
  • Listar origens comerciais
  • Listar produtos
  • Listar serviços
  • Listar procedimentos
  • Listar kits
  • Listar estoque
  • Listar movimentação de estoque
  • Listar catálogo completo de produtos e serviços
  • Listar vendas
  • Listar itens de venda
  • Consultório
  • Listar motivos de consulta
  • Listar motivos de cancelamento de consulta
  • Listar bloqueios de agenda
  • Listar preços por profissional
  • Listar consultas
  • Listar itens de consulta
  • Listar materiais de consulta
  • Financeiro
  • Listar categorias financeiras
  • Listar centros de custo
  • Listar contas bancárias
  • Listar despesas
  • Listar despesas parceladas
  • Listar despesas recorrentes
  • Listar receitas
  • Listar receitas parceladas
  • Listar receitas recorrentes
  • Listar tipos de pagamento
  • Projeções
  • Listar assinatura_oportunidade
APIs privadas

Lista de APIs privadas

Rotas privadas de consulta com método, endpoint e exemplo de resposta

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Exemplos práticos

Next

Comercial · criar e atualizar

Built with

Lista de APIs privadas

Esta é a lista completa das APIs privadas de consulta publicadas hoje.

As operações privadas de escrita ficaram documentadas separadamente para manter a navegação humana organizada:

  • Cadastros CRM · criar e atualizar
  • Atividades e follow-ups · criar e agir
  • Reuniões · criar e agir
  • Consultório · criar e agir

Como acessar

Use o token privado da empresa no cabeçalho:

1Authorization: Bearer {{bearer_token}}

Onde encontrar:

  • no Simplifica, abra o menu do usuário;
  • acesse Token API;
  • copie o token privado da sua empresa.

O que esta página entrega

Para cada endpoint publicado abaixo, esta página mostra:

  • o método HTTP;
  • a rota base;
  • o que o endpoint retorna;
  • um exemplo de chamada limpa;
  • um exemplo de JSON de resposta.

Regra desta fase

Nesta primeira fase das integrações privadas, os endpoints publicados aqui são de leitura (GET).

Convenções gerais

  • autenticação por token privado no header Authorization: Bearer;
  • paginação operacional de 100 registros por página;
  • resposta com items, count, limit, offset, hasMore e links;
  • relacionamentos por ID devem ser resolvidos no lado consumidor;
  • quando aparecer um exemplo de links, o href ilustrado abaixo acompanha o próprio endpoint mostrado.

CRM

Listar Leads via Integração

Método: GET
Endpoint: /simplificav2/lead

Retorna as levantadas de mão recebidas pela integração de leads.

Conceito importante:

  • cada linha deste endpoint representa um evento recebido pela integração;
  • a mesma pessoa pode aparecer mais de uma vez;
  • isso pode acontecer com origens diferentes ou até com a mesma origem;
  • para contar entradas da integração, conte os registros retornados;
  • para identificar a pessoa única no CRM, use pessoa_id.

Campos de leitura mais úteis:

  • id: identificador do evento recebido;
  • pessoa_id: pessoa vinculada no CRM, quando houver;
  • novo_na_empresa: indica se o evento criou um lead novo (S) ou se foi associado a alguém já existente (N);
  • origem_texto e consultor_texto: texto recebido ou resolvido no processamento;
  • utm_json: objeto JSON completo das UTMs recebidas;
  • custom_json: objeto JSON com os campos customizados enviados na integração.

Observação:

  • os campos utm_* não são duplicados no topo da resposta;
  • o detalhamento das UTMs fica centralizado dentro de utm_json.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/lead
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 9812,
5 "empresa_id": 27,
6 "processado": "S",
7 "ativo": "S",
8 "nome_recebido": "Andre Souza",
9 "nome_final": "Andre Souza",
10 "celular_recebido": "85999998888",
11 "telefone_fixo_recebido": "8533334444",
12 "celular_formatado": "+5585999998888",
13 "email_recebido": "andre@empresa.com",
14 "email_normalizado": "andre@empresa.com",
15 "origem_texto": "Instagram",
16 "origem_id": 14,
17 "consultor_texto": "joao.silva@gmail.com",
18 "consultor_id": 52,
19 "pessoa_id": 164272,
20 "novo_na_empresa": "N",
21 "integrou_flag": "S",
22 "mensagem_erro": null,
23 "criado_em": "2026-03-29T14:22:31Z",
24 "criado_dia": "2026-03-29",
25 "utm_json": {
26 "utm_creative_format": "video",
27 "utm_product": "simplifica_lead_capture",
28 "utm_term": "lead_form",
29 "utm_medium": "paid_social",
30 "utm_source_platform": "facebook_ads",
31 "utm_audience": "lookalike_2pct_br",
32 "utm_id": "fb_oct_2025_lp1",
33 "utm_content": "creative_v1",
34 "utm_source": "facebook",
35 "utm_campaign": "lead_gen_oct_2025",
36 "utm_marketing_tactic": "prospecting"
37 },
38 "custom_json": {
39 "Qual o nome da sua empresa?": "Espaco das Cadeiras"
40 }
41 }
42 ],
43 "hasMore": false,
44 "limit": 100,
45 "offset": 0,
46 "count": 1,
47 "links": [
48 {
49 "rel": "self",
50 "href": "{{base_url}}/simplificav2/lead"
51 }
52 ]
53}

Listar atividades

Método: GET
Endpoint: /simplificav2/atividade

Retorna a lista de atividades da empresa cadastradas no Simplifica.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/atividade
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 123,
6 "consultor_id": 123,
7 "atividade_follow_up_id": 123,
8 "atividade_motivo_id": 123,
9 "atividade_motivo_padrao_id": 123,
10 "titulo": "texto",
11 "descricao": "texto",
12 "data_atividade": "2026-03-29",
13 "hora_atividade": "texto",
14 "finalizado": "texto",
15 "data_conclusao": "2026-03-29",
16 "hora_conclusao": "texto",
17 "descricao_conclusao": "texto",
18 "ativo": "S",
19 "criado_em": "2026-03-29T12:00:00Z",
20 "criado_por": "texto",
21 "alterado_em": "2026-03-29T12:00:00Z",
22 "alterado_por": "texto"
23 }
24 ],
25 "hasMore": false,
26 "limit": 100,
27 "offset": 0,
28 "count": 1,
29 "links": [
30 {
31 "rel": "self",
32 "href": "{{base_url}}/simplificav2/atividade"
33 }
34 ]
35}

Listar follow-ups de atividade

Método: GET
Endpoint: /simplificav2/atividade_follow_up

Retorna a lista de follow-ups de atividades da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/atividade_follow_up
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "data_conclusao": "2026-03-29",
6 "hora_conclusao": "texto",
7 "finalizado": "texto",
8 "desc_finalizado": "texto",
9 "obs": "texto",
10 "consultor_id": 123,
11 "pessoa_id": 123,
12 "data_follow_up": "2026-03-29",
13 "hora_follow_up": "texto",
14 "atividade_id": 123,
15 "ativo": "S",
16 "criado_em": "2026-03-29T12:00:00Z",
17 "criado_por": "texto",
18 "alterado_em": "2026-03-29T12:00:00Z",
19 "alterado_por": "texto"
20 }
21 ],
22 "hasMore": false,
23 "limit": 100,
24 "offset": 0,
25 "count": 1,
26 "links": [
27 {
28 "rel": "self",
29 "href": "{{base_url}}/simplificav2/atividade_follow_up"
30 }
31 ]
32}

Listar motivos de atividade

Método: GET
Endpoint: /simplificav2/atividade_motivo

Retorna os motivos de atividade da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/atividade_motivo
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "motivo": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/atividade_motivo"
21 }
22 ]
23}

Listar motivos padrão de atividade

Método: GET
Endpoint: /simplificav2/atividade_motivo_padrao

Retorna os motivos internos usados pelo sistema em fluxos operacionais de atividade.

Leitura prática:

  • use o campo ativo para saber se o motivo ainda está válido para uso interno;
  • esta rota não possui criação nem atualização por API.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/atividade_motivo_padrao
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "motivo": "texto",
6 "ativo": "S"
7 }
8 ],
9 "hasMore": false,
10 "limit": 100,
11 "offset": 0,
12 "count": 1,
13 "links": [
14 {
15 "rel": "self",
16 "href": "{{base_url}}/simplificav2/atividade_motivo_padrao"
17 }
18 ]
19}

Listar categorias CRM

Método: GET
Endpoint: /simplificav2/categoria

Retorna a lista de categorias da empresa cadastradas no Simplifica.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/categoria
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/categoria"
21 }
22 ]
23}

Listar consultores

Método: GET
Endpoint: /simplificav2/consultor

Retorna os consultores cadastrados na empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/consultor
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "tratamento": "texto",
7 "especialidade": "texto",
8 "email": "contato@example.com",
9 "telefone": "texto",
10 "url_foto": "texto",
11 "apelido": "texto",
12 "cpf": "texto",
13 "sdr": "texto",
14 "closer": "texto",
15 "profissional": "texto",
16 "ic_adm": "texto",
17 "criado_em": "2026-03-29T12:00:00Z",
18 "criado_por": "texto",
19 "alterado_em": "2026-03-29T12:00:00Z",
20 "alterado_por": "texto"
21 }
22 ],
23 "hasMore": false,
24 "limit": 100,
25 "offset": 0,
26 "count": 1,
27 "links": [
28 {
29 "rel": "self",
30 "href": "{{base_url}}/simplificav2/consultor"
31 }
32 ]
33}

Listar endereços

Método: GET
Endpoint: /simplificav2/endereco

Lista os endereços cadastrados para as pessoas, com dados completos de localização.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/endereco
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 123,
6 "cep": "texto",
7 "endereco": "texto",
8 "numero": "texto",
9 "complemento": "texto",
10 "bairro": "texto",
11 "cidade": "texto",
12 "estado": "texto",
13 "pais": "texto",
14 "padrao": "texto",
15 "tipo_endereco": "texto",
16 "obs": "texto",
17 "latitude": 100.5,
18 "longitude": 100.5,
19 "empresa_id": 123,
20 "ativo": "S",
21 "criado_em": "2026-03-29T12:00:00Z",
22 "criado_por": "texto",
23 "alterado_em": "2026-03-29T12:00:00Z",
24 "alterado_por": "texto"
25 }
26 ],
27 "hasMore": false,
28 "limit": 100,
29 "offset": 0,
30 "count": 1,
31 "links": [
32 {
33 "rel": "self",
34 "href": "{{base_url}}/simplificav2/endereco"
35 }
36 ]
37}

Listar pessoas

Método: GET
Endpoint: /simplificav2/pessoa

Retorna a lista de pessoas da empresa cadastradas no Simplifica.

Como separar leads e clientes:

  • leads: filtre por tipo_pessoa_cliente = "L";
  • clientes: filtre por tipo_pessoa_cliente = "C".

Exemplos úteis:

1GET {{base_url}}/simplificav2/pessoa?q={"tipo_pessoa_cliente":"L"}
2GET {{base_url}}/simplificav2/pessoa?q={"tipo_pessoa_cliente":"C"}

Exemplo de chamada:

1GET {{base_url}}/simplificav2/pessoa
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome_completo": "texto",
6 "cpf": "texto",
7 "cnpj": "texto",
8 "nome_fantasia": "texto",
9 "nascimento": "texto",
10 "email": "contato@example.com",
11 "celular_1": "texto",
12 "celular_2": "texto",
13 "telefone_fixo": "texto",
14 "tipo_registro": "texto",
15 "fornecedor": "texto",
16 "tipo_pessoa_cliente": "texto",
17 "obs": "texto",
18 "foto": "texto",
19 "interesses": "texto",
20 "interesses_nome": "texto",
21 "origem_registro": "texto",
22 "sexo": "texto",
23 "tag": "texto",
24 "pessoa_indicacao_id": 123,
25 "consultor_id": 123,
26 "origem_id": 123,
27 "categoria_id": 123,
28 "motivo_inativacao_id": 123,
29 "segmento_id": 123,
30 "data_alter_tipo_pessoa": "2026-03-29",
31 "ativo": "S",
32 "dt_inativacao": "2026-03-29",
33 "criado_em": "2026-03-29T12:00:00Z",
34 "criado_por": "texto",
35 "alterado_em": "2026-03-29T12:00:00Z",
36 "alterado_por": "texto"
37 }
38 ],
39 "hasMore": false,
40 "limit": 100,
41 "offset": 0,
42 "count": 1,
43 "links": [
44 {
45 "rel": "self",
46 "href": "{{base_url}}/simplificav2/pessoa"
47 }
48 ]
49}

Listar motivos de inativação de pessoa

Método: GET
Endpoint: /simplificav2/pessoa_motivo_inativacao

Retorna a lista de motivos de inativação de pessoa da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/pessoa_motivo_inativacao
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "motivo": "texto",
6 "lead_invalido": "texto",
7 "ativo": "S",
8 "criado_em": "2026-03-29T12:00:00Z",
9 "criado_por": "texto",
10 "alterado_em": "2026-03-29T12:00:00Z",
11 "alterado_por": "texto"
12 }
13 ],
14 "hasMore": false,
15 "limit": 100,
16 "offset": 0,
17 "count": 1,
18 "links": [
19 {
20 "rel": "self",
21 "href": "{{base_url}}/simplificav2/pessoa_motivo_inativacao"
22 }
23 ]
24}

Listar origens de pessoa

Método: GET
Endpoint: /simplificav2/pessoa_origem

Lista as origens disponíveis para classificar pessoas no CRM.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/pessoa_origem
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "origem": "texto",
6 "origem_norm": "texto",
7 "ativo": "S",
8 "criado_em": "2026-03-29T12:00:00Z",
9 "criado_por": "texto",
10 "alterado_em": "2026-03-29T12:00:00Z",
11 "alterado_por": "texto"
12 }
13 ],
14 "hasMore": false,
15 "limit": 100,
16 "offset": 0,
17 "count": 1,
18 "links": [
19 {
20 "rel": "self",
21 "href": "{{base_url}}/simplificav2/pessoa_origem"
22 }
23 ]
24}

Listar segmentos

Método: GET
Endpoint: /simplificav2/segmento

Retorna a lista de segmentos da empresa cadastrados no Simplifica.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/segmento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/segmento"
21 }
22 ]
23}

Listar tags

Método: GET
Endpoint: /simplificav2/tag

Retorna as tags publicadas no módulo de leitura.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/tag
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "tag": "texto",
6 "ativo": "S",
7 "empresa_id": 123,
8 "criado_em": "2026-03-29T12:00:00Z",
9 "criado_por": "texto",
10 "alterado_em": "2026-03-29T12:00:00Z",
11 "alterado_por": "texto"
12 }
13 ],
14 "hasMore": false,
15 "limit": 100,
16 "offset": 0,
17 "count": 1,
18 "links": [
19 {
20 "rel": "self",
21 "href": "{{base_url}}/simplificav2/tag"
22 }
23 ]
24}

Reuniões

Listar reuniões

Método: GET
Endpoint: /simplificav2/reuniao

Retorna a lista de todas as reuniões da empresa cadastradas no Simplifica.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/reuniao
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 123,
6 "data_reuniao": "2026-03-29",
7 "hora_inicial": "texto",
8 "hora_final": "texto",
9 "presencial_online": "texto",
10 "link_reuniao": "texto",
11 "remarcado_pelo_cliente": "texto",
12 "status": "texto",
13 "descricao": "texto",
14 "dt_encerramento": "2026-03-29",
15 "consultor_origem_id": 123,
16 "consultor_destino_id": 123,
17 "descricao_encerramento": "texto",
18 "consultor_encerramento_id": 123,
19 "motivo_id": 123,
20 "reuniao_id": 123,
21 "reuniao_motivo_id": 123,
22 "oportunidade_id": 123,
23 "link_confirmacao_reuniao": "texto",
24 "ativo": "S",
25 "criado_em": "2026-03-29T12:00:00Z",
26 "criado_por": "texto",
27 "alterado_em": "2026-03-29T12:00:00Z",
28 "alterado_por": "texto"
29 }
30 ],
31 "hasMore": false,
32 "limit": 100,
33 "offset": 0,
34 "count": 1,
35 "links": [
36 {
37 "rel": "self",
38 "href": "{{base_url}}/simplificav2/reuniao"
39 }
40 ]
41}

Listar motivos de reunião

Método: GET
Endpoint: /simplificav2/reuniao_motivo

Retorna a lista de todos os motivos de reunião da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/reuniao_motivo
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "descricao": "texto",
7 "ic_encerra_negociacao": "texto",
8 "duracao_padrao": 100.5,
9 "ativo": "S",
10 "criado_em": "2026-03-29T12:00:00Z",
11 "criado_por": "texto",
12 "alterado_em": "2026-03-29T12:00:00Z",
13 "alterado_por": "texto"
14 }
15 ],
16 "hasMore": false,
17 "limit": 100,
18 "offset": 0,
19 "count": 1,
20 "links": [
21 {
22 "rel": "self",
23 "href": "{{base_url}}/simplificav2/reuniao_motivo"
24 }
25 ]
26}

Listar motivos de cancelamento de reunião

Método: GET
Endpoint: /simplificav2/reuniao_motivo_cancelamento

Retorna a lista de todos os motivos de cancelamento de reunião da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/reuniao_motivo_cancelamento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "descricao": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/reuniao_motivo_cancelamento"
21 }
22 ]
23}

Comercial

Listar categorias de produto

Método: GET
Endpoint: /simplificav2/categoria_produto

Retorna a lista de categorias de produto ou serviço da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/categoria_produto
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/categoria_produto"
21 }
22 ]
23}

Listar etapas de negociação

Método: GET
Endpoint: /simplificav2/etapa_negociacao

Retorna a lista de todas as etapas de negociação da empresa.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/etapa_negociacao
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "descricao": "texto",
6 "ativo": "S",
7 "criado_em": "2026-03-29T12:00:00Z",
8 "criado_por": "texto",
9 "alterado_em": "2026-03-29T12:00:00Z",
10 "alterado_por": "texto"
11 }
12 ],
13 "hasMore": false,
14 "limit": 100,
15 "offset": 0,
16 "count": 1,
17 "links": [
18 {
19 "rel": "self",
20 "href": "{{base_url}}/simplificav2/etapa_negociacao"
21 }
22 ]
23}

Listar motivos de cancelamento comercial

Método: GET
Endpoint: /simplificav2/motivo_cancelamento

Lista os motivos de cancelamento comercial disponíveis para oportunidade, venda ou ambos.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/motivo_cancelamento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "descricao": "texto",
6 "local_uso": "texto",
7 "ativo": "S",
8 "criado_em": "2026-03-29T12:00:00Z",
9 "criado_por": "texto",
10 "alterado_em": "2026-03-29T12:00:00Z",
11 "alterado_por": "texto"
12 }
13 ],
14 "hasMore": false,
15 "limit": 100,
16 "offset": 0,
17 "count": 1,
18 "links": [
19 {
20 "rel": "self",
21 "href": "{{base_url}}/simplificav2/motivo_cancelamento"
22 }
23 ]
24}

Listar oportunidades

Método: GET
Endpoint: /simplificav2/oportunidade

Lista oportunidades da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/oportunidade
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 123,
6 "etapa_negociacao_id": 123,
7 "data_previsao_fechamento": "2026-03-29",
8 "consultor_sdr_id": 123,
9 "consultor_closer_id": 123,
10 "observacao": "texto",
11 "status": "texto",
12 "origem_id": 123,
13 "total_bruto": 100.5,
14 "total_desconto": 100.5,
15 "total_liquido": 100.5,
16 "motivo_id": 123,
17 "descricao_encerramento": "texto",
18 "consultor_encerramento_id": 123,
19 "data_encerramento": "2026-03-29",
20 "data_oportunidade": "2026-03-29",
21 "consulta_id": 123,
22 "reuniao_id": 123,
23 "oportunidade_simplifica_id": 123,
24 "endereco_entrega_id": 123,
25 "observacao_interna": "texto",
26 "vl_acrescimo": 100.5,
27 "vl_frete": 100.5,
28 "oportunidade_id_copiado": 1,
29 "venda_simplifica_id": 123,
30 "link_curto": "texto",
31 "verificador_link": "texto",
32 "ativo": "S",
33 "criado_em": "2026-03-29T12:00:00Z",
34 "criado_por": "texto",
35 "alterado_em": "2026-03-29T12:00:00Z",
36 "alterado_por": "texto"
37 }
38 ],
39 "hasMore": false,
40 "limit": 100,
41 "offset": 0,
42 "count": 1,
43 "links": [
44 {
45 "rel": "self",
46 "href": "{{base_url}}/simplificav2/oportunidade"
47 }
48 ]
49}

Listar itens de oportunidade

Método: GET
Endpoint: /simplificav2/oportunidade_item

Retorna os itens de produtos, serviços ou kits vinculados às oportunidades.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/oportunidade_item
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "oportunidade_id": 123,
6 "produto_servico_id": 123,
7 "quantidade": 100.5,
8 "valor_unitario": 100.5,
9 "valor_desconto": 100.5,
10 "valor_total": 100.5,
11 "ativo": "S",
12 "criado_em": "2026-03-29T12:00:00Z",
13 "criado_por": "texto",
14 "alterado_em": "2026-03-29T12:00:00Z",
15 "alterado_por": "texto",
16 "observacao": "texto",
17 "kit_id": 123
18 }
19 ],
20 "hasMore": false,
21 "limit": 100,
22 "offset": 0,
23 "count": 1,
24 "links": [
25 {
26 "rel": "self",
27 "href": "{{base_url}}/simplificav2/oportunidade_item"
28 }
29 ]
30}

Listar origens comerciais

Método: GET
Endpoint: /simplificav2/origem_comercial

Lista as origens comerciais disponíveis para classificar entradas e resultados do funil.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/origem_comercial
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "origem": "texto",
6 "origem_norm": "texto",
7 "ativo": "S",
8 "criado_em": "2026-03-29T12:00:00Z",
9 "criado_por": "texto",
10 "alterado_em": "2026-03-29T12:00:00Z",
11 "alterado_por": "texto"
12 }
13 ],
14 "hasMore": false,
15 "limit": 100,
16 "offset": 0,
17 "count": 1,
18 "links": [
19 {
20 "rel": "self",
21 "href": "{{base_url}}/simplificav2/origem_comercial"
22 }
23 ]
24}

Listar produtos

Método: GET
Endpoint: /simplificav2/produto

Retorna somente produtos da empresa.

Observações:

  • use essa rota quando precisar de itens com atributos de estoque;
  • movimenta_estoque retorna S ou N;
  • un_medida pode trazer códigos como UN (unidade), LT (litro) e PC (peça).

Exemplo de chamada:

1GET {{base_url}}/simplificav2/produto
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Listar serviços

Método: GET
Endpoint: /simplificav2/servico

Retorna somente serviços da empresa que não estão marcados como procedimento.

Observações:

  • não movimenta estoque.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/servico
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Listar procedimentos

Método: GET
Endpoint: /simplificav2/procedimento

Retorna somente procedimentos da empresa.

Observações:

  • procedimento é um serviço marcado internamente como procedimento;
  • essa rota ajuda a separar o catálogo clínico dos demais serviços.
  • não movimenta estoque.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/procedimento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Listar kits

Método: GET
Endpoint: /simplificav2/kit

Retorna somente kits comerciais da empresa.

Observações:

  • a resposta inclui itens, com a composição atual do kit;
  • o kit não tem configuração própria de movimentação de estoque;
  • se um item do kit movimenta estoque, esse movimento acontece a partir dos itens associados;
  • cada item do kit traz o produto ou serviço vinculado, quantidade e valor unitário.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/kit
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 321,
5 "nome": "Kit Clareamento",
6 "descricao": "Kit promocional",
7 "valor": 450.0,
8 "categoria_produto_id": 12,
9 "itens": [
10 {
11 "id": 1,
12 "produto_servico_id": 981,
13 "nome": "Sessão de clareamento",
14 "descricao": "Procedimento clínico",
15 "tipo": "SERVICO",
16 "procedimento": "S",
17 "quantidade": 1,
18 "valor_unitario": 300.0,
19 "total": 300.0,
20 "ativo": "S"
21 },
22 {
23 "id": 2,
24 "produto_servico_id": 145,
25 "nome": "Moldeira",
26 "descricao": "Produto complementar",
27 "tipo": "PRODUTO",
28 "procedimento": "N",
29 "quantidade": 1,
30 "valor_unitario": 150.0,
31 "total": 150.0,
32 "ativo": "S"
33 }
34 ]
35 }
36 ]
37}

Listar estoque

Método: GET
Endpoint: /simplificav2/estoque

Retorna somente produtos da empresa com saldo de estoque diferente de zero.

Observações:

  • a rota considera apenas produtos com movimenta_estoque = "S";
  • produtos com saldo zerado não aparecem;
  • saldo negativo também pode aparecer e deve ser interpretado como estoque atual abaixo de zero.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/estoque
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Listar movimentação de estoque

Método: GET
Endpoint: /simplificav2/estoque/{id}/movimentacao

Retorna o histórico de movimentações de estoque de um produto específico.

Observações:

  • a rota sempre exige o id do produto;
  • não existe uma rota geral de movimentações sem informar o produto;
  • a resposta traz entradas, saídas e ajustes, com saldo acumulado após cada movimento.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/estoque/145/movimentacao
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Listar catálogo completo de produtos e serviços

Método: GET
Endpoint: /simplificav2/produto_servico

Retorna o catálogo completo da empresa com produtos, serviços, procedimentos e kits.

Observações:

  • tipo identifica quando o item é produto, serviço ou kit;
  • procedimento = "S" indica que o item é um procedimento dentro do grupo de serviços;
  • para integrações novas, prefira as rotas específicas produto, servico, procedimento e kit.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/produto_servico
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "tipo": "texto",
6 "descricao": "texto",
7 "valor": 100.5,
8 "url_foto": "texto",
9 "codigo": "texto",
10 "observacao": "texto",
11 "categoria_produto_id": 123,
12 "nome": "texto",
13 "custo": 100.5,
14 "codigo_barra": "texto",
15 "movimenta_estoque": "texto",
16 "procedimento": "texto",
17 "referencia": "texto",
18 "produto_simplifica_id": 123,
19 "flag_liberado_venda": "texto",
20 "qt_estoque_minimo": 100.5,
21 "un_medida": "texto",
22 "codigo_ncm": "texto",
23 "cd_produto_anp": "texto",
24 "nm_nota_fiscal": "texto",
25 "nome_marca": "texto",
26 "nome_modelo": "texto",
27 "nm_grupo": "texto",
28 "medida": "texto",
29 "duracao": "texto",
30 "ativo": "S",
31 "criado_em": "2026-03-29T12:00:00Z",
32 "criado_por": "texto",
33 "alterado_em": "2026-03-29T12:00:00Z",
34 "alterado_por": "texto"
35 }
36 ],
37 "hasMore": false,
38 "limit": 100,
39 "offset": 0,
40 "count": 1,
41 "links": [
42 {
43 "rel": "self",
44 "href": "{{base_url}}/simplificav2/produto_servico"
45 }
46 ]
47}

Listar vendas

Método: GET
Endpoint: /simplificav2/venda

Retorna as vendas cadastradas no sistema.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/venda
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 123,
6 "oportunidade_id": 123,
7 "etapa_negociacao_id": 123,
8 "data_previsao_entrega": "2026-03-29",
9 "consultor_sdr_id": 123,
10 "consultor_closer_id": 123,
11 "observacao": "texto",
12 "status": "texto",
13 "origem_id": 123,
14 "total_bruto": 100.5,
15 "total_desconto": 100.5,
16 "total_liquido": 100.5,
17 "motivo_id": 123,
18 "descricao_encerramento": "texto",
19 "consultor_encerramento_id": 123,
20 "data_encerramento": "2026-03-29",
21 "ativo": "S",
22 "criado_em": "2026-03-29T12:00:00Z",
23 "criado_por": "texto",
24 "alterado_em": "2026-03-29T12:00:00Z",
25 "alterado_por": "texto"
26 }
27 ],
28 "hasMore": false,
29 "limit": 100,
30 "offset": 0,
31 "count": 1,
32 "links": [
33 {
34 "rel": "self",
35 "href": "{{base_url}}/simplificav2/venda"
36 }
37 ]
38}

Listar itens de venda

Método: GET
Endpoint: /simplificav2/venda_item

Retorna os itens das vendas cadastradas no sistema.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/venda_item
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "venda_id": 123,
6 "produto_servico_id": 123,
7 "quantidade": 100.5,
8 "valor_unitario": 100.5,
9 "valor_desconto": 100.5,
10 "valor_total": 100.5,
11 "observacao": "texto",
12 "kit_id": 123,
13 "ativo": "S",
14 "criado_em": "2026-03-29T12:00:00Z",
15 "criado_por": "texto",
16 "alterado_em": "2026-03-29T12:00:00Z",
17 "alterado_por": "texto"
18 }
19 ],
20 "hasMore": false,
21 "limit": 100,
22 "offset": 0,
23 "count": 1,
24 "links": [
25 {
26 "rel": "self",
27 "href": "{{base_url}}/simplificav2/venda_item"
28 }
29 ]
30}

Consultório

Listar motivos de consulta

Método: GET
Endpoint: /simplificav2/motivo_consulta

Retorna os motivos de consulta cadastrados para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/motivo_consulta
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "Avaliação",
6 "descricao": "Primeiro atendimento",
7 "ic_encerra_negociacao": "N",
8 "duracao_padrao": 60,
9 "ativo": "S",
10 "empresa_id": 123,
11 "criado_em": "2026-03-29T12:00:00Z",
12 "criado_por": "texto",
13 "alterado_em": "2026-03-29T12:00:00Z",
14 "alterado_por": "texto"
15 }
16 ],
17 "hasMore": false,
18 "limit": 100,
19 "offset": 0,
20 "count": 1,
21 "links": [
22 {
23 "rel": "self",
24 "href": "{{base_url}}/simplificav2/motivo_consulta"
25 }
26 ]
27}

Listar motivos de cancelamento de consulta

Método: GET
Endpoint: /simplificav2/consulta_motivo_cancelamento

Retorna os motivos de cancelamento de consulta da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/consulta_motivo_cancelamento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "descricao": "Cancelado pelo paciente",
6 "local_uso": "C",
7 "empresa_id": 123,
8 "ativo": "S",
9 "criado_em": "2026-03-29T12:00:00Z",
10 "criado_por": "texto",
11 "alterado_em": "2026-03-29T12:00:00Z",
12 "alterado_por": "texto"
13 }
14 ],
15 "hasMore": false,
16 "limit": 100,
17 "offset": 0,
18 "count": 1,
19 "links": [
20 {
21 "rel": "self",
22 "href": "{{base_url}}/simplificav2/consulta_motivo_cancelamento"
23 }
24 ]
25}

Listar bloqueios de agenda

Método: GET
Endpoint: /simplificav2/bloqueio_agenda

Retorna os bloqueios de agenda do consultório com os profissionais vinculados.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/bloqueio_agenda
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "data_inicio": "2026-03-29",
6 "data_fim": "2026-03-29",
7 "hora_inicio": "08:00",
8 "hora_fim": "12:00",
9 "ic_domingo": "N",
10 "ic_segunda": "S",
11 "ic_terca": "S",
12 "ic_quarta": "S",
13 "ic_quinta": "S",
14 "ic_sexta": "S",
15 "ic_sabado": "N",
16 "titulo": "Treinamento interno",
17 "descricao": "Bloqueio parcial da agenda",
18 "todos_profissionais": "N",
19 "profissionais_ids": "12,18",
20 "profissionais": "Dra. A, Dra. B",
21 "empresa_id": 123,
22 "ativo": "S",
23 "criado_em": "2026-03-29T12:00:00Z",
24 "criado_por": "texto",
25 "alterado_em": "2026-03-29T12:00:00Z",
26 "alterado_por": "texto"
27 }
28 ],
29 "hasMore": false,
30 "limit": 100,
31 "offset": 0,
32 "count": 1,
33 "links": [
34 {
35 "rel": "self",
36 "href": "{{base_url}}/simplificav2/bloqueio_agenda"
37 }
38 ]
39}

Listar preços por profissional

Método: GET
Endpoint: /simplificav2/preco_profissional

Retorna a tabela de preço por profissional da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/preco_profissional
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "produto_servico_id": 45,
6 "profissional_id": 12,
7 "preco": 350.0,
8 "empresa_id": 123,
9 "ativo": "S",
10 "criado_em": "2026-03-29T12:00:00Z",
11 "criado_por": "texto",
12 "alterado_em": "2026-03-29T12:00:00Z",
13 "alterado_por": "texto"
14 }
15 ],
16 "hasMore": false,
17 "limit": 100,
18 "offset": 0,
19 "count": 1,
20 "links": [
21 {
22 "rel": "self",
23 "href": "{{base_url}}/simplificav2/preco_profissional"
24 }
25 ]
26}

Listar consultas

Método: GET
Endpoint: /simplificav2/consulta

Retorna as consultas do consultório da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/consulta
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "pessoa_id": 456,
6 "consultor_id": 78,
7 "profissional_id": 90,
8 "agendamento_id": 321,
9 "data_consulta": "2026-03-29",
10 "hora_inicial": "09:00",
11 "hora_final": "10:00",
12 "status": "CONFIRMADA",
13 "descricao": "Consulta inicial",
14 "dt_encerramento": null,
15 "descricao_encerramento": null,
16 "remarcado_pelo_cliente": "N",
17 "consultor_encerramento_id": null,
18 "motivo_id": null,
19 "confirma_presenca": "S",
20 "confirma_chegada": "N",
21 "encaixe": "N",
22 "dt_confirma_presenca": "2026-03-28T15:00:00Z",
23 "usuario_confirma_presenca_id": 78,
24 "motivo_consulta_id": 12,
25 "em_atendimento": "N",
26 "dt_hora_inicio_atend": null,
27 "dt_hora_fim_atend": null,
28 "token_consulta": "texto",
29 "link_confirmacao_consulta": "texto",
30 "consulta_simplifica_id": null,
31 "recorrencia_id": null,
32 "recorrencia_ordem": null,
33 "recorrencia_total": null,
34 "recorrencia_frequencia": null,
35 "ativo": "S",
36 "empresa_id": 123,
37 "criado_em": "2026-03-29T12:00:00Z",
38 "criado_por": "texto",
39 "alterado_em": "2026-03-29T12:00:00Z",
40 "alterado_por": "texto"
41 }
42 ],
43 "hasMore": false,
44 "limit": 100,
45 "offset": 0,
46 "count": 1,
47 "links": [
48 {
49 "rel": "self",
50 "href": "{{base_url}}/simplificav2/consulta"
51 }
52 ]
53}

Listar itens de consulta

Método: GET
Endpoint: /simplificav2/consulta_item

Retorna os procedimentos vinculados às consultas da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/consulta_item
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "consulta_id": 456,
6 "produto_servico_id": 45,
7 "quantidade": 1,
8 "empresa_id": 123,
9 "ativo": "S",
10 "criado_em": "2026-03-29T12:00:00Z",
11 "criado_por": "texto",
12 "alterado_em": "2026-03-29T12:00:00Z",
13 "alterado_por": "texto"
14 }
15 ],
16 "hasMore": false,
17 "limit": 100,
18 "offset": 0,
19 "count": 1,
20 "links": [
21 {
22 "rel": "self",
23 "href": "{{base_url}}/simplificav2/consulta_item"
24 }
25 ]
26}

Listar materiais de consulta

Método: GET
Endpoint: /simplificav2/consulta_material

Retorna os materiais consumidos por procedimento nas consultas da empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/consulta_material
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "servico_id": 45,
6 "produto_id": 67,
7 "consulta_id": 456,
8 "quantidade": 2,
9 "empresa_id": 123,
10 "ativo": "S",
11 "criado_em": "2026-03-29T12:00:00Z",
12 "criado_por": "texto",
13 "alterado_em": "2026-03-29T12:00:00Z",
14 "alterado_por": "texto"
15 }
16 ],
17 "hasMore": false,
18 "limit": 100,
19 "offset": 0,
20 "count": 1,
21 "links": [
22 {
23 "rel": "self",
24 "href": "{{base_url}}/simplificav2/consulta_material"
25 }
26 ]
27}

Financeiro

Listar categorias financeiras

Método: GET
Endpoint: /simplificav2/categoria_financeira

Retorna as categorias financeiras publicadas no módulo de leitura.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/categoria_financeira
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "tipo": "texto",
7 "categoria_pai_id": 123,
8 "agrupamento_id": 123,
9 "ordem": 1,
10 "dre_linha_id": 123,
11 "ativo": "S",
12 "empresa_id": 123,
13 "criado_em": "2026-03-29T12:00:00Z",
14 "criado_por": "texto",
15 "alterado_em": "2026-03-29T12:00:00Z",
16 "alterado_por": "texto"
17 }
18 ],
19 "hasMore": false,
20 "limit": 100,
21 "offset": 0,
22 "count": 1,
23 "links": [
24 {
25 "rel": "self",
26 "href": "{{base_url}}/simplificav2/categoria_financeira"
27 }
28 ]
29}

Listar centros de custo

Método: GET
Endpoint: /simplificav2/centro_custo

Retorna os centros de custo publicados no módulo financeiro.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/centro_custo
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "descricao": "texto",
7 "ativo": "S",
8 "empresa_id": 123,
9 "criado_em": "2026-03-29T12:00:00Z",
10 "criado_por": "texto",
11 "alterado_em": "2026-03-29T12:00:00Z",
12 "alterado_por": "texto"
13 }
14 ],
15 "hasMore": false,
16 "limit": 100,
17 "offset": 0,
18 "count": 1,
19 "links": [
20 {
21 "rel": "self",
22 "href": "{{base_url}}/simplificav2/centro_custo"
23 }
24 ]
25}

Listar contas bancárias

Método: GET
Endpoint: /simplificav2/conta_bancaria

Retorna as contas bancárias publicadas no módulo financeiro.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/conta_bancaria
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "banco": "texto",
7 "agencia": "texto",
8 "numero_conta": "texto",
9 "saldo_atual": 100.5,
10 "saldo_inicial": 100.5,
11 "data_saldo_inicial": "2026-03-29",
12 "conta_simplifica_id": 123,
13 "padrao_asaas_flag": "texto",
14 "ativo": "S",
15 "empresa_id": 123,
16 "criado_em": "2026-03-29T12:00:00Z",
17 "criado_por": "texto",
18 "alterado_em": "2026-03-29T12:00:00Z",
19 "alterado_por": "texto"
20 }
21 ],
22 "hasMore": false,
23 "limit": 100,
24 "offset": 0,
25 "count": 1,
26 "links": [
27 {
28 "rel": "self",
29 "href": "{{base_url}}/simplificav2/conta_bancaria"
30 }
31 ]
32}

Listar despesas

Método: GET
Endpoint: /simplificav2/despesa

Retorna as despesas cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/despesa
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "despesa_recorrente_id": 123,
10 "despesa_parcelada_id": 123,
11 "centro_custo_id": 123,
12 "compra_pagamento_id": 123,
13 "ultima_transacao_id": 123,
14 "despesa_simplifica_id": 123,
15 "nome": "texto",
16 "descricao": "texto",
17 "valor": 100.5,
18 "desconto": 100.5,
19 "acrescimo": 100.5,
20 "multa": 100.5,
21 "juros": 100.5,
22 "taxa": 100.5,
23 "valor_liquido": 100.5,
24 "valor_pago": 100.5,
25 "status": "texto",
26 "data_emissao": "2026-03-29",
27 "data_vencimento": "2026-03-29",
28 "data_pagamento": "2026-03-29",
29 "data_cancelamento": "2026-03-29",
30 "data_competencia": "2026-03-29",
31 "ativo": "S",
32 "empresa_id": 123,
33 "criado_em": "2026-03-29T12:00:00Z",
34 "criado_por": "texto",
35 "alterado_em": "2026-03-29T12:00:00Z",
36 "alterado_por": "texto"
37 }
38 ],
39 "hasMore": false,
40 "limit": 100,
41 "offset": 0,
42 "count": 1,
43 "links": [
44 {
45 "rel": "self",
46 "href": "{{base_url}}/simplificav2/despesa"
47 }
48 ]
49}

Listar despesas parceladas

Método: GET
Endpoint: /simplificav2/despesa_parcelada

Retorna as despesas parceladas cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/despesa_parcelada
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "centro_custo_id": 123,
10 "despesa_principal_id": 123,
11 "nome": "texto",
12 "descricao": "texto",
13 "valor_total": 100.5,
14 "qtd_parcelas": 1,
15 "valor_parcela": 100.5,
16 "frequencia": "texto",
17 "data_inicio": "2026-03-29",
18 "data_fim": "2026-03-29",
19 "status": "texto",
20 "ativo": "S",
21 "empresa_id": 123,
22 "criado_em": "2026-03-29T12:00:00Z",
23 "criado_por": "texto",
24 "alterado_em": "2026-03-29T12:00:00Z",
25 "alterado_por": "texto"
26 }
27 ],
28 "hasMore": false,
29 "limit": 100,
30 "offset": 0,
31 "count": 1,
32 "links": [
33 {
34 "rel": "self",
35 "href": "{{base_url}}/simplificav2/despesa_parcelada"
36 }
37 ]
38}

Listar despesas recorrentes

Método: GET
Endpoint: /simplificav2/despesa_recorrente

Retorna as despesas recorrentes cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/despesa_recorrente
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "centro_custo_id": 123,
10 "nome": "texto",
11 "descricao": "texto",
12 "valor_padrao": 100.5,
13 "frequencia": "texto",
14 "qtd_prevista": 1,
15 "data_inicio": "2026-03-29",
16 "data_fim": "2026-03-29",
17 "status": "texto",
18 "ultima_geracao": "texto",
19 "rec_despesa_simplifica_id": 123,
20 "dia_vencimento_base": 1,
21 "ativo": "S",
22 "empresa_id": 123,
23 "criado_em": "2026-03-29T12:00:00Z",
24 "criado_por": "texto",
25 "alterado_em": "2026-03-29T12:00:00Z",
26 "alterado_por": "texto"
27 }
28 ],
29 "hasMore": false,
30 "limit": 100,
31 "offset": 0,
32 "count": 1,
33 "links": [
34 {
35 "rel": "self",
36 "href": "{{base_url}}/simplificav2/despesa_recorrente"
37 }
38 ]
39}

Listar receitas

Método: GET
Endpoint: /simplificav2/receita

Retorna as receitas cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/receita
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "receita_recorrente_id": 123,
10 "receita_parcelada_id": 123,
11 "centro_custo_id": 123,
12 "venda_pagamento_id": 123,
13 "ultima_transacao_id": 123,
14 "receita_simplifica_id": 123,
15 "nome": "texto",
16 "descricao": "texto",
17 "valor": 100.5,
18 "desconto": 100.5,
19 "acrescimo": 100.5,
20 "multa": 100.5,
21 "juros": 100.5,
22 "taxa": 100.5,
23 "valor_liquido": 100.5,
24 "valor_pago": 100.5,
25 "status": "texto",
26 "data_emissao": "2026-03-29",
27 "data_vencimento": "2026-03-29",
28 "data_pagamento": "2026-03-29",
29 "data_cancelamento": "2026-03-29",
30 "parcela_num": 1,
31 "taxa_antecipacao": 100.5,
32 "data_competencia": "2026-03-29",
33 "ativo": "S",
34 "empresa_id": 123,
35 "criado_em": "2026-03-29T12:00:00Z",
36 "criado_por": "texto",
37 "alterado_em": "2026-03-29T12:00:00Z",
38 "alterado_por": "texto"
39 }
40 ],
41 "hasMore": false,
42 "limit": 100,
43 "offset": 0,
44 "count": 1,
45 "links": [
46 {
47 "rel": "self",
48 "href": "{{base_url}}/simplificav2/receita"
49 }
50 ]
51}

Listar receitas parceladas

Método: GET
Endpoint: /simplificav2/receita_parcelada

Retorna as receitas parceladas cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/receita_parcelada
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "centro_custo_id": 123,
10 "receita_principal_id": 123,
11 "nome": "texto",
12 "descricao": "texto",
13 "valor_total": 100.5,
14 "qtd_parcelas": 1,
15 "valor_parcela": 100.5,
16 "frequencia": "texto",
17 "data_inicio": "2026-03-29",
18 "data_fim": "2026-03-29",
19 "status": "texto",
20 "asaas_customer_id": 123,
21 "asaas_installment_id": 123,
22 "asaas_status": "texto",
23 "ativo": "S",
24 "empresa_id": 123,
25 "criado_em": "2026-03-29T12:00:00Z",
26 "criado_por": "texto",
27 "alterado_em": "2026-03-29T12:00:00Z",
28 "alterado_por": "texto"
29 }
30 ],
31 "hasMore": false,
32 "limit": 100,
33 "offset": 0,
34 "count": 1,
35 "links": [
36 {
37 "rel": "self",
38 "href": "{{base_url}}/simplificav2/receita_parcelada"
39 }
40 ]
41}

Listar receitas recorrentes

Método: GET
Endpoint: /simplificav2/receita_recorrente

Retorna as receitas recorrentes cadastradas para a empresa autenticada.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/receita_recorrente
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "conta_bancaria_id": 123,
6 "categoria_id": 123,
7 "tipo_pagamento_id": 123,
8 "pessoa_id": 123,
9 "centro_custo_id": 123,
10 "pessoa_saas_id": 123,
11 "plano_id": 123,
12 "nome": "texto",
13 "descricao": "texto",
14 "valor_padrao": 100.5,
15 "frequencia": "texto",
16 "qtd_prevista": 1,
17 "data_inicio": "2026-03-29",
18 "data_fim": "2026-03-29",
19 "status": "texto",
20 "ultima_geracao": "texto",
21 "asaas_customer_id": 123,
22 "asaas_subscription_id": 123,
23 "asaas_status": "texto",
24 "dia_vencimento_base": 1,
25 "ativo": "S",
26 "empresa_id": 123,
27 "criado_em": "2026-03-29T12:00:00Z",
28 "criado_por": "texto",
29 "alterado_em": "2026-03-29T12:00:00Z",
30 "alterado_por": "texto"
31 }
32 ],
33 "hasMore": false,
34 "limit": 100,
35 "offset": 0,
36 "count": 1,
37 "links": [
38 {
39 "rel": "self",
40 "href": "{{base_url}}/simplificav2/receita_recorrente"
41 }
42 ]
43}

Listar tipos de pagamento

Método: GET
Endpoint: /simplificav2/tipo_pagamento

Retorna os tipos de pagamento publicados no módulo financeiro.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/tipo_pagamento
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "id": 123,
5 "nome": "texto",
6 "descricao": "texto",
7 "asaas_billing_type": "texto",
8 "ativo": "S",
9 "empresa_id": 123,
10 "criado_em": "2026-03-29T12:00:00Z",
11 "criado_por": "texto",
12 "alterado_em": "2026-03-29T12:00:00Z",
13 "alterado_por": "texto"
14 }
15 ],
16 "hasMore": false,
17 "limit": 100,
18 "offset": 0,
19 "count": 1,
20 "links": [
21 {
22 "rel": "self",
23 "href": "{{base_url}}/simplificav2/tipo_pagamento"
24 }
25 ]
26}

Projeções

Listar assinatura_oportunidade

Método: GET
Endpoint: /simplificav2/assinatura_oportunidade

Lista oportunidades ganhas com informações relacionadas a assinaturas e recorrência.

Exemplo de chamada:

1GET {{base_url}}/simplificav2/assinatura_oportunidade
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Exemplo de resposta:

1{
2 "items": [
3 {
4 "empresa_id": 123,
5 "oportunidade_id": 123,
6 "pessoa_id": 123,
7 "nome_completo": "texto",
8 "email": "contato@example.com",
9 "celular_1": "texto",
10 "celular_2": "texto",
11 "telefone_fixo": "texto",
12 "data_ganho": "2026-03-29",
13 "dt_oportunidade": "2026-03-29",
14 "valor_oportunidade": 100.5,
15 "total_bruto": 100.5,
16 "total_desconto": 100.5,
17 "origem_id": 123,
18 "usuario_closer_id": 123,
19 "usuario_sdr_id": 123,
20 "tem_assinatura_ativa_flag": "texto",
21 "receita_recorrente_id": 123,
22 "assinatura_nome": "texto",
23 "assinatura_descricao": "texto",
24 "valor_assinatura": 100.5,
25 "frequencia": "texto",
26 "assinatura_data_inicio": "texto",
27 "assinatura_data_fim": "texto",
28 "tipo_pagamento_id": 123,
29 "asaas_customer_id": 123,
30 "asaas_subscription_id": 123,
31 "asaas_status": "texto",
32 "qtd_mensalidades_pagas": 1,
33 "valor_total_pago": 100.5,
34 "possui_atraso_flag": "texto",
35 "vencimento_em_atraso": "texto",
36 "proxima_recorrencia": "texto",
37 "ultima_data_pagamento": "texto"
38 }
39 ],
40 "hasMore": false,
41 "limit": 100,
42 "offset": 0,
43 "count": 1,
44 "links": [
45 {
46 "rel": "self",
47 "href": "{{base_url}}/simplificav2/assinatura_oportunidade"
48 }
49 ]
50}