Listar lançamentos financeiros

Lista receitas, despesas e transferências com os mesmos filtros da tela Financeiro, com paginação.
Ordenação padrão: docDeadline DESC.

Sem date, a listagem traz só o mês corrente. Para outro período, passe
date={"period":"custom","range":["2020-01-01","2030-12-31"]}.

Esta rota substitui os relatórios de lançamentos da beta:

Betav1
GET /beta/financial/reportsGET /v1/financial/bills?situation[]=active&situation[]=settled
GET /beta/financial/reports/document/expenseGET /v1/financial/bills?billType[]=expense
GET /beta/financial/reports/document/revenueGET /v1/financial/bills?billType[]=revenue
GET /beta/financial/reports/document/transferGET /v1/financial/bills?billType[]=transfer

Os relatórios da beta não filtravam data: para o mesmo resultado, passe date com o período desejado.
Receita e despesa são separadas pelo sinal do lançamento (positiveValue), não pelo tipo da categoria.

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

Busca rápida textual.

string

JSON {"period": ..., "range": ["YYYY-MM-DD", "YYYY-MM-DD"]}. period: currentDay, yesterday, lastSevenDays, lastThirtyDays, currentMonth, lastMonth, nextMonth ou custom (range só é usado com custom). Padrão: mês corrente.

considerDate[]
array of strings

Campos de data aos quais o filtro de data se aplica.

considerDate[]
Allowed:
isJustLate[]
array of integers

Somente atrasados (1). Apenas [1] força situation=active.

isJustLate[]
Allowed:
situation[]
array of strings

Situação do lançamento.

situation[]
Allowed:
billType[]
array of strings

Tipo do lançamento.

billType[]
Allowed:
isReconciliation[]
array of integers

Conciliado (1) ou não (0).

isReconciliation[]
Allowed:
string
enum

Tipo da pessoa usada em personIds.

Allowed:
personIds[]
array of integers

Ids das pessoas (pagador/recebedor).

personIds[]
statusIds[]
array of integers

Ids de status.

statusIds[]
finCategoryIds[]
array of integers

Ids de categorias financeiras.

finCategoryIds[]
finPaymentMethodIds[]
array of integers

Ids de formas de pagamento.

finPaymentMethodIds[]
finAccountIds[]
array of integers

Ids de contas financeiras.

finAccountIds[]
finCostCenterIds[]
array of integers

Ids de centros de custo.

finCostCenterIds[]
companyIds[]
array of integers

Ids de empresas.

companyIds[]
projectIds[]
array of integers

Ids de projetos.

projectIds[]
string

Código do item (<projeto>.<item>, ex.: 1.1) ou parte do título do documento relacionado.

string

Número do documento. Aceita o número inteiro ou um trecho.

string

Número do pedido. Busca pelo valor exato.

isBillet[]
array of integers

Com boleto (1) ou sem (0).

isBillet[]
Allowed:
isNFE[]
array of integers

Com NF-e (1) ou sem (0).

isNFE[]
Allowed:
string

Valor mínimo (não pode ser maior que finalValue).

string

Valor máximo.

string

JSON {"column": ..., "direction": "ASC"|"DESC"}. column: docCategory, docDeadline, docNF, docPayerPayee, docRelated, docStatus, docTitle, docValue. Padrão docDeadline DESC.

integer

Registros por página (padrão 20, máximo 100).

integer

Deslocamento para paginação (padrão 0).

Responses

500

Erro interno ou serviço temporariamente indisponível.

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