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 | Campos customizados

Endpoint:https://api.flashapp.services

​Buscar campo customizado pelo código

GET
https://api.flashapp.services
/expenses/v1/fields-library/fields/get-by-code/{code}

​Buscar campo customizado pelo código › query Parameters

  • companyIdstring · required

​Buscar campo customizado pelo código › Headers

  • x-flash-authstring · required

​Buscar campo customizado pelo código › Responses

    • idstring
    • companyIdstring
    • fieldstring · enum
      Enum values:
      CATEGORY
      COMMENT
      ATTACHMENT
      COST_CENTER
      PROJECT
      CUSTOM
    • customPropsobject
    • usageobject
    • audiencestring · enum
      Enum values:
      EVERYONE
      MANAGERS
    • requiredboolean
    • activeboolean
    • createdByobject
    • updatedByobject
GET /expenses/v1/fields-library/fields/get-by-code/{code}

​Listar opções de campo customizado

GET
https://api.flashapp.services
/expenses/v1/fields-library/field-options

​Listar opções de campo customizado › query Parameters

  • companyIdstring · required
  • fieldIdstring · required
  • searchstring
  • activeboolean
  • pageNumbernumber
    Default: 1
  • pageSizenumber
    Default: 10

​Listar opções de campo customizado › Headers

  • x-flash-authstring · required

​Listar opções de campo customizado › Responses

    • recordsobject[] · required
    • metadataobject · required
GET /expenses/v1/fields-library/field-options

​Criar opção de campo customizado

POST
https://api.flashapp.services
/expenses/v1/fields-library/field-options

​Criar opção de campo customizado › Headers

  • x-flash-authstring · required

​Criar opção de campo customizado › Request Body

  • companyIdstring · required
  • fieldIdstring · required
  • activeboolean · required
  • namestring · required
  • codestring · required

​Criar opção de campo customizado › Responses

    • idstring
    • companyIdstring
    • fieldIdstring
    • codestring
    • namestring
    • activeboolean
    • createdByobject
    • updatedByobject
POST /expenses/v1/fields-library/field-options

​Atualizar opção de campo customizado

PATCH
https://api.flashapp.services
/expenses/v1/fields-library/field-options/{fieldOptionId}

​Atualizar opção de campo customizado › path Parameters

  • fieldOptionIdstring · required

​Atualizar opção de campo customizado › Headers

  • x-flash-authstring · required

​Atualizar opção de campo customizado › Request Body

  • companyIdstring · required
  • activeboolean
  • namestring
  • codestring

​Atualizar opção de campo customizado › Responses

    • idstring
    • companyIdstring
    • fieldIdstring
    • codestring
    • namestring
    • activeboolean
    • createdByobject
    • updatedByobject
PATCH /expenses/v1/fields-library/field-options/{fieldOptionId}

​Ativar opção de campo customizado

PATCH
https://api.flashapp.services
/expenses/v1/fields-library/field-options/{fieldOptionId}/enable

​Ativar opção de campo customizado › path Parameters

  • fieldOptionIdstring · required

​Ativar opção de campo customizado › Headers

  • x-flash-authstring · required

​Ativar opção de campo customizado › Request Body

  • companyIdstring · required

​Ativar opção de campo customizado › Responses

    • idstring
    • companyIdstring
    • fieldIdstring
    • codestring
    • namestring
    • activeboolean
    • createdByobject
    • updatedByobject
PATCH /expenses/v1/fields-library/field-options/{fieldOptionId}/enable

​Desativar opção de campo customizado

PATCH
https://api.flashapp.services
/expenses/v1/fields-library/field-options/{fieldOptionId}/disable

​Desativar opção de campo customizado › path Parameters

  • fieldOptionIdstring · required

​Desativar opção de campo customizado › Headers

  • x-flash-authstring · required

​Desativar opção de campo customizado › Request Body

  • companyIdstring · required

​Desativar opção de campo customizado › Responses

    • idstring
    • companyIdstring
    • fieldIdstring
    • codestring
    • namestring
    • activeboolean
    • createdByobject
    • updatedByobject
PATCH /expenses/v1/fields-library/field-options/{fieldOptionId}/disable

Despesas | ProjetosDespesas | Relatórios PDF