Lançar despesa

Cria uma nova fatura do tipo despesa. Use esta operação para lançar despesa diretamente no financeiro a partir de um sistema externo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados para lançar uma despesa (fatura a pagar). POST /financial/expense e POST /financial/revenue usam o mesmo mapeamento de campos no backend (addRevenueOrExpense() em BillsController.php), então os dois aceitam os mesmos nomes "limpos" (discountValue, increaseValue, relatedDocuments etc.) além dos nomes internos prefixados (dcDiscountValue, dcIncreaseValue, jsonRelatedDocuments) — verificado em FinBills::mapFromTo() (agenciasys_api/src/apps/modules/financial/models/FinBills.php:868-897). A única exceção é iCompanyId — não existe alias "limpo" (companyId) para esse campo, então ele precisa ser enviado com o nome prefixado.

integer

ID da empresa. Único campo do payload sem um nome "limpo" equivalente — precisa ser enviado exatamente como iCompanyId (verificado em FinBills.php:868-897, que mapeia todos os demais campos limpos para os nomes internos, mas não este). Quando omitido, usa a empresa padrão do usuário autenticado.

integer

ID da conta bancária.

integer
required

ID da categoria.

integer

ID do centro de custo.

integer

ID da forma de pagamento.

integer

ID do status.

integer
required

ID do cadastro (fornecedor, prestador etc.) vinculado à despesa.

integer

ID do cliente de referência.

string
enum
required

Tipo de cadastro relacionado à despesa.

Allowed:
string
enum

Condição de pagamento. No momento, só é aceito unique.

Allowed:
string

Número do documento ou nota fiscal.

relatedDocuments
object

Tipo e ID do documento relacionado à despesa. O backend serializa esse objeto como {typeDocument: documentId} (BillsMapper.php:154-159).

string
required

Título da despesa.

number

Valor decimal (retornado como string). Valor de desconto.

number

Valor decimal (retornado como string). Valor de acréscimo.

integer
required

Valor bruto da despesa. Aceita números com "." como separador de milhar; o valor é salvo literalmente (ex.: 50000 é salvo como R$ 50.000,00).

date
required

Data de vencimento. Formato YYYY-MM-DD.

date

Data de competência. Formato YYYY-MM-DD.

string

Número de referência/pedido/empenho.

string
enum

Situação inicial da despesa.

Allowed:
Headers
string
enum

Só tem efeito em POST e PUT dos módulos Financeiro e Cadastros. Sem este header, a resposta traz {success, message}. Com recordCreated ou fieldsUpdated, a resposta traz {success, records} com o registro afetado. GET e DELETE ignoram este header, assim como as rotas de Projetos, Jobs e Tarefas.

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json