Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/finance/recurring-expenses

Cadastrar despesa recorrente

Permissão:finance:write

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}$

Corpo da requisição

application/json · obrigatório

  • namestringObrigatório

    Entre 2 e 128 caracteres

  • frequencystringOpcional

    Valores: Mensal, Bimestral, Trimestral, Anual

  • nextDueDatestringObrigatório

    Formato AAAA-MM-DD

  • amountnumberObrigatório

    Valor em reais (BRL). No banco: amount_minor (centavos). · Maior que 0 · Máximo 10000000

  • kindstringOpcional

    Valores: aluguel, internet, sistema, outro

  • activebooleanOpcional

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/finance/recurring-expenses", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "name": "<name>",    "nextDueDate": "2026-09-18",    "amount": 1,    "frequency": "Mensal",    "kind": "aluguel",    "active": true  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

201Created — Sucesso.
JSON
{  "data": {    "id": "<id>",    "name": "<name>",    "frequency": "<frequency>",    "nextDueDate": "2026-09-18",    "amount": 1,    "kind": "aluguel",    "active": 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).

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

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)