Pular para o conteúdo
POST

/v1/owner-commands/finance

Apresentar pedido do dono (finance): valida e devolve a pergunta de confirmação — nada é executado

Somente token de serviço com finance:entry_as_owner. Operações: finance_entry, finance_reversal, finance_delete, finance_entry_change, patient_charge, fiscal_invoice.

Origem: source_message_id é mensagem RECEBIDA nesta clínica, gravada como owner, cujo chat ainda é o WhatsApp verificado de um admin ativo (dono ou admin verificado). Lead, equipe ou linha antiga → 403 source_not_owner; inexistente ou de outra clínica → 422 invalid_source_message.

Campos: os obrigatórios da operação (GET /v1/owner-commands/operations). Faltou → 422 missing_fields com cada campo em details (o agente pergunta um por vez).

Resposta: question é a pergunta de confirmação com valor, data e descrição por extenso. A mensagem enviada ao dono precisa conter esse texto; o "sim" só vale se ela for a última coisa enviada. mode = approval = o "sim" abre o pedido na fila de Aprovações (limite de valor, despesa recorrente ou operação de risco).

Idempotência: Idempotency-Key obrigatório; o pedido tem id determinístico por (clínica, operação, mensagem de origem): repetir → 200 com o mesmo pedido; a mesma mensagem com outro conteúdo → 409 idempotency_key_reused. Outro pedido aberto da mesma conversa vira substituida.

Permissão:finance:entry_as_owner

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

  • Idempotency-KeystringOpcional

    Obrigatório. · Entre 1 e 255 caracteres · Padrão (regex): ^[\x21-\x7E]+$

Corpo da requisição

application/json · obrigatório

  • operationstringObrigatório

    Valores: finance_entry, finance_reversal, finance_delete, finance_entry_change, patient_charge, fiscal_invoice

  • source_message_idstringObrigatório

    Mensagem recebida do dono que trouxe o pedido. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • paramsobjectObrigatório
  • typestringOpcional
    params.type

    Valores: receita, despesa

  • amountnumberOpcional
    params.amount

    R$ (até 2 casas). · Maior que 0 · Máximo 1000000 · Múltiplo de 0.01

  • descriptionstringOpcional
    params.description

    Sem dado pessoal (e-mail, telefone, CPF). · Entre 2 e 160 caracteres

  • datestringOpcional
    params.date

    Data do lançamento (local da clínica). · Formato AAAA-MM-DD

  • statusstringOpcional
    params.status

    receita: recebido | a-receber · despesa: pago | a-pagar · Valores: recebido, pago, a-receber, a-pagar

  • due_datestringOpcional
    params.due_date

    Formato AAAA-MM-DD

  • methodstringOpcional
    params.method

    Valores: Pix, Crédito, Débito, Dinheiro, Boleto, TED, Cheque

  • categorystringOpcional
    params.category

    Valores: aluguel, internet, sistema, outro

  • recurringobjectOpcional
    params.recurring

    Despesa recorrente → sempre aprovação.

  • frequencystringObrigatório
    params.recurring.frequency

    Valores: Mensal, Bimestral, Trimestral, Anual

  • transaction_idstringOpcional
    params.transaction_id

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • reasonstringOpcional
    params.reason

    Entre 3 e 200 caracteres

  • patient_idstringOpcional
    params.patient_id

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/owner-commands/finance", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "operation": "finance_entry",    "source_message_id": "<source_message_id>",    "params": {      "type": "receita",      "amount": 1,      "description": "<description>"    }  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "id": "<id>",    "operation": "finance_entry",    "domain": "<domain>",    "mode": "direct",    "modeReason": "<modeReason>",    "status": "aguardando_confirmacao",    "label": "<label>",    "summary": "<summary>",    "question": "<question>",    "warnings": [      {        "code": "<code>",        "message": "<message>"      }    ],    "value": {},    "result": {},    "approvalId": "<approvalId>",    "undoable": true,    "confirmRoute": "<confirmRoute>",    "sourceMessageId": "<sourceMessageId>",    "confirmationMessageId": "<confirmationMessageId>",    "informedByMembershipId": "<informedByMembershipId>",    "proposedAt": "2026-09-18T14:00:00.000Z",    "expiresAt": "2026-09-18T14:00:00.000Z",    "appliedAt": "2026-09-18T14:00:00.000Z",    "undoneAt": "2026-09-18T14:00:00.000Z"  },  "meta": {    "idempotent": true  }}
201Created — Sucesso.
JSON
{  "data": {    "id": "<id>",    "operation": "finance_entry",    "domain": "<domain>",    "mode": "direct",    "modeReason": "<modeReason>",    "status": "aguardando_confirmacao",    "label": "<label>",    "summary": "<summary>",    "question": "<question>",    "warnings": [      {        "code": "<code>",        "message": "<message>"      }    ],    "value": {},    "result": {},    "approvalId": "<approvalId>",    "undoable": true,    "confirmRoute": "<confirmRoute>",    "sourceMessageId": "<sourceMessageId>",    "confirmationMessageId": "<confirmationMessageId>",    "informedByMembershipId": "<informedByMembershipId>",    "proposedAt": "2026-09-18T14:00:00.000Z",    "expiresAt": "2026-09-18T14:00:00.000Z",    "appliedAt": "2026-09-18T14:00:00.000Z",    "undoneAt": "2026-09-18T14:00:00.000Z"  },  "meta": {    "idempotent": true  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Esta operação tem limite próprio: 60 requisições / 60 s. Sobre limites