API Flash
Guias
Especificação de API
Colaboradores
Busca por colaboradores pertencentes ao grupo econômico
get
Cadastrar Colaborador
post
Busca um colaborador pelo ID
get
Deleta um colaborador
delete
Atualiza dados de um colaborador
patch
Reativa um colaborador desativado
post
Desativa um colaborador ativo
post
Benefícios
Cria um pedido de benefícios
post
Busca um pedido pelo seu identificador
get
Adiciona um depósito de benefício à um colaborador
post
Cancela um depósito específico de um pedido
post
Lista depósitos por colaborador
get
Confirma um pedido finalizando a solicitação de depósitos
post
Cancela um pedido que ainda não tenha sido disponibilizado
post
Busca Benefícios de uma empresa
get
Candidatos
Lista candidatos
get
Cria um candidato
post
Controle de jornada
Lista marcações de ponto
get
Lista verbas
get
Lista eventos
get
Cria ou atualiza um evento
post
Cancela eventos
patch
Lista alocações de escala
get
Cria alocações de escala
post
Férias
Lista programações de férias
get
Cria ou atualiza uma programação de férias
post
Atualiza uma efetivação de férias
patch
Pagamentos
Busca um pagamento pelo ID
get
Empresas
Lista empresas pertencentes ao grupo econômico
get
Busca uma empresa pelo ID
get
Departamentos
Lista departamentos
get
Cria um departamento
post
Busca um departamento pelo ID
get
Deleta um departamento
delete
Atualiza um departamento
patch
Vincular um colaborador ao departamento
post
Grupos
Lista grupos
get
Cria um grupo
post
Busca um grupo pelo ID
get
Deleta um grupo
delete
Atualiza um grupo
patch
Adiciona um colaborador ao grupo
post
Remove um colaborador do grupo
delete
PII
Busca PII do colaborador
get
Atualiza PII do colaborador
patch
Cargos
Lista cargos
get
Cria um cargo
post
Busca um cargo pelo ID
get
Deleta um cargo
delete
Atualiza um cargo
patch
Vincular um colaborador ao cargo
post
Centros de custo
Listar centros de custo
get
Criar um centro de custo
post
Atualizar um centro de custo
patch
Ativar centro de custo
post
Desativar centro de custo
post
Despesas
Lista despesas
get
Finaliza despesas
post
Reprovar despesas
post
Solicitar ajustes das despesas
post
Atualiza o status da integração ERP de uma despesa
post
Despesas | Categorias
Lista categorias de despesa
get
Cria uma categoria de despesa
post
Busca uma categoria de despesa pelo ID
get
Deleta uma categoria de despesa
delete
Atualiza uma categoria de despesa
patch
Despesas | Projetos
Lista projetos
get
Criar um projeto
post
Atualizar um projeto
patch
Ativar projeto
patch
Desativar projeto
patch
Despesas | Campos customizados
Buscar campo customizado pelo código
get
Listar opções de campo customizado
get
Criar opção de campo customizado
post
Atualizar opção de campo customizado
patch
Ativar opção de campo customizado
patch
Desativar opção de campo customizado
patch
Despesas | Relatórios PDF
Gera relatório de despesas em PDF
post
Obtém progresso de geração de relatório
get
Cartão Corporativo
Adicionar colaboradores ao pedido em aberto
post
Buscar pedido
get
Cancelar pedido em aberto
delete
Remover colaborador do pedido em aberto
delete
Confirmar pedido
post
Criar pedido em aberto
post
Cancelar depósito de colaborador
delete
Buscar saldo do colaborador
get
Buscar saldo da empresa
get
Estornar saldo do colaborador
post
Ativar/desativar uso corporativo
post
Criar pedido de depósito da empresa
post
Listar depósitos
get
Schemas
powered by Zudoku
Menu
Flash - Integrações
Despesas | Relatórios PDF
Endpoint:
https://api.flashapp.services
API information
Gera relatório de despesas em PDF
POST
https://api.flashapp.services
/expenses/v1/expenses/pdf-report/generate-async
Gera relatório de despesas em PDF ›
Headers
x-flash-auth
string
·
required
Gera relatório de despesas em PDF ›
Request Body
companyId
string
·
required
filter
object
·
required
Show properties
Gera relatório de despesas em PDF ›
Responses
201
400
jobId
string
·
required
Obtém progresso de geração de relatório
GET
https://api.flashapp.services
/expenses/v1/expenses/pdf-report/generate-async/{jobId}/progress
Obtém progresso de geração de relatório ›
path Parameters
jobId
string
·
required
Obtém progresso de geração de relatório ›
Headers
x-flash-auth
string
·
required
Obtém progresso de geração de relatório ›
Responses
200
404
string
Despesas | Campos customizados
Cartão Corporativo