Financeiro · despesas

As rotas abaixo complementam a leitura do financeiro e permitem operar contas a pagar pela API privada.

Despesas avulsas

• POST /simplificav2/despesa
• PUT /simplificav2/despesa/{id}

Use essas rotas para despesas únicas.

Regras principais:

• informe conta bancária, categoria, tipo de pagamento, nome, valor, data de emissão e data de vencimento;
• pagar_despesa aceita S ou N;
• quando pagar_despesa = "S", a API exige data_pagamento;
• no PUT, somente os campos enviados são alterados;
• quando a despesa ainda estiver em aberto, o valor líquido continua precisando ser maior que zero.

Despesas recorrentes

• POST /simplificav2/despesa_recorrente
• PUT /simplificav2/despesa_recorrente/{id}
• POST /simplificav2/despesa_recorrente/{id}/cancelar

Use essas rotas para séries periódicas de despesa.

Regras principais:

• frequencia aceita SEMANAL, QUINZENAL, MENSAL, SEMESTRAL ou ANUAL;
• todo ajuste exige motivo;
• aplicar_em aceita FUTURAS ou PROXIMAS;
• a data de início e a frequência não são alteradas pelo ajuste;
• o cancelamento também exige motivo.

Despesas parceladas

• POST /simplificav2/despesa_parcelada
• PUT /simplificav2/despesa_parcelada/{id}
• POST /simplificav2/despesa_parcelada/{id}/cancelar

Use essas rotas para parcelamentos.

Regras principais:

• informe valor total, quantidade de parcelas, frequência e data de início;
• no PUT, somente os campos enviados são alterados;
• todo ajuste exige motivo;
• a frequência não é alterada por esta rota;
• o cancelamento também exige motivo.

Resposta padrão

1
{
2
  "status": "sucesso",
3
  "mensagem": "Operação concluída com sucesso.",
4
  "data": {
5
    "id": 123
6
  }
7
}