Financeiro · receitas

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

Receitas avulsas

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

Use essas rotas para receitas únicas.

Regras principais:

• informe conta bancária, categoria, tipo de pagamento, nome, valor, data de emissão e data de vencimento;
• receber_receita aceita S ou N;
• quando receber_receita = "S", a API exige data_recebimento;
• no PUT, somente os campos enviados são alterados;
• em receitas já pagas, a API não altera conta bancária, tipo de pagamento nem valores do recebimento.

Receitas recorrentes

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

Use essas rotas para séries periódicas de cobrança.

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.

Receitas parceladas

• POST /simplificav2/receita_parcelada
• PUT /simplificav2/receita_parcelada/{id}
• POST /simplificav2/receita_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 essa 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
}