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

​Cartão Corporativo

Endpoint:https://api.flashapp.services

​Adicionar colaboradores ao pedido em aberto

POST
https://api.flashapp.services
/corporate-card/v1/orders/{orderId}/employees

​Adicionar colaboradores ao pedido em aberto › path Parameters

  • orderIdstring · required

​Adicionar colaboradores ao pedido em aberto › Headers

  • x-flash-authstring · required

​Adicionar colaboradores ao pedido em aberto › Request Body

  • employeesobject[] · minItems: 1

​Adicionar colaboradores ao pedido em aberto › Responses

    • idstring
    • companyIdstring
    • statusstring
    • employeesobject[]
    • totalAmountnumber
    • failedEmployeesobject[]
    • createdAtstring
    • updatedAtstring
POST /corporate-card/v1/orders/{orderId}/employees

​Buscar pedido

GET
https://api.flashapp.services
/corporate-card/v1/orders/{orderId}

​Buscar pedido › path Parameters

  • orderIdstring · required

​Buscar pedido › Headers

  • x-flash-authstring · required

​Buscar pedido › Responses

    • idstring
    • companyIdstring
    • statusstring
    • paymentMethodstring
    • creditDatestring
    • employeesobject[]
    • totalAmountnumber
    • metadataobject
    • createdAtstring
    • updatedAtstring
GET /corporate-card/v1/orders/{orderId}

​Cancelar pedido em aberto

DELETE
https://api.flashapp.services
/corporate-card/v1/orders/{orderId}

​Cancelar pedido em aberto › path Parameters

  • orderIdstring · required

​Cancelar pedido em aberto › Headers

  • x-flash-authstring · required

​Cancelar pedido em aberto › Responses

    No schema specified
DELETE /corporate-card/v1/orders/{orderId}

​Remover colaborador do pedido em aberto

DELETE
https://api.flashapp.services
/corporate-card/v1/orders/{orderId}/employees/{employeeId}

​Remover colaborador do pedido em aberto › path Parameters

  • employeeIdstring · required
  • orderIdstring · required

​Remover colaborador do pedido em aberto › Headers

  • x-flash-authstring · required

​Remover colaborador do pedido em aberto › Responses

    • idstring
    • companyIdstring
    • statusstring
    • employeesobject[]
    • totalAmountnumber
    • createdAtstring
    • updatedAtstring
DELETE /corporate-card/v1/orders/{orderId}/employees/{employeeId}

​Confirmar pedido

POST
https://api.flashapp.services
/corporate-card/v1/orders/{orderId}/confirm

​Confirmar pedido › path Parameters

  • orderIdstring · required

​Confirmar pedido › Headers

  • x-flash-authstring · required

​Confirmar pedido › Request Body

  • paymentMethodstring · enum · required
    Enum values:
    BILLET
    PIX
  • creditDaterequired
  • creditTypestring · enum · required
    Enum values:
    ONCE
    ONCE_WITH_BALANCE_EXPIRATION
    RECURRING_DEPOSIT
    RECURRING_TOP-UP_DEPOSIT
  • metadataobject

​Confirmar pedido › Responses

    • idstring
    • companyIdstring
    • statusstring
    • paymentMethodstring
    • creditDatestring
    • creditTypestring
    • employeesobject[]
    • totalAmountnumber
    • metadataobject
    • createdAtstring
    • updatedAtstring
POST /corporate-card/v1/orders/{orderId}/confirm

​Criar pedido em aberto

POST
https://api.flashapp.services
/corporate-card/v1/orders

​Criar pedido em aberto › Headers

  • x-flash-authstring · required

​Criar pedido em aberto › Request Body

  • companyIdstring · required

​Criar pedido em aberto › Responses

    • idstring
    • companyIdstring
    • statusstring
    • totalAmountnumber
    • createdAtstring
    • updatedAtstring
POST /corporate-card/v1/orders

​Cancelar depósito de colaborador

DELETE
https://api.flashapp.services
/corporate-card/v1/deposits/{depositId}

​Cancelar depósito de colaborador › path Parameters

  • depositIdstring · required

​Cancelar depósito de colaborador › Headers

  • x-flash-authstring · required

​Cancelar depósito de colaborador › Responses

    • idstring
    • orderIdstring
    • employeeIdstring
    • statusstring · enum
      Enum values:
      CANCELLED
    • createdAtstring
    • updatedAtstring
DELETE /corporate-card/v1/deposits/{depositId}

​Buscar saldo do colaborador

GET
https://api.flashapp.services
/corporate-card/v1/balances/employee/{employeeId}

​Buscar saldo do colaborador › path Parameters

  • employeeIdstring · required

​Buscar saldo do colaborador › Headers

  • x-flash-authstring · required

​Buscar saldo do colaborador › Responses

    • balancenumber
GET /corporate-card/v1/balances/employee/{employeeId}

​Buscar saldo da empresa

GET
https://api.flashapp.services
/corporate-card/v1/balances/company/{companyId}

​Buscar saldo da empresa › path Parameters

  • companyIdstring · required

​Buscar saldo da empresa › Responses

    • balancenumber
GET /corporate-card/v1/balances/company/{companyId}

​Estornar saldo do colaborador

POST
https://api.flashapp.services
/corporate-card/v1/balances/{employeeId}/refund

​Estornar saldo do colaborador › path Parameters

  • employeeIdstring · required

​Estornar saldo do colaborador › Headers

  • x-flash-authstring · required

​Estornar saldo do colaborador › Request Body

  • amountinteger · required

​Estornar saldo do colaborador › Responses

    No schema specified
POST /corporate-card/v1/balances/{employeeId}/refund

​Ativar/desativar uso corporativo

POST
https://api.flashapp.services
/corporate-card/v1/cards/{employeeId}/toggle-corporate-mode

​Ativar/desativar uso corporativo › path Parameters

  • employeeIdstring · required

​Ativar/desativar uso corporativo › Request Body

  • activeboolean · required

​Ativar/desativar uso corporativo › Responses

    No schema specified
POST /corporate-card/v1/cards/{employeeId}/toggle-corporate-mode

​Criar pedido de depósito da empresa

POST
https://api.flashapp.services
/corporate-card/v1/orders/company

​Criar pedido de depósito da empresa › Request Body

  • companyIdstring · required
  • amountinteger · required
  • creditDaterequired
  • paymentMethodstring · enum · required
    Enum values:
    BILLET
    PIX
  • descriptionstring

​Criar pedido de depósito da empresa › Responses

    • idstring
    • companyIdstring
    • statusstring
    • paymentMethodstring · enum
      Enum values:
      BILLET
      PIX
    • amountnumber
    • creditDatestring
    • descriptionstring
    • createdAtstring
    • updatedAtstring
POST /corporate-card/v1/orders/company

​Listar depósitos

GET
https://api.flashapp.services
/corporate-card/v1/deposits

​Listar depósitos › query Parameters

  • paramsobject · required

​Listar depósitos › Responses

    • depositsobject[]
    • metadataobject
GET /corporate-card/v1/deposits

Despesas | Relatórios PDF