Financeiro

Esta referência cobre as chamadas do módulo Financeiro: contas bancárias e caixas, contas a pagar, contas a receber, movimentação financeira, configurações e relatórios. Cada página lista os endpoints do recurso, os campos que aceita e o que devolve. As telas correspondentes estão no menu Financeiro do manual do usuário.

Os caminhos começam por /financial, a partir do endereço base descrito em Convenções. Valem também a autenticação em Autenticação e as regras de paginação e erros em Convenções.

Recursos

Recurso	Tela	Página
Contas	Contas	Contas
Contas a pagar	Contas a pagar	Contas a pagar
Contas a receber	Contas a receber	Contas a receber
Movimentação financeira	Movimentação financeira	Movimentação financeira
Métodos de pagamento	Configurações, aba Métodos de pagamento	Métodos de pagamento
Contas de métodos de pagamento	Configurações, aba Métodos de pagamento	Contas de métodos de pagamento
Categorias	Configurações, aba Categorias	Categorias
Centros de custo	Configurações, aba Centros de custo	Centros de custo
Relatórios	Relatórios	Relatórios

Tipos de lançamento

Cada lançamento tem um tipo. Os valores aceitos pelos campos release_type_id são:

Id	Tipo	Telas
1	Crédito (receita)	Contas a receber
2	Débito (despesa)	Contas a pagar

Situação dos lançamentos

O campo status_id indica a situação de cada lançamento:

Id	Situação	Como fica
1	Em aberto	Sem data de pagamento
2	Pago	Com data de pagamento, ou Recebido no caso de receitas
3	Conciliado	Pago e marcado como conciliado

Como os recursos se relacionam

As categorias, os centros de custo e os métodos de pagamento são cadastros de apoio: os id retornados por eles são os que os formulários de contas a pagar, contas a receber e movimentação aceitam. As contas cadastradas em Contas recebem os pagamentos, as baixas e as transferências.

Cada recurso lista, na sua página, as chamadas de apoio que alimentam os seus campos.