APIs privadas

Lista de APIs privadas

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

View as Markdown

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:

Como acessar

Use o token privado da empresa no cabeçalho:

Authorization: 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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 9812,
      "empresa_id": 27,
      "processado": "S",
      "ativo": "S",
      "nome_recebido": "Andre Souza",
      "nome_final": "Andre Souza",
      "celular_recebido": "85999998888",
      "telefone_fixo_recebido": "8533334444",
      "celular_formatado": "+5585999998888",
      "email_recebido": "andre@empresa.com",
      "email_normalizado": "andre@empresa.com",
      "origem_texto": "Instagram",
      "origem_id": 14,
      "consultor_texto": "joao.silva@gmail.com",
      "consultor_id": 52,
      "pessoa_id": 164272,
      "novo_na_empresa": "N",
      "integrou_flag": "S",
      "mensagem_erro": null,
      "criado_em": "2026-03-29T14:22:31Z",
      "criado_dia": "2026-03-29",
      "utm_json": {
        "utm_creative_format": "video",
        "utm_product": "simplifica_lead_capture",
        "utm_term": "lead_form",
        "utm_medium": "paid_social",
        "utm_source_platform": "facebook_ads",
        "utm_audience": "lookalike_2pct_br",
        "utm_id": "fb_oct_2025_lp1",
        "utm_content": "creative_v1",
        "utm_source": "facebook",
        "utm_campaign": "lead_gen_oct_2025",
        "utm_marketing_tactic": "prospecting"
      },
      "custom_json": {
        "Qual o nome da sua empresa?": "Espaco das Cadeiras"
      }
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/lead"
    }
  ]
}

Listar atividades

Método: GET
Endpoint: /simplificav2/atividade

Retorna a lista de atividades da empresa cadastradas no Simplifica.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 123,
      "consultor_id": 123,
      "atividade_follow_up_id": 123,
      "atividade_motivo_id": 123,
      "atividade_motivo_padrao_id": 123,
      "titulo": "texto",
      "descricao": "texto",
      "data_atividade": "2026-03-29",
      "hora_atividade": "texto",
      "finalizado": "texto",
      "data_conclusao": "2026-03-29",
      "hora_conclusao": "texto",
      "descricao_conclusao": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/atividade"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "data_conclusao": "2026-03-29",
      "hora_conclusao": "texto",
      "finalizado": "texto",
      "desc_finalizado": "texto",
      "obs": "texto",
      "consultor_id": 123,
      "pessoa_id": 123,
      "data_follow_up": "2026-03-29",
      "hora_follow_up": "texto",
      "atividade_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/atividade_follow_up"
    }
  ]
}

Listar motivos de atividade

Método: GET
Endpoint: /simplificav2/atividade_motivo

Retorna os motivos de atividade da empresa.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "motivo": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/atividade_motivo"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "motivo": "texto",
      "ativo": "S"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/atividade_motivo_padrao"
    }
  ]
}

Listar categorias CRM

Método: GET
Endpoint: /simplificav2/categoria

Retorna a lista de categorias da empresa cadastradas no Simplifica.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/categoria"
    }
  ]
}

Listar consultores

Método: GET
Endpoint: /simplificav2/consultor

Retorna os consultores cadastrados na empresa.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "tratamento": "texto",
      "especialidade": "texto",
      "email": "contato@example.com",
      "telefone": "texto",
      "url_foto": "texto",
      "apelido": "texto",
      "cpf": "texto",
      "sdr": "texto",
      "closer": "texto",
      "profissional": "texto",
      "ic_adm": "texto",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/consultor"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 123,
      "cep": "texto",
      "endereco": "texto",
      "numero": "texto",
      "complemento": "texto",
      "bairro": "texto",
      "cidade": "texto",
      "estado": "texto",
      "pais": "texto",
      "padrao": "texto",
      "tipo_endereco": "texto",
      "obs": "texto",
      "latitude": 100.5,
      "longitude": 100.5,
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/endereco"
    }
  ]
}

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:

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome_completo": "texto",
      "cpf": "texto",
      "cnpj": "texto",
      "nome_fantasia": "texto",
      "nascimento": "texto",
      "email": "contato@example.com",
      "celular_1": "texto",
      "celular_2": "texto",
      "telefone_fixo": "texto",
      "tipo_registro": "texto",
      "fornecedor": "texto",
      "tipo_pessoa_cliente": "texto",
      "obs": "texto",
      "foto": "texto",
      "interesses": "texto",
      "interesses_nome": "texto",
      "origem_registro": "texto",
      "sexo": "texto",
      "tag": "texto",
      "pessoa_indicacao_id": 123,
      "consultor_id": 123,
      "origem_id": 123,
      "categoria_id": 123,
      "motivo_inativacao_id": 123,
      "segmento_id": 123,
      "data_alter_tipo_pessoa": "2026-03-29",
      "ativo": "S",
      "dt_inativacao": "2026-03-29",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/pessoa"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "motivo": "texto",
      "lead_invalido": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/pessoa_motivo_inativacao"
    }
  ]
}

Listar origens de pessoa

Método: GET
Endpoint: /simplificav2/pessoa_origem

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "origem": "texto",
      "origem_norm": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/pessoa_origem"
    }
  ]
}

Listar segmentos

Método: GET
Endpoint: /simplificav2/segmento

Retorna a lista de segmentos da empresa cadastrados no Simplifica.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/segmento"
    }
  ]
}

Listar tags

Método: GET
Endpoint: /simplificav2/tag

Retorna as tags publicadas no módulo de leitura.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "tag": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/tag"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 123,
      "data_reuniao": "2026-03-29",
      "hora_inicial": "texto",
      "hora_final": "texto",
      "presencial_online": "texto",
      "link_reuniao": "texto",
      "remarcado_pelo_cliente": "texto",
      "status": "texto",
      "descricao": "texto",
      "dt_encerramento": "2026-03-29",
      "consultor_origem_id": 123,
      "consultor_destino_id": 123,
      "descricao_encerramento": "texto",
      "consultor_encerramento_id": 123,
      "motivo_id": 123,
      "reuniao_id": 123,
      "reuniao_motivo_id": 123,
      "oportunidade_id": 123,
      "link_confirmacao_reuniao": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/reuniao"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "descricao": "texto",
      "ic_encerra_negociacao": "texto",
      "duracao_padrao": 100.5,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/reuniao_motivo"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "descricao": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/reuniao_motivo_cancelamento"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/categoria_produto"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "descricao": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/etapa_negociacao"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "descricao": "texto",
      "local_uso": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/motivo_cancelamento"
    }
  ]
}

Listar oportunidades

Método: GET
Endpoint: /simplificav2/oportunidade

Lista oportunidades da empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 123,
      "etapa_negociacao_id": 123,
      "data_previsao_fechamento": "2026-03-29",
      "consultor_sdr_id": 123,
      "consultor_closer_id": 123,
      "observacao": "texto",
      "status": "texto",
      "origem_id": 123,
      "total_bruto": 100.5,
      "total_desconto": 100.5,
      "total_liquido": 100.5,
      "motivo_id": 123,
      "descricao_encerramento": "texto",
      "consultor_encerramento_id": 123,
      "data_encerramento": "2026-03-29",
      "data_oportunidade": "2026-03-29",
      "consulta_id": 123,
      "reuniao_id": 123,
      "oportunidade_simplifica_id": 123,
      "endereco_entrega_id": 123,
      "observacao_interna": "texto",
      "vl_acrescimo": 100.5,
      "vl_frete": 100.5,
      "oportunidade_id_copiado": 1,
      "venda_simplifica_id": 123,
      "link_curto": "texto",
      "verificador_link": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/oportunidade"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "oportunidade_id": 123,
      "produto_servico_id": 123,
      "quantidade": 100.5,
      "valor_unitario": 100.5,
      "valor_desconto": 100.5,
      "valor_total": 100.5,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto",
      "observacao": "texto",
      "kit_id": 123
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/oportunidade_item"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "origem": "texto",
      "origem_norm": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/origem_comercial"
    }
  ]
}

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:

GET {{base_url}}/simplificav2/produto
Authorization: Bearer {{bearer_token}}
Accept: 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:

GET {{base_url}}/simplificav2/servico
Authorization: Bearer {{bearer_token}}
Accept: 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:

GET {{base_url}}/simplificav2/procedimento
Authorization: Bearer {{bearer_token}}
Accept: 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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 321,
      "nome": "Kit Clareamento",
      "descricao": "Kit promocional",
      "valor": 450.0,
      "categoria_produto_id": 12,
      "itens": [
        {
          "id": 1,
          "produto_servico_id": 981,
          "nome": "Sessão de clareamento",
          "descricao": "Procedimento clínico",
          "tipo": "SERVICO",
          "procedimento": "S",
          "quantidade": 1,
          "valor_unitario": 300.0,
          "total": 300.0,
          "ativo": "S"
        },
        {
          "id": 2,
          "produto_servico_id": 145,
          "nome": "Moldeira",
          "descricao": "Produto complementar",
          "tipo": "PRODUTO",
          "procedimento": "N",
          "quantidade": 1,
          "valor_unitario": 150.0,
          "total": 150.0,
          "ativo": "S"
        }
      ]
    }
  ]
}

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:

GET {{base_url}}/simplificav2/estoque
Authorization: Bearer {{bearer_token}}
Accept: 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:

GET {{base_url}}/simplificav2/estoque/145/movimentacao
Authorization: Bearer {{bearer_token}}
Accept: 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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "tipo": "texto",
      "descricao": "texto",
      "valor": 100.5,
      "url_foto": "texto",
      "codigo": "texto",
      "observacao": "texto",
      "categoria_produto_id": 123,
      "nome": "texto",
      "custo": 100.5,
      "codigo_barra": "texto",
      "movimenta_estoque": "texto",
      "procedimento": "texto",
      "referencia": "texto",
      "produto_simplifica_id": 123,
      "flag_liberado_venda": "texto",
      "qt_estoque_minimo": 100.5,
      "un_medida": "texto",
      "codigo_ncm": "texto",
      "cd_produto_anp": "texto",
      "nm_nota_fiscal": "texto",
      "nome_marca": "texto",
      "nome_modelo": "texto",
      "nm_grupo": "texto",
      "medida": "texto",
      "duracao": "texto",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/produto_servico"
    }
  ]
}

Listar vendas

Método: GET
Endpoint: /simplificav2/venda

Retorna as vendas cadastradas no sistema.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 123,
      "oportunidade_id": 123,
      "etapa_negociacao_id": 123,
      "data_previsao_entrega": "2026-03-29",
      "consultor_sdr_id": 123,
      "consultor_closer_id": 123,
      "observacao": "texto",
      "status": "texto",
      "origem_id": 123,
      "total_bruto": 100.5,
      "total_desconto": 100.5,
      "total_liquido": 100.5,
      "motivo_id": 123,
      "descricao_encerramento": "texto",
      "consultor_encerramento_id": 123,
      "data_encerramento": "2026-03-29",
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/venda"
    }
  ]
}

Listar itens de venda

Método: GET
Endpoint: /simplificav2/venda_item

Retorna os itens das vendas cadastradas no sistema.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "venda_id": 123,
      "produto_servico_id": 123,
      "quantidade": 100.5,
      "valor_unitario": 100.5,
      "valor_desconto": 100.5,
      "valor_total": 100.5,
      "observacao": "texto",
      "kit_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/venda_item"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "Avaliação",
      "descricao": "Primeiro atendimento",
      "ic_encerra_negociacao": "N",
      "duracao_padrao": 60,
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/motivo_consulta"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "descricao": "Cancelado pelo paciente",
      "local_uso": "C",
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/consulta_motivo_cancelamento"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "data_inicio": "2026-03-29",
      "data_fim": "2026-03-29",
      "hora_inicio": "08:00",
      "hora_fim": "12:00",
      "ic_domingo": "N",
      "ic_segunda": "S",
      "ic_terca": "S",
      "ic_quarta": "S",
      "ic_quinta": "S",
      "ic_sexta": "S",
      "ic_sabado": "N",
      "titulo": "Treinamento interno",
      "descricao": "Bloqueio parcial da agenda",
      "todos_profissionais": "N",
      "profissionais_ids": "12,18",
      "profissionais": "Dra. A, Dra. B",
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/bloqueio_agenda"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "produto_servico_id": 45,
      "profissional_id": 12,
      "preco": 350.0,
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/preco_profissional"
    }
  ]
}

Listar consultas

Método: GET
Endpoint: /simplificav2/consulta

Retorna as consultas do consultório da empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "pessoa_id": 456,
      "consultor_id": 78,
      "profissional_id": 90,
      "agendamento_id": 321,
      "data_consulta": "2026-03-29",
      "hora_inicial": "09:00",
      "hora_final": "10:00",
      "status": "CONFIRMADA",
      "descricao": "Consulta inicial",
      "dt_encerramento": null,
      "descricao_encerramento": null,
      "remarcado_pelo_cliente": "N",
      "consultor_encerramento_id": null,
      "motivo_id": null,
      "confirma_presenca": "S",
      "confirma_chegada": "N",
      "encaixe": "N",
      "dt_confirma_presenca": "2026-03-28T15:00:00Z",
      "usuario_confirma_presenca_id": 78,
      "motivo_consulta_id": 12,
      "em_atendimento": "N",
      "dt_hora_inicio_atend": null,
      "dt_hora_fim_atend": null,
      "token_consulta": "texto",
      "link_confirmacao_consulta": "texto",
      "consulta_simplifica_id": null,
      "recorrencia_id": null,
      "recorrencia_ordem": null,
      "recorrencia_total": null,
      "recorrencia_frequencia": null,
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/consulta"
    }
  ]
}

Listar itens de consulta

Método: GET
Endpoint: /simplificav2/consulta_item

Retorna os procedimentos vinculados às consultas da empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "consulta_id": 456,
      "produto_servico_id": 45,
      "quantidade": 1,
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/consulta_item"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "servico_id": 45,
      "produto_id": 67,
      "consulta_id": 456,
      "quantidade": 2,
      "empresa_id": 123,
      "ativo": "S",
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/consulta_material"
    }
  ]
}

Financeiro

Listar categorias financeiras

Método: GET
Endpoint: /simplificav2/categoria_financeira

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "tipo": "texto",
      "categoria_pai_id": 123,
      "agrupamento_id": 123,
      "ordem": 1,
      "dre_linha_id": 123,
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/categoria_financeira"
    }
  ]
}

Listar centros de custo

Método: GET
Endpoint: /simplificav2/centro_custo

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "descricao": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/centro_custo"
    }
  ]
}

Listar contas bancárias

Método: GET
Endpoint: /simplificav2/conta_bancaria

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "banco": "texto",
      "agencia": "texto",
      "numero_conta": "texto",
      "saldo_atual": 100.5,
      "saldo_inicial": 100.5,
      "data_saldo_inicial": "2026-03-29",
      "conta_simplifica_id": 123,
      "padrao_asaas_flag": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/conta_bancaria"
    }
  ]
}

Listar despesas

Método: GET
Endpoint: /simplificav2/despesa

Retorna as despesas cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "despesa_recorrente_id": 123,
      "despesa_parcelada_id": 123,
      "centro_custo_id": 123,
      "compra_pagamento_id": 123,
      "ultima_transacao_id": 123,
      "despesa_simplifica_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor": 100.5,
      "desconto": 100.5,
      "acrescimo": 100.5,
      "multa": 100.5,
      "juros": 100.5,
      "taxa": 100.5,
      "valor_liquido": 100.5,
      "valor_pago": 100.5,
      "status": "texto",
      "data_emissao": "2026-03-29",
      "data_vencimento": "2026-03-29",
      "data_pagamento": "2026-03-29",
      "data_cancelamento": "2026-03-29",
      "data_competencia": "2026-03-29",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/despesa"
    }
  ]
}

Listar despesas parceladas

Método: GET
Endpoint: /simplificav2/despesa_parcelada

Retorna as despesas parceladas cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "centro_custo_id": 123,
      "despesa_principal_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor_total": 100.5,
      "qtd_parcelas": 1,
      "valor_parcela": 100.5,
      "frequencia": "texto",
      "data_inicio": "2026-03-29",
      "data_fim": "2026-03-29",
      "status": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/despesa_parcelada"
    }
  ]
}

Listar despesas recorrentes

Método: GET
Endpoint: /simplificav2/despesa_recorrente

Retorna as despesas recorrentes cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "centro_custo_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor_padrao": 100.5,
      "frequencia": "texto",
      "qtd_prevista": 1,
      "data_inicio": "2026-03-29",
      "data_fim": "2026-03-29",
      "status": "texto",
      "ultima_geracao": "texto",
      "rec_despesa_simplifica_id": 123,
      "dia_vencimento_base": 1,
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/despesa_recorrente"
    }
  ]
}

Listar receitas

Método: GET
Endpoint: /simplificav2/receita

Retorna as receitas cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "receita_recorrente_id": 123,
      "receita_parcelada_id": 123,
      "centro_custo_id": 123,
      "venda_pagamento_id": 123,
      "ultima_transacao_id": 123,
      "receita_simplifica_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor": 100.5,
      "desconto": 100.5,
      "acrescimo": 100.5,
      "multa": 100.5,
      "juros": 100.5,
      "taxa": 100.5,
      "valor_liquido": 100.5,
      "valor_pago": 100.5,
      "status": "texto",
      "data_emissao": "2026-03-29",
      "data_vencimento": "2026-03-29",
      "data_pagamento": "2026-03-29",
      "data_cancelamento": "2026-03-29",
      "parcela_num": 1,
      "taxa_antecipacao": 100.5,
      "data_competencia": "2026-03-29",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/receita"
    }
  ]
}

Listar receitas parceladas

Método: GET
Endpoint: /simplificav2/receita_parcelada

Retorna as receitas parceladas cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "centro_custo_id": 123,
      "receita_principal_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor_total": 100.5,
      "qtd_parcelas": 1,
      "valor_parcela": 100.5,
      "frequencia": "texto",
      "data_inicio": "2026-03-29",
      "data_fim": "2026-03-29",
      "status": "texto",
      "asaas_customer_id": 123,
      "asaas_installment_id": 123,
      "asaas_status": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/receita_parcelada"
    }
  ]
}

Listar receitas recorrentes

Método: GET
Endpoint: /simplificav2/receita_recorrente

Retorna as receitas recorrentes cadastradas para a empresa autenticada.

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "conta_bancaria_id": 123,
      "categoria_id": 123,
      "tipo_pagamento_id": 123,
      "pessoa_id": 123,
      "centro_custo_id": 123,
      "pessoa_saas_id": 123,
      "plano_id": 123,
      "nome": "texto",
      "descricao": "texto",
      "valor_padrao": 100.5,
      "frequencia": "texto",
      "qtd_prevista": 1,
      "data_inicio": "2026-03-29",
      "data_fim": "2026-03-29",
      "status": "texto",
      "ultima_geracao": "texto",
      "asaas_customer_id": 123,
      "asaas_subscription_id": 123,
      "asaas_status": "texto",
      "dia_vencimento_base": 1,
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/receita_recorrente"
    }
  ]
}

Listar tipos de pagamento

Método: GET
Endpoint: /simplificav2/tipo_pagamento

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

Exemplo de chamada:

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

Exemplo de resposta:

{
  "items": [
    {
      "id": 123,
      "nome": "texto",
      "descricao": "texto",
      "asaas_billing_type": "texto",
      "ativo": "S",
      "empresa_id": 123,
      "criado_em": "2026-03-29T12:00:00Z",
      "criado_por": "texto",
      "alterado_em": "2026-03-29T12:00:00Z",
      "alterado_por": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/tipo_pagamento"
    }
  ]
}

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:

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

Exemplo de resposta:

{
  "items": [
    {
      "empresa_id": 123,
      "oportunidade_id": 123,
      "pessoa_id": 123,
      "nome_completo": "texto",
      "email": "contato@example.com",
      "celular_1": "texto",
      "celular_2": "texto",
      "telefone_fixo": "texto",
      "data_ganho": "2026-03-29",
      "dt_oportunidade": "2026-03-29",
      "valor_oportunidade": 100.5,
      "total_bruto": 100.5,
      "total_desconto": 100.5,
      "origem_id": 123,
      "usuario_closer_id": 123,
      "usuario_sdr_id": 123,
      "tem_assinatura_ativa_flag": "texto",
      "receita_recorrente_id": 123,
      "assinatura_nome": "texto",
      "assinatura_descricao": "texto",
      "valor_assinatura": 100.5,
      "frequencia": "texto",
      "assinatura_data_inicio": "texto",
      "assinatura_data_fim": "texto",
      "tipo_pagamento_id": 123,
      "asaas_customer_id": 123,
      "asaas_subscription_id": 123,
      "asaas_status": "texto",
      "qtd_mensalidades_pagas": 1,
      "valor_total_pago": 100.5,
      "possui_atraso_flag": "texto",
      "vencimento_em_atraso": "texto",
      "proxima_recorrencia": "texto",
      "ultima_data_pagamento": "texto"
    }
  ],
  "hasMore": false,
  "limit": 100,
  "offset": 0,
  "count": 1,
  "links": [
    {
      "rel": "self",
      "href": "{{base_url}}/simplificav2/assinatura_oportunidade"
    }
  ]
}