Consultar margem

POST/v1/margem/consulta

🔒 Requer Bearer token

Escopo margem:read. DB-first: reusa a consulta inicial recente do par CPF/empregador; com skipCache=true (ou sem consulta recente) pula o cache de banco e chama o Dataprev — o que gera cobrança. Requer vínculos já listados.

Corpo da requisição

cpfstringobrigatório

CPF do trabalhador (11 dígitos)

padrão: ^\d{11}$

matriculastringobrigatório

Matrícula do trabalhador no empregador

codigo_inscricao_empregadorenumobrigatório

Tipo de inscrição do empregador (do listar vínculos). `1` = CNPJ, `2` = CPF.

numero_inscricao_empregadornumberobrigatório

Número da inscrição do empregador (= CNPJ numérico)

skipCachebooleanopcional

Pula o cache de banco e vai direto na Dataprev (gera cobrança), mesmo havendo uma consulta recente para o par CPF/empregador. Por padrão (`false`), reusa a consulta salva quando disponível.

Respostas

200Margem do empregador + `consulta_margem_id`.

400Dados inválidos (`ERRO_VALIDACAO`).

401Token ausente ou inválido (`CREDENCIAL_INVALIDA`).

Request

curl -X POST 'http://localhost:3101/v1/margem/consulta' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "cpf": "12345678901",
  "matricula": "string",
  "codigo_inscricao_empregador": 1,
  "numero_inscricao_empregador": 0,
  "skipCache": false
}'

Response

{
  "nome": "João da Silva",
  "cpf": "93871045675",
  "matricula": "MAT-5646996721",
  "cargo": "AGENTE DE VIAGEM",
  "salario_bruto": 3559.35,
  "margem_disponivel": 1035.65,
  "ja_comprometido": 1923.35,
  "cnpj_empregador": "12674953000114",
  "nome_empregador": "Alves Teixeira - EI",
  "cnae": null,
  "data_inicio_atividade": null,
  "dataAdmissao": "28102016",
  "consulta_margem_id": "6a450285-8ae3-4419-8335-0565f82d2d47"
}