APIs privadas

Financeiro · cadastros

View as Markdown

Financeiro · cadastros

As rotas abaixo complementam a leitura do financeiro e permitem manter os cadastros auxiliares usados nos lançamentos.

Categorias financeiras

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

Regras principais:

  • na criação, informe nome, tipo e ordem;
  • tipo aceita R para receita ou D para despesa;
  • categoria_pai_id é opcional;
  • a categoria nasce ativa;
  • no PUT, somente os campos enviados são alterados;
  • ativo aceita S ou N.

Centros de custo

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

Regras principais:

  • na criação, informe nome;
  • o cadastro nasce ativo;
  • no PUT, somente os campos enviados são alterados;
  • ativo aceita S ou N.

Contas bancárias

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

Regras principais:

  • na criação, informe nome e data_saldo_inicial;
  • saldo_inicial é opcional;
  • a data do saldo inicial não pode ser futura;
  • a conta nasce ativa;
  • o saldo inicial só pode ser definido na criação;
  • no PUT, somente os campos enviados são alterados;
  • ativo aceita S ou N.

Tipos de pagamento

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

Regras principais:

  • na criação, informe nome;
  • descricao é opcional;
  • asaas_billing_type aceita BOLETO, CREDIT_CARD, PIX ou UNDEFINED;
  • o cadastro nasce ativo;
  • no PUT, somente os campos enviados são alterados;
  • ativo aceita S ou N.

Resposta padrão

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