Flash
HR management platform for employee benefits, expenses, time tracking, and corporate cards
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:
| Action | Purpose | Parameters |
|---|---|---|
| get_core_v1_companies | Lista empresas pertencentes ao grupo econômico | registrationNumber (string) |
| get_core_v1_companies_by_company_id | Busca uma empresa pelo seu identificador companyId | companyId (string) |
| post_core_v1_employees | Adiciona 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 documento | data: { . companyId (string) . documentNumber (string) . email (string) . externalId (string) . invitationDate (string) . name (string) . phoneNumber (string) . managerId (string) } (object) required |
| get_core_v1_employees | Busca com multiplos valores devem ser feitas através de valores separados por vírgula | limit (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_id | Busca um colaborador pelo seu identificador employeeId | employeeId (string) |
| delete_core_v1_employees_by_employee_id | Deleta um colaborador dado employeeId, o colaborador não deve estar ativo status ACTIVE ou desativado status INACTIVE | employeeId (string) |
| patch_core_v1_employees_by_employee_id | Realiza 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 colaborad | employeeId (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_reactivate | Muda o status de um colaborador de desativado status INACTIVE para ativo status ACTIVE | employeeId (string) |
| post_core_v1_employees_by_employee_id_deactivate | Muda o status de um colaborador de ativo status ACTIVE para desativado status INACTIVE | employeeId (string) |
| get_core_v1_departments | Lista todos os departamentos de uma empresa | companyId (string) required |
| post_core_v1_departments | Cria um novo departamento para uma empresa | data: { . name (string) . description (string) . externalId (string) . companyId (string) } (object) required |
| get_core_v1_departments_by_department_id | Busca um departamento pelo seu identificador único | departmentId (string) |
| delete_core_v1_departments_by_department_id | Deleta 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_id | Atualiza os dados de um departamento existente | departmentId (string) data: { . name (string) . externalId (string) . description (string) } (object) required |
| post_core_v1_departments_by_department_id_members | Vincula um colaborador a um departamento existente. | departmentId (string) data: { . employeeId (string) } (object) required |
| get_core_v1_roles | Lista todos os cargos disponíveis para colaboradores | companyId (string) required |
| post_core_v1_roles | Cria um novo cargo para uma empresa | data: { . name (string) . description (string) . externalId (string) . companyId (string) . cbo (string) } (object) required |
| get_core_v1_roles_by_role_id | Busca um cargo pelo seu identificador único | roleId (string) |
| patch_core_v1_roles_by_role_id | Atualiza os dados de um cargo existente | roleId (string) data: { . name (string) . externalId (string) . description (string) . cbo (string) } (object) required |
| delete_core_v1_roles_by_role_id | Deleta 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_members | Vincula um colaborador a um cargo existente. | roleId (string) data: { . employeeId (string) } (object) required |
| get_core_v1_cost_centers | Lista centros de custo de uma empresa com base nos filtros fornecidos | companyIds (string) costCenterIds (string) responsibleEmployeeIds (string) search (string) active (boolean) skip (integer) limit (integer) |
| post_core_v1_cost_centers | Cria um novo centro de custo para uma empresa | data: { . name (string) . code (string) . companyId (string) . responsibleEmployeeId (string) } (object) required |
| patch_core_v1_cost_centers_by_cost_center_id | Atualiza os dados de um centro de custo existente | costCenterId (string) data: { . name (string) . code (string) . responsibleEmployeeId (string) } (object) required |
| post_core_v1_cost_centers_by_cost_center_id_activate | Ativa um centro de custo existente | costCenterId (string) |
| post_core_v1_cost_centers_by_cost_center_id_inactivate | Desativa um centro de custo existente | costCenterId (string) |
| post_benefits_v1_orders | Cria um pedido de benefícios para adicionar seus colaboradores com seus benefícios respectivos | data: { . companyId (string) } (object) required |
| get_benefits_v1_orders_by_order_id | Busca um pedido com todos os detalhes a partir do seu identificador | orderId (string) |
| post_benefits_v1_orders_by_order_id_deposits | Adiciona um depósito de benefício à um colaborador | orderId (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_cancel | Cancela um depósito específico de um pedido | orderId (string) depositId (string) |
| get_benefits_v1_orders_deposits_employees_by_employee_id | Lista 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_confirm | Confirma um pedido finalizando a solicitação de depósitos | orderId (string) data: { . cnpj (string) . paymentMethod (string) . adminEmail (string) . creditDate (string) . description (string) . name (string) } (object) required |
| post_benefits_v1_orders_by_order_id_cancel | Cancela um pedido que ainda não tenha sido disponibilizado | orderId (string) data: { . cancelReason (string) } (object) required |
| get_benefits_v1_benefits | Busca Benefícios de uma empresa | companyId (string) required status (string) name (string) |
| get_expenses_v1_expenses | Lista despesas | companyId (string) employeeIds (string) status (string) integrationStatus (string) type (string) initialDate (string) endDate (string) pageNumber (integer) pageSize (integer) |
| post_expenses_v1_expenses_accounting_finish | Atualiza as despesas para o status de finalizado. | data: { . employeeId (string) . expenseIds (array) . tagCodes (array) } (object) required |
| post_expenses_v1_expenses_accounting_reject | Atualiza as despesas para o status de reprovado. | data: { . accountingComments (string) . employeeId (string) . expenseIds (array) . tagCodes (array) } (object) required |
| post_expenses_v1_expenses_accounting_request_changes | Atualiza 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_acknowledge | Atualiza 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_async | Gera 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_progress | Obté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_categories | Lista todas as categorias de despesa disponíveis para colaboradores. | companyId (string) required pageNumber (integer) pageSize (integer) |
| post_expenses_v1_categories | Cria uma nova categoria de despesa para uma empresa. | data: { . companyId (string) . name (string) . externalId (string) } (object) required |
| get_expenses_v1_categories_by_category_id | Busca uma categoria de despesa pelo seu identificador único. | categoryId (string) |
| patch_expenses_v1_categories_by_category_id | Atualiza os dados de uma categoria de despesa existente | categoryId (string) data: { . status (string) . name (string) . externalId (string) } (object) required |
| delete_expenses_v1_categories_by_category_id | Deleta 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_projects | Cria um novo projeto que pode ser associado a despesas | data: { . companyId (string) . active (boolean) . name (string) . code (string) . assignee (object) . dateRange (object) } (object) required |
| get_expenses_v1_projects | Lista projetos de uma empresa com base nos filtros fornecidos | companyId (string) required search (string) assigneeIds (string) active (boolean) pageNumber (integer) pageSize (integer) |
| patch_expenses_v1_projects_by_project_id | Atualiza os dados de um projeto existente | projectId (string) data: { . companyId (string) . name (string) . active (boolean) . code (string) . assignee (object) . dateRange (object) } (object) required |
| patch_expenses_v1_projects_by_project_id_enable | Ativa um projeto existente | projectId (string) data: { . companyId (string) } (object) required |
| patch_expenses_v1_projects_by_project_id_disable | Desativa um projeto existente | projectId (string) data: { . companyId (string) } (object) required |
| get_expenses_v1_fields_library_fields_get_by_code_by_code | Busca um campo customizado com base no seu código. | code (string) companyId (string) required |
| get_expenses_v1_fields_library_field_options | Lista 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_options | Cria 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_id | Permite 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_enable | Ativa 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_disable | Desativa uma opção de campo customizado com base no seu ID. | fieldOptionId (string) data: { . companyId (string) } (object) required |
| get_finance_v1_bill_by_bill_id | Busca um pagamento pelo seu identificador billId | billId (string) |
| post_hiring_v1_candidates | Cria um candidato | data: { . 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_candidates | Lista candidatos | candidateIds (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_day | Lista marcações de ponto | date (string) required employeeId (string) externalId (string) companyId (string) required |
| get_time_and_attendance_v1_budgets | Lista verbas | year (number) required month (number) required employeeIds (string) externalIds (string) budgetConfigId (string) companyId (string) required |
| get_time_and_attendance_v1_events | Lista eventos | year (number) required month (number) required employeeIds (string) externalIds (string) companyId (string) required |
| post_time_and_attendance_v1_events | Cria ou atualiza um evento | data: { . externalId (string) . companyId (string) . reasonId (number) . reasonApiId (string) . startDate (string) . endDate (string) } (object) required |
| patch_time_and_attendance_v1_events_cancel | Cancela eventos | data: { . ids (array) . companyId (string) . justification (string) } (object) required |
| get_time_and_attendance_v1_timetables_allocations | Lista alocações de escala | startDate (string) required endDate (string) required employeeId (string) externalId (string) companyId (string) required |
| post_time_and_attendance_v1_timetables_allocations | Cria alocações de escala | data: { . timetableId (number) . timetableApiId (string) . startDate (string) . endDate (string) . employeeIds (array) . externalIds (array) . companyId (string) } (object) required |
| get_time_and_attendance_v1_vacations_schedules | Lista programações de férias | year (number) required month (number) required employeeIds (string) externalIds (string) companyId (string) required |
| post_time_and_attendance_v1_vacations_schedules | Cria ou atualiza uma programação de férias | data: { . 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_confirmation | Atualiza uma efetivação de férias | data: { . vacationSchedules (array) . ids (array) . confirmation (boolean) . companyId (string) } (object) required |
| post_corporate_card_v1_orders_by_order_id_employees | Adiciona colaboradores ao pedido pelo identificador | orderId (string) data: { . employees (array) } (object) required |
| delete_corporate_card_v1_orders_by_order_id | Cancela um pedido pelo seu identificador | orderId (string) |
| get_corporate_card_v1_orders_by_order_id | Busca um pedido pelo seu identificador | orderId (string) |
| delete_corporate_card_v1_orders_by_order_id_employees_by_employee_id | Remove um colaborador do pedido em aberto utilizando o identificador do pedido e o identificador do colaborador | employeeId (string) orderId (string) |
| post_corporate_card_v1_orders_by_order_id_confirm | Confirma um pedido em aberto utilizando o identificador | orderId (string) data: { . paymentMethod (string) . creditDate . creditType (string) . metadata (object) } (object) required |
| post_corporate_card_v1_orders | Cria um pedido em aberto utilizando o identificador da empresa | data: { . companyId (string) } (object) required |
| delete_corporate_card_v1_deposits_by_deposit_id | Cancela um depósito de colaborador utilizando o identificador do depósito | depositId (string) |
| get_corporate_card_v1_balances_employee_by_employee_id | Busca o saldo do colaborador utilizando o identificador do colaborador | employeeId (string) |
| get_corporate_card_v1_balances_company_by_company_id | Busca o saldo da empresa utilizando o identificador da empresa | companyId (string) |
| post_corporate_card_v1_balances_by_employee_id_refund | Estorna o saldo do colaborador para a Carteira Corporativa utilizando o identificador do colaborador | employeeId (string) data: { . amount (integer) } (object) required |
| post_corporate_card_v1_cards_by_employee_id_toggle_corporate_mode | Ativa ou desativa o uso corporativo do cartão de um colaborador utilizando o identificador do colaborador | employeeId (string) data: { . active (boolean) } (object) required |
| post_corporate_card_v1_orders_company | Cria 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ção | data: { . companyId (string) . amount (integer) . creditDate . paymentMethod (string) . description (string) } (object) required |
| get_corporate_card_v1_deposits | Lista depósitos utilizando diversos filtros | params: { . id . status . companyId (string) . creditDate (object) . employeeId . orderId . pageNumber (number) . pageSize (number) } (object) required |