Listar Despesas
Este endpoint permite listar as despesas cadastradas no sistema, com base em alguns filtros opcionais. O detalhamento de todos os campos, endpoints e formatos de entrada e saída estão descritos na guia "Especificação de API"
Busca de despesas
O objetivo desse fluxo é trazer as despesas cadastradas em uma empresa ou grupo econômico. Caso não seja passado nenhum filtro, então serão retornadas todas as despesas de todas as empresas desse mesmo grupo.
Busca por empresa
Basta adicionar o ID de sua empresa nos parâmetros de requisição para que se filtre as despesas por ela: companyId=seu_id_aqui. Confira como buscar o ID de sua empresa na seção Empresas
Busca por colaborador
Você pode também buscar por ID(s) de colaborador(es), de uma forma muito parecida com a busca por empresa, ao adicionar employeeIds=id_colaborador_1,id_colaborador_2. Confira como buscar o ID de seus colaboradores na seção Colaboradores
Busca por tipo de despesa
Temos dois tipos de despesa: Reembolso e Despesa de cartão.
São representadas pelo campo type e podem ser, respectivamente, REIMBURSEMENT ou CORPORATE_CARD. Mais especificamente, se quisermos filtrar por reembolsos, usaríamos type=REIMBURSEMENT. Importante usar letras maiúsculas nesse filtro. Só é suportado um tipo de despesa por vez. Se quisermos ver os dois tipos, então não passamos filtro aqui.
Busca por status de prestação de conta
Uma outra forma de se filtrar despesas é pelo seu status. Por exemplo, se quisermos buscar todas as despesas no status "Reembolsado" ou "Em revisão", podemos adicionar o campo status=FINISHED,REQUIRE_CHANGES.
Busca por status da integração
Uma das buscas mais utilizadas pelas empresas é a por status da integração. É possível, por exemplo, localizar todas as despesas com o status PENDING para processar a integração com o ERP, adicionando integrationStatus=PENDING. Para mais informações, veja Atualizar Status de Integração ERP
Busca por data de lançamento da despesa
Analogamente, também suportamos filtros de data, por meio dos campos initialDate (data inicial da busca) e endDate (data final da busca). O formato dessas datas deve ser AAAA-MM-DD. Podemos passar um deles ou os dois ao mesmo tempo, lembrando que endDate deve ser posterior a initialDate. Exemplo: initialDate=2025-01-25&endDate=2025-06-12
Exemplo com todos os campos
Método: GET
URL: /expenses/v1/expenses?companyId=1234&employeeIds=5678&type=REIMBURSEMENT&status=FINISHED,REQUIRE_CHANGES&initialDate=2025-01-25&endDate=2025-06-12&integrationStatus=PENDING
Headers:
- x-flash-auth:
<chave_api>