API FlashAPI FlashAPI Flash
  • Guias
  • Especificação de API
Colaboradores
    Busca por colaboradores pertencentes ao grupo econômicogetCadastrar ColaboradorpostBusca um colaborador pelo IDgetDeleta um colaboradordeleteAtualiza dados de um colaboradorpatchReativa um colaborador desativadopostDesativa um colaborador ativopost
Benefícios
    Cria um pedido de benefíciospostBusca um pedido pelo seu identificadorgetAdiciona um depósito de benefício à um colaboradorpostCancela um depósito específico de um pedidopostLista depósitos por colaboradorgetConfirma um pedido finalizando a solicitação de depósitospostCancela um pedido que ainda não tenha sido disponibilizadopostBusca Benefícios de uma empresaget
Candidatos
    Lista candidatosgetCria um candidatopost
Controle de jornada
    Lista marcações de pontogetLista verbasgetLista eventosgetCria ou atualiza um eventopostCancela eventospatchLista alocações de escalagetCria alocações de escalapost
Férias
    Lista programações de fériasgetCria ou atualiza uma programação de fériaspostAtualiza uma efetivação de fériaspatch
Pagamentos
    Busca um pagamento pelo IDget
Empresas
    Lista empresas pertencentes ao grupo econômicogetBusca uma empresa pelo IDget
Departamentos
    Lista departamentosgetCria um departamentopostBusca um departamento pelo IDgetDeleta um departamentodeleteAtualiza um departamentopatchVincular um colaborador ao departamentopost
Grupos
    Lista gruposgetCria um grupopostBusca um grupo pelo IDgetDeleta um grupodeleteAtualiza um grupopatchAdiciona um colaborador ao grupopostRemove um colaborador do grupodelete
PII
    Busca PII do colaboradorgetAtualiza PII do colaboradorpatch
Cargos
    Lista cargosgetCria um cargopostBusca um cargo pelo IDgetDeleta um cargodeleteAtualiza um cargopatchVincular um colaborador ao cargopost
Centros de custo
    Listar centros de custogetCriar um centro de custopostAtualizar um centro de custopatchAtivar centro de custopostDesativar centro de custopost
Despesas
    Lista despesasgetFinaliza despesaspostReprovar despesaspostSolicitar ajustes das despesaspostAtualiza o status da integração ERP de uma despesapost
Despesas | Categorias
    Lista categorias de despesagetCria uma categoria de despesapostBusca uma categoria de despesa pelo IDgetDeleta uma categoria de despesadeleteAtualiza uma categoria de despesapatch
Despesas | Projetos
    Lista projetosgetCriar um projetopostAtualizar um projetopatchAtivar projetopatchDesativar projetopatch
Despesas | Campos customizados
    Buscar campo customizado pelo códigogetListar opções de campo customizadogetCriar opção de campo customizadopostAtualizar opção de campo customizadopatchAtivar opção de campo customizadopatchDesativar opção de campo customizadopatch
Despesas | Relatórios PDF
    Gera relatório de despesas em PDFpostObtém progresso de geração de relatórioget
Cartão Corporativo
    Adicionar colaboradores ao pedido em abertopostBuscar pedidogetCancelar pedido em abertodeleteRemover colaborador do pedido em abertodeleteConfirmar pedidopostCriar pedido em abertopostCancelar depósito de colaboradordeleteBuscar saldo do colaboradorgetBuscar saldo da empresagetEstornar saldo do colaboradorpostAtivar/desativar uso corporativopostCriar pedido de depósito da empresapostListar depósitosget
Schemas
powered by Zudoku
Flash - Integrações

​Despesas

Endpoint:https://api.flashapp.services

​Lista despesas

GET
https://api.flashapp.services
/expenses/v1/expenses

​Lista despesas › query Parameters

  • companyIdstring
  • employeeIdsstring
  • statusstring · enum
    Enum values:
    DRAFT
    PENDING_APPROVAL
    PENDING_ACCOUNTING
    FINISHED
    REQUIRE_CHANGES
    REJECTED
  • integrationStatusstring · enum
    Enum values:
    PENDING
    COMPLETED
    ERROR
  • typestring · enum
    Enum values:
    REIMBURSEMENT
    CORPORATE_CARD
  • initialDatestring · date-time
  • endDatestring · date-time
  • pageNumberinteger
  • pageSizeinteger

​Lista despesas › Headers

  • x-flash-authstring · required

​Lista despesas › Responses

    • totalCountinteger · required
    • totalPagesinteger · required
    • expensesobject[] · required
GET /expenses/v1/expenses

​Finaliza despesas

POST
https://api.flashapp.services
/expenses/v1/expenses/accounting/finish

​Finaliza despesas › Headers

  • x-flash-authstring · required

​Finaliza despesas › Request Body

  • employeeIdstring · required
  • expenseIdsstring[]
  • tagCodesstring[]

​Finaliza despesas › Responses

    No schema specified
POST /expenses/v1/expenses/accounting/finish

​Reprovar despesas

POST
https://api.flashapp.services
/expenses/v1/expenses/accounting/reject

​Reprovar despesas › Headers

  • x-flash-authstring · required

​Reprovar despesas › Request Body

  • accountingCommentsstring · required
  • employeeIdstring · required
  • expenseIdsstring[]
  • tagCodesstring[]

​Reprovar despesas › Responses

    No schema specified
POST /expenses/v1/expenses/accounting/reject

​Solicitar ajustes das despesas

POST
https://api.flashapp.services
/expenses/v1/expenses/accounting/request-changes

​Solicitar ajustes das despesas › Headers

  • x-flash-authstring · required

​Solicitar ajustes das despesas › Request Body

  • accountingCommentsstring · required
  • employeeIdstring · required
  • expenseIdsstring[]
  • tagCodesstring[]

​Solicitar ajustes das despesas › Responses

    No schema specified
POST /expenses/v1/expenses/accounting/request-changes

​Atualiza o status da integração ERP de uma despesa

POST
https://api.flashapp.services
/expenses/v1/expenses/{expenseId}/integration/acknowledge

​Atualiza o status da integração ERP de uma despesa › path Parameters

  • expenseIdstring · required

​Atualiza o status da integração ERP de uma despesa › Headers

  • x-flash-authstring · required

​Atualiza o status da integração ERP de uma despesa › Request Body

  • statusstring · enum · required
    Enum values:
    COMPLETED
    ERROR
  • detailsstring
  • referencestring

​Atualiza o status da integração ERP de uma despesa › Responses

    No schema specified
POST /expenses/v1/expenses/{expenseId}/integration/acknowledge

Centros de custoDespesas | Categorias