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

​Benefícios

Endpoint:https://api.flashapp.services

​Cria um pedido de benefícios

POST
https://api.flashapp.services
/benefits/v1/orders

​Cria um pedido de benefícios › Headers

  • x-flash-authstring · required

​Cria um pedido de benefícios › Request Body

  • companyIdstring · required
    Example: jVZ0hM9pAXh5SPoqIzLxo

​Cria um pedido de benefícios › Responses

    • idstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • companyIdstring · required
      Example: BRzfhIEKnyOE4jopUAaXw
    • statusstring · enum · required
      Enum values:
      requested
      billed
      canceled
      paid
      available
    • createdAtstring · date-time · required
    • creditTypestring · enum · required
      Enum values:
      accumulative
    • descriptionstring
      Example: Descrição para o pedido
    • billIdstring
      Example: UbZ8lwwN9i2OPcCbVGGuS
    • paymentMethodstring · enum
      Enum values:
      BILLET
    • creditDatestring · date-time
    • totalFeeinteger
      Example: 100
    • totalAmountinteger
      Example: 10000
POST /benefits/v1/orders

​Busca um pedido pelo seu identificador

GET
https://api.flashapp.services
/benefits/v1/orders/{orderId}

​Busca um pedido pelo seu identificador › path Parameters

  • orderIdstring · required

​Busca um pedido pelo seu identificador › Headers

  • x-flash-authstring · required

​Busca um pedido pelo seu identificador › Responses

    • idstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • companyIdstring · required
      Example: BRzfhIEKnyOE4jopUAaXw
    • statusstring · enum · required
      Enum values:
      requested
      billed
      canceled
      paid
      available
      waiting_approval
    • createdAtstring · date-time · required
    • creditTypestring · enum · required
      Enum values:
      accumulative
    • descriptionstring
      Example: Descrição para o pedido
    • namestring
      Example: Nome do pedido
    • billIdstring
      Example: UbZ8lwwN9i2OPcCbVGGuS
    • paymentMethodstring · enum
      Enum values:
      BILLET
      BALANCE
    • creditDatestring · date-time
    • totalFeeinteger
      Example: 100
    • totalAmountinteger
      Example: 10000
GET /benefits/v1/orders/{orderId}

​Adiciona um depósito de benefício à um colaborador

POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/deposits

​Adiciona um depósito de benefício à um colaborador › path Parameters

  • orderIdstring · required

​Adiciona um depósito de benefício à um colaborador › Headers

  • x-flash-authstring · required

​Adiciona um depósito de benefício à um colaborador › Request Body

  • employeeIdstring · required
    Example: ZWB1x6jkPBI2Ac56FRJec
  • employeeNamestring · required
    Example: João da Silva
  • employeeDocumentstring · required
    Example: 99999999999
  • benefitIdstring · required
    Example: 6iKE5def3S3WF6XvE0FvL
  • benefitNamestring · required
    Example: Vale Refeição
  • amountinteger · required
    Example: 950

​Adiciona um depósito de benefício à um colaborador › Responses

    • idstring · required
      Example: DjgJKJvYVBoMR_H94a9eb
    • orderIdstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • employeeIdstring · required
      Example: ZWB1x6jkPBI2Ac56FRJec
    • employeeNamestring · required
      Example: João da Silva
    • employeeDocumentstring · required
      Example: 99999999999
    • benefitIdstring · required
      Example: 6iKE5def3S3WF6XvE0FvL
    • benefitNamestring · required
      Example: Vale Refeição
    • amountinteger · required
      Example: 950
    • feeinteger · required
    • statusstring · enum · required
      Enum values:
      created
      canceled
      Example: created
    • createdAtstring · date-time · required
      Example: 2025-07-21T10:30:00.000Z
POST /benefits/v1/orders/{orderId}/deposits

​Cancela um depósito específico de um pedido

POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/deposits/{depositId}/cancel

​Cancela um depósito específico de um pedido › path Parameters

  • orderIdstring · required
  • depositIdstring · required

​Cancela um depósito específico de um pedido › Headers

  • x-flash-authstring · required

​Cancela um depósito específico de um pedido › Responses

    • idstring · required
      Example: DjgJKJvYVBoMR_H94a9eb
    • orderIdstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • employeeIdstring · required
      Example: ZWB1x6jkPBI2Ac56FRJec
    • employeeNamestring · required
      Example: João da Silva
    • employeeDocumentstring · required
      Example: 99999999999
    • benefitIdstring · required
      Example: 6iKE5def3S3WF6XvE0FvL
    • benefitNamestring · required
      Example: Vale Refeição
    • amountinteger · required
      Example: 950
    • feeinteger · required
    • statusstring · enum · required
      Enum values:
      created
      canceled
      Example: created
    • createdAtstring · date-time · required
      Example: 2025-07-21T10:30:00.000Z
POST /benefits/v1/orders/{orderId}/deposits/{depositId}/cancel

​Lista depósitos por colaborador

GET
https://api.flashapp.services
/benefits/v1/orders/deposits/employees/{employeeId}

​Lista depósitos por colaborador › path Parameters

  • employeeIdstring · required

​Lista depósitos por colaborador › query Parameters

  • statusstring · enum
    Enum values:
    pending
  • pageinteger
    Default: 1
  • limitinteger · min: 1
    Default: 100

​Lista depósitos por colaborador › Headers

  • x-flash-authstring · required

​Lista depósitos por colaborador › Request Body

  • companyIdstring · required
    Example: jVZ0hM9pAXh5SPoqIzLxo

​Lista depósitos por colaborador › Responses

    • dataobject[] · required
    • pageinteger · required
      Example: 1
    • limitinteger · required
      Example: 100
    • countinteger · required
      Example: 2
GET /benefits/v1/orders/deposits/employees/{employeeId}

​Confirma um pedido finalizando a solicitação de depósitos

POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/confirm

​Confirma um pedido finalizando a solicitação de depósitos › path Parameters

  • orderIdstring · required

​Confirma um pedido finalizando a solicitação de depósitos › Headers

  • x-flash-authstring · required

​Confirma um pedido finalizando a solicitação de depósitos › Request Body

  • cnpjstring · required
    Example: 12345678901234
  • paymentMethodstring · enum · required
    Enum values:
    BILLET
    BALANCE
    Example: BILLET
  • adminEmailstring · required
    Example: admin@flashapp.com.br
  • creditDatestring · date-time · required
    Example: 2030-12-31T14:03:41.369Z
  • descriptionstring
  • namestring

​Confirma um pedido finalizando a solicitação de depósitos › Responses

    • idstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • companyIdstring · required
      Example: BRzfhIEKnyOE4jopUAaXw
    • statusstring · enum · required
      Enum values:
      requested
      billed
      canceled
      paid
      available
      waiting_approval
    • createdAtstring · date-time · required
    • creditTypestring · enum · required
      Enum values:
      accumulative
    • descriptionstring
      Example: Descrição para o pedido
    • namestring
      Example: Nome do pedido
    • billIdstring
      Example: UbZ8lwwN9i2OPcCbVGGuS
    • paymentMethodstring · enum
      Enum values:
      BILLET
      BALANCE
    • creditDatestring · date-time
    • totalFeeinteger
      Example: 100
    • totalAmountinteger
      Example: 10000
POST /benefits/v1/orders/{orderId}/confirm

​Cancela um pedido que ainda não tenha sido disponibilizado

POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/cancel

​Cancela um pedido que ainda não tenha sido disponibilizado › path Parameters

  • orderIdstring · required

​Cancela um pedido que ainda não tenha sido disponibilizado › Headers

  • x-flash-authstring · required

​Cancela um pedido que ainda não tenha sido disponibilizado › Request Body

  • cancelReasonstring · required

​Cancela um pedido que ainda não tenha sido disponibilizado › Responses

    • idstring · required
      Example: yvfSepYdwUI4SlUFkCAzQ
    • companyIdstring · required
      Example: BRzfhIEKnyOE4jopUAaXw
    • statusstring · enum · required
      Enum values:
      requested
      billed
      canceled
      paid
      available
    • createdAtstring · date-time · required
    • creditTypestring · enum · required
      Enum values:
      accumulative
    • descriptionstring
      Example: Descrição para o pedido
    • billIdstring
      Example: UbZ8lwwN9i2OPcCbVGGuS
    • paymentMethodstring · enum
      Enum values:
      BILLET
    • creditDatestring · date-time
    • totalFeeinteger
      Example: 100
    • totalAmountinteger
      Example: 10000
POST /benefits/v1/orders/{orderId}/cancel

​Busca Benefícios de uma empresa

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

​Busca Benefícios de uma empresa › query Parameters

  • companyIdstring · required
  • statusstring
  • namestring

​Busca Benefícios de uma empresa › Headers

  • x-flash-authstring · required

​Busca Benefícios de uma empresa › Responses

    • idstring · required
    • companyIdstring · required
    • statusstring · enum · required
      Enum values:
      active
      inactive
    • namestring · required
    • emojistring · required
    • descriptionstring · required
    • descriptionAppstring · required
    • descriptionDepositstring · required
    • transactionMethodsstring[] · required
    • billetCategoriesstring[] · required
    • depositTimeUnitstring · enum · required
      Enum values:
      month
      day
    • createdAtstring · required
    • categoriesobject[]
    • depositFeesobject[]
    • topupDepositEnabledboolean
GET /benefits/v1/benefits

ColaboradoresCandidatos