> For the complete documentation index, see [llms.txt](https://outboundpro.gitbook.io/api-v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://outboundpro.gitbook.io/api-v1/lead-enrich-batch/simular-processamento.md).

# Simular processamento

## Simular processamento em massa (custo + estimativas)

> Calcula custo em créditos antes de enfileirar. Retorna quantidade de\
> empresas, sócios estimados, custo total, créditos atuais do cliente.\
> Não toca em nada — não consome créditos.\
> \
> \### Filtros padrão\
> \
> Aplica \`status\_id=1\` automaticamente se você omitir (mesmo comportamento\
> do painel). Use \`{"filtros": {"\_sem\_defaults": true}}\` pra desligar.\
> \`lead\_ids\[]\` explícito não aplica defaults. Veja \`/count\` pra detalhes.<br>

```json
{"openapi":"3.0.3","info":{"title":"OutboundPro API","version":"2.0.0"},"tags":[{"name":"Lead","description":"**Empresas já existentes na sua base** (após enriquecimento via\n[Company](#tag/Company) ou cadastro manual no painel).\n\nO termo \"Lead\" no OutboundPro = \"empresa rastreada por você\". Cada lead tem\nstatus (Novo, Em prospecção, Convertido, etc.), lista vinculada, scoring\nautomático e contatos (sócios) associados.\n\n### Diferença Company × Lead\n- **Company** = empresa pelo CNPJ; consulta a base pública (RFB) do OutboundPro e pode salvar como lead.\n- **Lead** = consulta sua base local; **rápido**, sem lookup externo.\n\nSe você sabe que a empresa já está na sua base, prefira `lead/*` por\nperformance.\n\n### Estrutura típica\n- `id` (`emp_codigo`) ou `hash` (`emp_hash`) — identificadores estáveis.\n- `status` — fluxo configurável por cliente ([Status](#tag/Status)).\n- `lista` — agrupamento ([List](#tag/List)).\n- `contatos` — sócios ([Contact](#tag/Contact)).\n"}],"servers":[{"url":"https://app.outboundpro.com.br/api","description":"Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Token","description":"Chave privada do cliente (`cli_chave_privada`). Formato UUID v4\n(36 caracteres com hífens). Aceita header em qualquer case\n(`Token`, `token`, `TOKEN`).\n"}},"responses":{"Unauthorized":{"description":"Token ausente, inválido ou cliente inativo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"type":"object","required":["response"],"properties":{"response":{"type":"string","enum":["error"]},"mensagem":{"type":"string","description":"Descrição do erro em pt-BR. Família Contact usa `message` (legado)."},"message":{"type":"string","description":"Equivalente inglês de `mensagem`, usado pela família Contact."}}}}},"paths":{"/lead-enrich-batch/simulate":{"post":{"tags":["Lead"],"summary":"Simular processamento em massa (custo + estimativas)","operationId":"leadEnrichBatchSimulate","description":"Calcula custo em créditos antes de enfileirar. Retorna quantidade de\nempresas, sócios estimados, custo total, créditos atuais do cliente.\nNão toca em nada — não consome créditos.\n\n### Filtros padrão\n\nAplica `status_id=1` automaticamente se você omitir (mesmo comportamento\ndo painel). Use `{\"filtros\": {\"_sem_defaults\": true}}` pra desligar.\n`lead_ids[]` explícito não aplica defaults. Veja `/count` pra detalhes.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["options"],"properties":{"lead_ids":{"type":"array","items":{"type":"integer"}},"filtros":{"type":"object","additionalProperties":true},"options":{"type":"object","properties":{"consultar_socios":{"type":"boolean"},"salvar_dados_socios":{"type":"string","enum":["all","cell_phones_only","landlines_only","only_emails","cell_phones_and_emails","landlines_and_emails","cell_phones_landlines"]},"qualificacoes_socios":{"type":"array","items":{"type":"string"}},"consultar_socios_whatsapp":{"type":"boolean"},"consultar_snovio":{"type":"boolean","description":"Snov.io é pago (~2 créditos/empresa)."}}}}}}}},"responses":{"200":{"description":"Simulação completa. Inclui `warning` quando `lead_ids[]` específicos não casam.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","enum":["success"]},"filtros_aplicados":{"type":"object"},"simulacao":{"type":"object","properties":{"quantidade_empresas":{"type":"string"},"quantidade_socios":{"type":"string"},"consumo_creditos_socios":{"type":"string"},"consumo_creditos_snovio":{"type":"string"},"consumo_creditos_total":{"type":"string"},"creditos_atuais":{"type":"string"},"prospeccoes_atuais":{"type":"string"}}},"warning":{"type":"object","description":"Presente apenas quando `lead_ids[]` foram passados e nenhum casou.","properties":{"motivo":{"type":"string"},"leads_excluidos":{"type":"array","items":{"type":"integer"}},"leads_nao_disponiveis":{"type":"array","items":{"type":"integer"}}}}}}}}},"400":{"description":"Body inválido (`lead_ids` deve ser array, `filtros` deve ser objeto).","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","enum":["error"]},"mensagem":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```