Pular para o conteúdo principal

Listar Receitas

Retorna uma lista de receitas com base nos filtros aplicados.

Endpoint

GET /contas-receber/receitas

Parâmetros de Query

ParâmetroTipoDescrição
data_destring (YYYY-MM-DD)Data inicial
data_atestring (YYYY-MM-DD)Data final
recebido_ou_previsaostring (recebido - previsao)Indica se é algo já recebido ou previsão de recebimento

Resposta

{
"success": true,
"data": [
{
"receitas": [
{
"razao_social": string,
"nota_fiscal": string,
"data_pagamento_recebido": Date | null,
"data_previsao": Date,
"documento": string,
"codigo_categoria": string,
"descricao_categoria": string,
"origem": string,
"valor_documento": number,
"desconto": number,
"valor_recebido": number,
"recebido": boolean,
}
],
"quantia_recebidos": number,
"valor_receitas": string
}
],
"timeStamp": string,
"total_registros": number
}

Exemplo de Resposta

{
"success": true,
"data": [
{
"receitas": [
{
"razao_social": "BAC",
"nota_fiscal": "00001234",
"data_pagamento_recebido": "2025-05-30T03:00:00.000Z",
"data_previsao": "2025-06-02T03:00:00.000Z",
"documento": null,
"codigo_categoria": "1.05.99",
"descricao_categoria": "Vendas de Produtos-Merc. Int.",
"origem": "VENR",
"valor_documento": "34567.89",
"desconto": "0.00",
"valor_recebido": "34567.89",
"recebido": 1
},
],
"quantia_recebidos": 1,
"valor_receitas": "1728573.21"
}
],
"timeStamp": "2024-03-01T10:00:00Z",
"total_registros": 1
}

Códigos de Status

  • 200: Sucesso
  • 400: Requisição inválida
  • 401: Não autorizado
  • 403: Acesso proibido
  • 500: Erro interno do servidor