Skip to main content

Flash

HR management platform for employee benefits, expenses, time tracking, and corporate cards

Flash Logo

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})

Available Actions

This connector provides 83 actions:

ActionPurposeParameters
get_core_v1_companiesLista empresas pertencentes ao grupo econômicoregistrationNumber (string)
get_core_v1_companies_by_company_idBusca uma empresa pelo seu identificador companyIdcompanyId (string)
post_core_v1_employeesAdiciona um colaborador a uma empresa. O parâmetro invitationDate caso seja enviado, irá reagendar a data de envio do convite do colaborador. Caso não seja enviado, o envio do convinte será feito imediatamente após a criação do documentodata: {
. companyId (string)
. documentNumber (string)
. email (string)
. externalId (string)
. invitationDate (string)
. name (string)
. phoneNumber (string)
. managerId (string)
} (object) required
get_core_v1_employeesBusca com multiplos valores devem ser feitas através de valores separados por vírgulalimit (number)
order (string)
page (number) required
sortBy (string)
query (string)
companyId (string)
status (string)
roleId (string)
documentNumbers (string)
externalIds (string)
get_core_v1_employees_by_employee_idBusca um colaborador pelo seu identificador employeeIdemployeeId (string)
delete_core_v1_employees_by_employee_idDeleta um colaborador dado employeeId, o colaborador não deve estar ativo status ACTIVE ou desativado status INACTIVEemployeeId (string)
patch_core_v1_employees_by_employee_idRealiza a atualização de alguns dados do colaborador. Emails corporativo e pessoal, número de telefone, nome, centro de custo, gestor imediato, ID externo. O parâmetro invitationDate, caso seja enviado, irá reagendar a data de envio do convite do colaborador. Não é aceito datas passadas. Caso o agendamento seja feito para o dia atual horário futuro, o envio será agendado para o próximo ciclo de envios, que acontece de hora em hora. Não é possível alterar a data de envio de convite para colaborademployeeId (string)
data: {
. companyId (string)
. corporateEmail (string)
. email (string)
. externalId (string)
. invitationDate (string)
. name (string)
. phoneNumber (string)
. managerId (string)
. costCenterId (string)
} (object) required
post_core_v1_employees_by_employee_id_reactivateMuda o status de um colaborador de desativado status INACTIVE para ativo status ACTIVEemployeeId (string)
post_core_v1_employees_by_employee_id_deactivateMuda o status de um colaborador de ativo status ACTIVE para desativado status INACTIVEemployeeId (string)
get_core_v1_departmentsLista todos os departamentos de uma empresacompanyId (string) required
post_core_v1_departmentsCria um novo departamento para uma empresadata: {
. name (string)
. description (string)
. externalId (string)
. companyId (string)
} (object) required
get_core_v1_departments_by_department_idBusca um departamento pelo seu identificador únicodepartmentId (string)
delete_core_v1_departments_by_department_idDeleta um departamento dado seu identificador único. Todos os colaboradores associados a este departamento serão removidos deste departamento.departmentId (string)
patch_core_v1_departments_by_department_idAtualiza os dados de um departamento existentedepartmentId (string)
data: {
. name (string)
. externalId (string)
. description (string)
} (object) required
post_core_v1_departments_by_department_id_membersVincula um colaborador a um departamento existente.departmentId (string)
data: {
. employeeId (string)
} (object) required
get_core_v1_rolesLista todos os cargos disponíveis para colaboradorescompanyId (string) required
post_core_v1_rolesCria um novo cargo para uma empresadata: {
. name (string)
. description (string)
. externalId (string)
. companyId (string)
. cbo (string)
} (object) required
get_core_v1_roles_by_role_idBusca um cargo pelo seu identificador únicoroleId (string)
patch_core_v1_roles_by_role_idAtualiza os dados de um cargo existenteroleId (string)
data: {
. name (string)
. externalId (string)
. description (string)
. cbo (string)
} (object) required
delete_core_v1_roles_by_role_idDeleta um cargo dado seu identificador único. Todos os colaboradores associados a este cargo serão removidos deste cargo.roleId (string)
post_core_v1_roles_by_role_id_membersVincula um colaborador a um cargo existente.roleId (string)
data: {
. employeeId (string)
} (object) required
get_core_v1_cost_centersLista centros de custo de uma empresa com base nos filtros fornecidoscompanyIds (string)
costCenterIds (string)
responsibleEmployeeIds (string)
search (string)
active (boolean)
skip (integer)
limit (integer)
post_core_v1_cost_centersCria um novo centro de custo para uma empresadata: {
. name (string)
. code (string)
. companyId (string)
. responsibleEmployeeId (string)
} (object) required
patch_core_v1_cost_centers_by_cost_center_idAtualiza os dados de um centro de custo existentecostCenterId (string)
data: {
. name (string)
. code (string)
. responsibleEmployeeId (string)
} (object) required
post_core_v1_cost_centers_by_cost_center_id_activateAtiva um centro de custo existentecostCenterId (string)
post_core_v1_cost_centers_by_cost_center_id_inactivateDesativa um centro de custo existentecostCenterId (string)
post_benefits_v1_ordersCria um pedido de benefícios para adicionar seus colaboradores com seus benefícios respectivosdata: {
. companyId (string)
} (object) required
get_benefits_v1_orders_by_order_idBusca um pedido com todos os detalhes a partir do seu identificadororderId (string)
post_benefits_v1_orders_by_order_id_depositsAdiciona um depósito de benefício à um colaboradororderId (string)
data: {
. employeeId (string)
. employeeName (string)
. employeeDocument (string)
. benefitId (string)
. benefitName (string)
. amount (integer)
} (object) required
post_benefits_v1_orders_by_order_id_deposits_by_deposit_id_cancelCancela um depósito específico de um pedidoorderId (string)
depositId (string)
get_benefits_v1_orders_deposits_employees_by_employee_idLista os depósitos de um colaborador específico. Por padrão, retorna todos os depósitos. Use o parâmetro status=pending para filtrar apenas depósitos com status SCHEDULED pendentes. Esta funcionalidade é especialmente útil para empresas que precisam realizar o cancelamento preventivo de benefícios para funcionários desligados.employeeId (string)
status (string)
page (integer)
limit (integer)
data: {
. companyId (string)
} (object) required
post_benefits_v1_orders_by_order_id_confirmConfirma um pedido finalizando a solicitação de depósitosorderId (string)
data: {
. cnpj (string)
. paymentMethod (string)
. adminEmail (string)
. creditDate (string)
. description (string)
. name (string)
} (object) required
post_benefits_v1_orders_by_order_id_cancelCancela um pedido que ainda não tenha sido disponibilizadoorderId (string)
data: {
. cancelReason (string)
} (object) required
get_benefits_v1_benefitsBusca Benefícios de uma empresacompanyId (string) required
status (string)
name (string)
get_expenses_v1_expensesLista despesascompanyId (string)
employeeIds (string)
status (string)
integrationStatus (string)
type (string)
initialDate (string)
endDate (string)
pageNumber (integer)
pageSize (integer)
post_expenses_v1_expenses_accounting_finishAtualiza as despesas para o status de finalizado.data: {
. employeeId (string)
. expenseIds (array)
. tagCodes (array)
} (object) required
post_expenses_v1_expenses_accounting_rejectAtualiza as despesas para o status de reprovado.data: {
. accountingComments (string)
. employeeId (string)
. expenseIds (array)
. tagCodes (array)
} (object) required
post_expenses_v1_expenses_accounting_request_changesAtualiza as despesas para o status de em revisão para que o colaborador possa corrigir os erros.data: {
. accountingComments (string)
. employeeId (string)
. expenseIds (array)
. tagCodes (array)
} (object) required
post_expenses_v1_expenses_by_expense_id_integration_acknowledgeAtualiza o campo integration de uma despesa, passando o obrigatoriamente status e opcionalmente details e reference.expenseId (string)
data: {
. status (string)
. details (string)
. reference (string)
} (object) required
post_expenses_v1_expenses_pdf_report_generate_asyncGera um relatório em PDF das despesas com base em filtros especificados. A geração é assíncrona e retorna um jobId para monitorar o progresso.data: {
. companyId (string)
. filter (object)
} (object) required
get_expenses_v1_expenses_pdf_report_generate_async_by_job_id_progressObtém o status e progresso de geração de um relatório em PDF iniciado anteriormente, passando-se o jobId na path da url da requisição.jobId (string)
get_expenses_v1_categoriesLista todas as categorias de despesa disponíveis para colaboradores.companyId (string) required
pageNumber (integer)
pageSize (integer)
post_expenses_v1_categoriesCria uma nova categoria de despesa para uma empresa.data: {
. companyId (string)
. name (string)
. externalId (string)
} (object) required
get_expenses_v1_categories_by_category_idBusca uma categoria de despesa pelo seu identificador único.categoryId (string)
patch_expenses_v1_categories_by_category_idAtualiza os dados de uma categoria de despesa existentecategoryId (string)
data: {
. status (string)
. name (string)
. externalId (string)
} (object) required
delete_expenses_v1_categories_by_category_idDeleta uma categoria de despesa dado seu identificador único. A categoria não pode ser deletada caso exista despesas associadas a ela.categoryId (string)
companyId (string) required
post_expenses_v1_projectsCria um novo projeto que pode ser associado a despesasdata: {
. companyId (string)
. active (boolean)
. name (string)
. code (string)
. assignee (object)
. dateRange (object)
} (object) required
get_expenses_v1_projectsLista projetos de uma empresa com base nos filtros fornecidoscompanyId (string) required
search (string)
assigneeIds (string)
active (boolean)
pageNumber (integer)
pageSize (integer)
patch_expenses_v1_projects_by_project_idAtualiza os dados de um projeto existenteprojectId (string)
data: {
. companyId (string)
. name (string)
. active (boolean)
. code (string)
. assignee (object)
. dateRange (object)
} (object) required
patch_expenses_v1_projects_by_project_id_enableAtiva um projeto existenteprojectId (string)
data: {
. companyId (string)
} (object) required
patch_expenses_v1_projects_by_project_id_disableDesativa um projeto existenteprojectId (string)
data: {
. companyId (string)
} (object) required
get_expenses_v1_fields_library_fields_get_by_code_by_codeBusca um campo customizado com base no seu código.code (string)
companyId (string) required
get_expenses_v1_fields_library_field_optionsLista opções de um campo customizado com base no ID do campo customizado, com opção de filtros.companyId (string) required
fieldId (string) required
search (string)
active (boolean)
pageNumber (number)
pageSize (number)
post_expenses_v1_fields_library_field_optionsCria uma opção de campo customizado que pode ser vinculada a despesas.data: {
. companyId (string)
. fieldId (string)
. active (boolean)
. name (string)
. code (string)
} (object) required
patch_expenses_v1_fields_library_field_options_by_field_option_idPermite editar o código, nome e status de uma opção de campo customizado com base no seu ID.fieldOptionId (string)
data: {
. companyId (string)
. active (boolean)
. name (string)
. code (string)
} (object) required
patch_expenses_v1_fields_library_field_options_by_field_option_id_enableAtiva uma opção de campo customizado com base no seu ID.fieldOptionId (string)
data: {
. companyId (string)
} (object) required
patch_expenses_v1_fields_library_field_options_by_field_option_id_disableDesativa uma opção de campo customizado com base no seu ID.fieldOptionId (string)
data: {
. companyId (string)
} (object) required
get_finance_v1_bill_by_bill_idBusca um pagamento pelo seu identificador billIdbillId (string)
post_hiring_v1_candidatesCria um candidatodata: {
. name (string)
. legalName (string)
. cnpj (string)
. nationality (string)
. documentNumber (string)
. managerId (string)
. followerEmployeeIds (array)
. email (string)
. phone (string)
. hiringDate (string)
. probationFirstDate (string)
. probationSecondDate (string)
. hiringCategory (string)
. companyId (string)
} (object) required
get_hiring_v1_candidatesLista candidatoscandidateIds (string)
name (string)
cnpj (string)
nationality (string)
documentNumber (string)
managerId (string)
email (string)
phone (string)
companyId (string)
page (integer)
pageSize (integer)
get_time_and_attendance_v1_attendance_dayLista marcações de pontodate (string) required
employeeId (string)
externalId (string)
companyId (string) required
get_time_and_attendance_v1_budgetsLista verbasyear (number) required
month (number) required
employeeIds (string)
externalIds (string)
budgetConfigId (string)
companyId (string) required
get_time_and_attendance_v1_eventsLista eventosyear (number) required
month (number) required
employeeIds (string)
externalIds (string)
companyId (string) required
post_time_and_attendance_v1_eventsCria ou atualiza um eventodata: {
. externalId (string)
. companyId (string)
. reasonId (number)
. reasonApiId (string)
. startDate (string)
. endDate (string)
} (object) required
patch_time_and_attendance_v1_events_cancelCancela eventosdata: {
. ids (array)
. companyId (string)
. justification (string)
} (object) required
get_time_and_attendance_v1_timetables_allocationsLista alocações de escalastartDate (string) required
endDate (string) required
employeeId (string)
externalId (string)
companyId (string) required
post_time_and_attendance_v1_timetables_allocationsCria alocações de escaladata: {
. timetableId (number)
. timetableApiId (string)
. startDate (string)
. endDate (string)
. employeeIds (array)
. externalIds (array)
. companyId (string)
} (object) required
get_time_and_attendance_v1_vacations_schedulesLista programações de fériasyear (number) required
month (number) required
employeeIds (string)
externalIds (string)
companyId (string) required
post_time_and_attendance_v1_vacations_schedulesCria ou atualiza uma programação de fériasdata: {
. externalId (string)
. startDate (string)
. endDate (string)
. startDateOfAcquisitionPeriod (string)
. endDateOfAcquisitionPeriod (string)
. advance13Salary (boolean)
. sellOneThird (boolean)
. installmentDiscount (boolean)
. managerMessage (string)
. status (string)
. companyId (string)
} (object) required
patch_time_and_attendance_v1_vacations_confirmationAtualiza uma efetivação de fériasdata: {
. vacationSchedules (array)
. ids (array)
. confirmation (boolean)
. companyId (string)
} (object) required
post_corporate_card_v1_orders_by_order_id_employeesAdiciona colaboradores ao pedido pelo identificadororderId (string)
data: {
. employees (array)
} (object) required
delete_corporate_card_v1_orders_by_order_idCancela um pedido pelo seu identificadororderId (string)
get_corporate_card_v1_orders_by_order_idBusca um pedido pelo seu identificadororderId (string)
delete_corporate_card_v1_orders_by_order_id_employees_by_employee_idRemove um colaborador do pedido em aberto utilizando o identificador do pedido e o identificador do colaboradoremployeeId (string)
orderId (string)
post_corporate_card_v1_orders_by_order_id_confirmConfirma um pedido em aberto utilizando o identificadororderId (string)
data: {
. paymentMethod (string)
. creditDate
. creditType (string)
. metadata (object)
} (object) required
post_corporate_card_v1_ordersCria um pedido em aberto utilizando o identificador da empresadata: {
. companyId (string)
} (object) required
delete_corporate_card_v1_deposits_by_deposit_idCancela um depósito de colaborador utilizando o identificador do depósitodepositId (string)
get_corporate_card_v1_balances_employee_by_employee_idBusca o saldo do colaborador utilizando o identificador do colaboradoremployeeId (string)
get_corporate_card_v1_balances_company_by_company_idBusca o saldo da empresa utilizando o identificador da empresacompanyId (string)
post_corporate_card_v1_balances_by_employee_id_refundEstorna o saldo do colaborador para a Carteira Corporativa utilizando o identificador do colaboradoremployeeId (string)
data: {
. amount (integer)
} (object) required
post_corporate_card_v1_cards_by_employee_id_toggle_corporate_modeAtiva ou desativa o uso corporativo do cartão de um colaborador utilizando o identificador do colaboradoremployeeId (string)
data: {
. active (boolean)
} (object) required
post_corporate_card_v1_orders_companyCria um pedido de Depósito da Empresa utilizando o identificador da empresa, o valor, a data de crédito, o método de pagamento e a descriçãodata: {
. companyId (string)
. amount (integer)
. creditDate
. paymentMethod (string)
. description (string)
} (object) required
get_corporate_card_v1_depositsLista depósitos utilizando diversos filtrosparams: {
. id
. status
. companyId (string)
. creditDate (object)
. employeeId
. orderId
. pageNumber (number)
. pageSize (number)
} (object) required