• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/hcm_payroll_vacation (HCM - Payroll Vacation General Processor)/HCM – Payroll Vacation General (general)
Mais pesquisados:Customização, Tutorial, Documentação

HCM – Payroll Vacation General (general)

108 views 0 23/09/2025 Atualizado em 10/11/2026 integrador

2.0info: 9.16.1 HCM – Payroll Vacation General description: HCM – Payroll Vacation General x-senior-domain: HCM – Payroll Vacation General x-senior-domain-path: hcm_payroll_vacation x-senior-service-path: general contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_payroll_vacationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/employeeAcquisitivePeriodLookup: post: description: Primitiva para consultar os dados dos Período aquisitivo do colaborador (employeeAcquisitivePeriod) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para consultar os dados dos Período aquisitivo do colaborador (employeeAcquisitivePeriod) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/vacationReceiptLookup: post: description: Primitiva para consultar os dados dos Recibos de férias (vacationReceipt) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para consultar os dados dos Recibos de férias (vacationReceipt) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getVacationInformationWiipoIntegrationData: post: description: Busca informações dos recibos de férias para integração com Wiipo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Índice da página minimum: 0 default: 0 limit: type: integer format: int64 description: Tamanho da página minimum: 1 default: 10 startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data final companyIds: type: array items: type: string description: Identificadores das empresas employeeIds: type: array items: type: string description: Identificadores de colaboradores vacationScheduleIds: type: array items: type: string description: Identificadores das programações de férias integrateFgts: type: boolean description: Identificador de integração do FGTS integrateInformative: type: boolean description: Identificador de integração de informativas integrateDeductiveInformative: type: boolean description: Identificador de integração de informativas dedutivas responses: 200: description: Ok schema: type: object required: – vacationSchedules properties: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleWiipoIntegrationDataDTO minimum: 1 description: Programações de férias (com seus recibos) para a integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/vacationScheduleLookup: post: description: Primitiva para consultar os dados das Programações de férias (vacationSchedule) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para consultar os dados das Programações de férias (vacationSchedule) utilizados em lookups das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/oldestOpenEmployeeAcquisitivePeriod: post: description: Primitiva que retorna o período aquisitívo mais antigo em aberto do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Identificador único do colaborador responses: 200: description: Ok schema: type: object properties: oldestOpenEmployeeAcquisitivePeriod: type: object allOf: – #/definitions/employeeAcquisitivePeriodCustomDTO description: Período aquisitivo mais antigo do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva que retorna o período aquisitívo mais antigo em aberto do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador único do colaborador in: query required: true type: string responses: 200: description: Ok schema: type: object properties: oldestOpenEmployeeAcquisitivePeriod: type: object allOf: – #/definitions/employeeAcquisitivePeriodCustomDTO description: Período aquisitivo mais antigo do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listVacationReceiptDetailCustom: post: description: Primitiva que realizar a busca customizada dos detalhes do recibo de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationReceipt properties: vacationReceipt: type: string description: Identificador do recibo de férias size: type: integer format: int64 description: Tamanho da página minimum: 10 maximum: 100 default: 10 offset: type: integer format: int64 description: Página minimum: 0 default: 0 orderBy: type: object allOf: – #/definitions/ordinationVacationReceiptDetail description: Ordenação. Caso não seja informada, ordenada pela tipo de identificação do evento. responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/vacationReceiptDetailCustomDTO minimum: 1 description: Demonstrativos de pagamento totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getDisregardedVacationDaysInVacationPeriod: post: description: Primita que retorna os dias a desconsiderar dentro do período de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – startDate – vacationDays properties: employeeId: type: string maxLength: 36 description: Identificador do colaborador startDate: type: string format: date description: Início da férias vacationDays: type: number format: double description: Dias de férias responses: 200: description: Ok schema: type: object required: – disregardedDays properties: disregardedDays: type: array items: type: string format: date minimum: 1 description: Dias a desconsiderar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primita que retorna os dias a desconsiderar dentro do período de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador do colaborador in: query required: true type: string maxLength: 36 – name: startDate description: Início da férias in: query required: true type: string format: date – name: vacationDays description: Dias de férias in: query required: true type: number format: double responses: 200: description: Ok schema: type: object required: – disregardedDays properties: disregardedDays: type: array items: type: string format: date minimum: 1 description: Dias a desconsiderar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listVacationReceiptDetailApiTest: post: description: Lista os eventos calculados de um recibo de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – vacationScheduleStartDate properties: employee: type: string maxLength: 36 description: Colaborador acquisitivePeriodStartDate: type: string format: date description: Data inicial do perído aquisitivo vacationScheduleStartDate: type: string format: date description: Data inicial da programação de férias vacationReceiptStartDate: type: string format: date description: Data inicial do recibo de férias responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/vacationReceiptWageTypeDTO minimum: 1 description: Eventos calculados do recibo de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os eventos calculados de um recibo de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: acquisitivePeriodStartDate description: Data inicial do perído aquisitivo in: query type: string format: date – name: vacationScheduleStartDate description: Data inicial da programação de férias in: query required: true type: string format: date – name: vacationReceiptStartDate description: Data inicial do recibo de férias in: query type: string format: date responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/vacationReceiptWageTypeDTO minimum: 1 description: Eventos calculados do recibo de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/isReintegrationLeaveEndDateGreaterOrEqualToDate: post: description: Verifica se a data final do afastamento criado na reintegração do colaborador é maior ou igual a data inicial das férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – startDate properties: employeeId: type: string maxLength: 36 description: Identificador único do colabroador startDate: type: string format: date description: Data inicial das férias responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se a data final do afastamento criado na reintegração do colaborador é maior ou igual a data inicial das férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador único do colabroador in: query required: true type: string maxLength: 36 – name: startDate description: Data inicial das férias in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/validatePaymentTitlesForIntegration: post: description: Validação prévia dos títulos de pagamento de férias para integração bancária tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paymentTitleIds properties: paymentTitleIds: type: array items: type: string minimum: 1 description: Identificadores dos títulos de pagamento responses: 200: description: Ok schema: type: object required: – titles properties: titles: type: array items: type: object allOf: – #/definitions/vacationPaymentTitleIntegrationEligibilityDTO minimum: 1 description: Elegibilidade de cada título informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getPaymentTitleSidebarDetail: post: description: Detalhe de um título de pagamento para a barra lateral da tela de integração bancária tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paymentTitleId properties: paymentTitleId: type: string maxLength: 36 description: Identificador do título de pagamento responses: 200: description: Ok schema: type: object required: – payment – statusHistory properties: payment: type: object allOf: – #/definitions/vacationPaymentTitleSidebarPaymentDTO description: Dados do pagamento bankAccount: type: object allOf: – #/definitions/vacationPaymentTitleSidebarBankAccountDTO description: Conta bancária do favorecido, nula quando não resolvida bankAccountError: type: string maxLength: 255 description: Motivo de a conta bancária do favorecido não ter sido resolvida statusHistory: type: array items: type: object allOf: – #/definitions/vacationPaymentTitleSidebarStatusHistoryDTO minimum: 1 description: Histórico de status do título em ordem cronológica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Detalhe de um título de pagamento para a barra lateral da tela de integração bancária tags: – Queries x-senior-visibility: PRIVATE parameters: – name: paymentTitleId description: Identificador do título de pagamento in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – payment – statusHistory properties: payment: type: object allOf: – #/definitions/vacationPaymentTitleSidebarPaymentDTO description: Dados do pagamento bankAccount: type: object allOf: – #/definitions/vacationPaymentTitleSidebarBankAccountDTO description: Conta bancária do favorecido, nula quando não resolvida bankAccountError: type: string maxLength: 255 description: Motivo de a conta bancária do favorecido não ter sido resolvida statusHistory: type: array items: type: object allOf: – #/definitions/vacationPaymentTitleSidebarStatusHistoryDTO minimum: 1 description: Histórico de status do título em ordem cronológica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getVacationProvision: post: description: Retorna as provisões de férias de um período aquisitivo em uma competência, incluindo detalhes e bases. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeAcquisitivePeriod – competence properties: employeeAcquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo competence: type: string format: date description: Competência responses: 200: description: Ok schema: type: object required: – vacationProvisions properties: vacationProvisions: type: array items: type: object allOf: – #/definitions/vacationProvisionDTO minimum: 1 description: Provisões de férias encontradas, uma por alocação: na competência de uma transferência de filial ou de centro de custo são duas, a da alocação de origem e a da de destino. Lista vazia quando não existe provisão para o período/competência informados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as provisões de férias de um período aquisitivo em uma competência, incluindo detalhes e bases. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeAcquisitivePeriod description: Período aquisitivo in: query required: true type: string maxLength: 36 – name: competence description: Competência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – vacationProvisions properties: vacationProvisions: type: array items: type: object allOf: – #/definitions/vacationProvisionDTO minimum: 1 description: Provisões de férias encontradas, uma por alocação: na competência de uma transferência de filial ou de centro de custo são duas, a da alocação de origem e a da de destino. Lista vazia quando não existe provisão para o período/competência informados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getVacationProvisionByEmployee: post: description: Retorna as provisões de férias de um colaborador em uma competência, resolvendo internamente todos os período(s) aquisitivo(s) em aberto. Um colaborador pode ter mais de um período aquisitivo aberto ao mesmo tempo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – competence properties: employee: type: string maxLength: 36 description: Colaborador competence: type: string format: date description: Competência responses: 200: description: Ok schema: type: object required: – vacationProvisions properties: vacationProvisions: type: array items: type: object allOf: – #/definitions/vacationProvisionDTO minimum: 1 description: Provisões de férias do colaborador na competência, uma entrada por período aquisitivo/alocação, ordenadas pela data de início do período aquisitivo (crescente). Lista vazia quando não existe provisão para o colaborador/competência informados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as provisões de férias de um colaborador em uma competência, resolvendo internamente todos os período(s) aquisitivo(s) em aberto. Um colaborador pode ter mais de um período aquisitivo aberto ao mesmo tempo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: competence description: Competência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – vacationProvisions properties: vacationProvisions: type: array items: type: object allOf: – #/definitions/vacationProvisionDTO minimum: 1 description: Provisões de férias do colaborador na competência, uma entrada por período aquisitivo/alocação, ordenadas pela data de início do período aquisitivo (crescente). Lista vazia quando não existe provisão para o colaborador/competência informados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getVacationProvisionExecutiveDashboard: post: description: Retorna os indicadores (KPIs) e a série histórica do dashboard executivo da provisão de férias, agregados por empresa/filial/centro de custo na competência informada. Competência/mês sem provisão retorna KPIs e ponto da série zerados, não vazios. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – competence properties: company: type: string maxLength: 36 description: Empresa companyBranch: type: string maxLength: 36 description: Filial. Quando informada, restringe os KPIs e a série histórica à filial; quando omitida, consolida todas as filiais da empresa. costCenter: type: string maxLength: 36 description: Centro de custo. Quando informado, restringe os KPIs e a série histórica ao centro de custo; quando omitido, consolida todos os centros de custo do escopo. Filtro independente de companyBranch — Centro de Custo vincula-se à Empresa, não à Filial; os dois campos podem ser combinados livremente, sem hierarquia entre eles. competence: type: string format: date description: Competência de referência dos KPIs (mês/ano) comparisonMonths: type: integer format: int64 description: Quantidade de meses cobertos pela série histórica dos gráficos, contados retroativamente a partir da competência de referência (inclusive). Não afeta os KPIs, que são sempre da competência informada. Default 12, máximo 12. responses: 200: description: Ok schema: type: object required: – kpis – historySeries properties: kpis: type: object allOf: – #/definitions/vacationProvisionDashboardKpiDTO description: Indicadores consolidados (Saldo Total, Provisão Mês, Ajustes, Pagamentos) da competência informada historySeries: type: array items: type: object allOf: – #/definitions/vacationProvisionDashboardHistoryItemDTO minimum: 1 description: Série histórica de saldo/provisão por competência, no intervalo coberto por comparisonMonths 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os indicadores (KPIs) e a série histórica do dashboard executivo da provisão de férias, agregados por empresa/filial/centro de custo na competência informada. Competência/mês sem provisão retorna KPIs e ponto da série zerados, não vazios. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Empresa in: query required: true type: string maxLength: 36 – name: companyBranch description: Filial. Quando informada, restringe os KPIs e a série histórica à filial; quando omitida, consolida todas as filiais da empresa. in: query type: string maxLength: 36 – name: costCenter description: Centro de custo. Quando informado, restringe os KPIs e a série histórica ao centro de custo; quando omitido, consolida todos os centros de custo do escopo. Filtro independente de companyBranch — Centro de Custo vincula-se à Empresa, não à Filial; os dois campos podem ser combinados livremente, sem hierarquia entre eles. in: query type: string maxLength: 36 – name: competence description: Competência de referência dos KPIs (mês/ano) in: query required: true type: string format: date – name: comparisonMonths description: Quantidade de meses cobertos pela série histórica dos gráficos, contados retroativamente a partir da competência de referência (inclusive). Não afeta os KPIs, que são sempre da competência informada. Default 12, máximo 12. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – kpis – historySeries properties: kpis: type: object allOf: – #/definitions/vacationProvisionDashboardKpiDTO description: Indicadores consolidados (Saldo Total, Provisão Mês, Ajustes, Pagamentos) da competência informada historySeries: type: array items: type: object allOf: – #/definitions/vacationProvisionDashboardHistoryItemDTO minimum: 1 description: Série histórica de saldo/provisão por competência, no intervalo coberto por comparisonMonths 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployeeAcquisitivePeriod: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationSchedule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationPaymentTitle: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationPaymentTitleStatusHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationReceipt: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationReceiptInformation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationReceiptDetail: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportDisregardVacationReceiptDay: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportProperties: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationEmployeeDependentAlimonyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationEmployeeDependentAlimonyPayeeHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationProvision: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationProvisionDetail: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVacationProvisionBasis: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportWiipoVacationExclusionPendency: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportVariableEntryVacation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationship: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportWageTypeTable: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportWageType: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportWageTypePayroll: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSyndicate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiationHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiationHistoryVacation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportDisregardVacationDay: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationshipStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationshipStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationshipPayroll: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportESocialCategory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituationStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituationStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCharacteristics: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportRules: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituationPayroll: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployeeDependent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployeeSnapshot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCompanyIndications: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployeeModule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE044ccu: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportGenerateVacationDataProcessControl: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE030ban: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE030age: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE034tcc: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE600cco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportBankIntegrationAccountConfig: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportBankIntegrationPaymentOrigin: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/saveIndividualVacationSchedule: post: description: Salvar programações de férias individuais tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeAcquisitivePeriodId properties: employeeAcquisitivePeriodId: type: string description: Id do período aquisitivo vacationScheduleDTO: type: array items: type: object allOf: – #/definitions/vacationScheduleDTO description: Programações de férias responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da gravação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteVacationScheduleBatch: post: description: Exclusão de programações de férias – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedule – filter properties: vacationSchedule: type: object allOf: – #/definitions/deleteVacationScheduleBatchDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteVacationReceiptBatch: post: description: Exclusão do recibo de férias – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationReceipt – filter properties: vacationReceipt: type: object allOf: – #/definitions/deleteVacationReceiptBatchDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/saveVacationScheduleBatch: post: description: Geração de programações de férias em lote – Individual ou coletivas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedule – filter properties: vacationSchedule: type: object allOf: – #/definitions/saveVacationScheduleBatchDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/getVacationScheduleEndDate: post: description: Primitiva que retorna os dias a desconsiderar nas programações de férias, verificando os dias a desconsiderar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – vacationSchedules properties: employeeId: type: string maxLength: 36 description: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleValidationDTO minimum: 1 description: responses: 200: description: Ok schema: type: object required: – vacationSchedules properties: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleValidationDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/isValidVacationScheduleConcessionLimit: post: description: Primitiva que valida se a data final das programações de férias é posterior a data final do período aquisitivo seguinte ao atrelado na programação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeAcquisitivePeriodId – employeeId properties: employeeAcquisitivePeriodId: type: string maxLength: 36 description: employeeId: type: string maxLength: 36 description: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleValidationDTO description: responses: 200: description: Ok schema: type: object required: – isValid properties: isValid: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteVacationReceipt: post: description: Exclusão do recibo da programação de férias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedule properties: vacationSchedule: type: string maxLength: 36 description: ID da programação de férias responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/reopenDismissalAcquisitivePeriods: post: description: Reabre os períodos aquisitivos de um colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string maxLength: 36 description: ID do colaborador responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/reopenDismissalAcquisitivePeriodsAfterReintegration: post: description: Reabre os períodos aquisitivos de um colaborador depois da reintegração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – reintegrationDate properties: employeeId: type: string maxLength: 36 description: ID do colaborador reintegrationDate: type: string format: date description: Data da reintegração responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/reopenDismissalAcquisitivePeriodsBatch: post: description: Reabre os períodos aquisitivos quitados por demissão de um lote de colaboradores. Exclusivo para uso interno do sistema. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeIdList properties: employeeIdList: type: array items: type: string minimum: 1 description: Lista de IDs dos colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/getEmployeeAcquisitivePeriods: post: description: Retorna os períodos aquisitivos do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Identificador único do colaborador order: type: string allOf: – #/definitions/orderType description: Ordenação responses: 200: description: Ok schema: type: object required: – employeeAcquisitivePeriodData properties: employeeAcquisitivePeriodData: type: array items: type: object allOf: – #/definitions/employeeAcquisitivePeriodData minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeAcquisitivePeriodWithoutGap: post: description: Valida e exclui os períodos aquisitivos sem intervalos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – employeeAcquisitivePeriodIdList properties: employeeId: type: string description: Identificador único do colaborador employeeAcquisitivePeriodIdList: type: array items: type: string minimum: 1 description: Identificadores únicos do período aquisitivo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio de férias. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee – companyTransferDate properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino employeeDependentData: type: array items: type: object allOf: – #/definitions/employeeDependentCompanyTransferData description: Dados dos dependentes do colaborador transferido companyTransferDate: type: string format: date description: Data da transferência de empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeCompanyTransfer: post: description: Desfaz o processo da transferência de empresa de um colaborador no domínio de férias. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/undoSoftExclude: post: description: Desfaz a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/closeDismissalAcquisitivePeriodsInBatch: post: description: Atualiza os períodos aquisitivos dos colaboradores para quitado por demissão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeIds properties: employeeIds: type: array items: type: string minimum: 1 description: IDs do colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/integrateBankPayments: post: description: Integração dos títulos de pagamento de férias com o ERP Banking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titles properties: titles: type: array items: type: object allOf: – #/definitions/integrateBankPaymentItemDTO minimum: 1 description: Títulos de pagamento selecionados para integração responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateVacationScheduleStatusToSentWiipo: post: description: Atualiza o status das programações de férias para Enviado Wiipo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationScheduleIds properties: vacationScheduleIds: type: array items: type: string minimum: 1 description: IDs das programações de férias a serem atualizadas. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployeeAcquisitivePeriod: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationSchedule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationPaymentTitle: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationPaymentTitleStatusHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationReceipt: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationReceiptInformation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationReceiptDetail: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importDisregardVacationReceiptDay: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importProperties: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationEmployeeDependentAlimonyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationEmployeeDependentAlimonyPayeeHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationProvision: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationProvisionDetail: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVacationProvisionBasis: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importWiipoVacationExclusionPendency: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importVariableEntryVacation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationship: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importWageTypeTable: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importWageType: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importWageTypePayroll: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSyndicate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiationHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiationHistoryVacation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importDisregardVacationDay: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationshipStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationshipStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationshipPayroll: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importESocialCategory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituationStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituationStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCharacteristics: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importRules: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituationPayroll: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployeeDependent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployeeSnapshot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCompanyIndications: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployeeModule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE044ccu: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importGenerateVacationDataProcessControl: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE030ban: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE030age: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE034tcc: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE600cco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importBankIntegrationAccountConfig: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importBankIntegrationPaymentOrigin: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/signals/deleteVacationScheduleBatchItem: post: description: Exclusão de programações de férias – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/deleteVacationScheduleBatchDTO description: itens: type: array items: type: string minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deleteVacationReceiptBatchItem: post: description: Exclusão de recibos de férias – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/deleteVacationReceiptBatchDTO description: itens: type: array items: type: object allOf: – #/definitions/vacationReceiptBatchItem minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/cancelBatchProcess: post: description: Realiza as ações necessárias ao cancelar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/finishBatchProcess: post: description: Realiza as ações necessárias ao finalizar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/saveVacationScheduleBatchItem: post: description: Geração de programações de férias em lote – Individual ou coletivas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/saveVacationScheduleBatchDTO description: itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/integrateBankPaymentsBatchItem: post: description: Integração dos títulos de pagamento de férias com o ERP Banking – lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/integrateBankPaymentsBatchDTO description: Seleção de títulos do processo itens: type: array items: type: object allOf: – #/definitions/integrateBankPaymentItemDTO minimum: 1 description: Títulos de pagamento do lote batchId: type: string description: Identificador do lote summaryId: type: string description: Identificador do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/vacationReceiptSave: post: description: Salva as informações do recibo de férias. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/createFutureEmployeeAcquisitivePeriod: post: description: Cria os novos períodos aquisitivos para os colaboradores se necessário tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/vacationSaveRollback: post: description: Desfaz o salvamento das informações de férias do colaborador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/vacationProvisionSave: post: description: Grava a provisão de férias calculada, lendo o lote do cache (Redis). Primitiva de uso interno (trusted). tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. competence: type: string format: date description: Competência da provisão (mês/ano de referência) batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/closeDismissalAcquisitivePeriods: post: description: Atualiza a situação dos períodos aquisitivos que estão abertos do colaborador para quitado por rescisão tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/wiipoLoadExclusionPendencies: post: description: Processa as pendências de exclusão de recibos de férias para integração com a Wiipo tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – wiipoBackendUrl – wiipoApiKey – blobServiceSecret properties: processId: type: string description: Identificador do processo wiipoBackendUrl: type: string maxLength: 1000 description: URL base do backend da Wiipo wiipoApiKey: type: string maxLength: 100 description: Chave de API da Wiipo blobServiceSecret: type: string maxLength: 100 description: Secret das áreas dos arquivos de integração reprocess: type: boolean description: Indica reprocessamento manual de pendências com falha default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/saveVacationData: post: description: Grava as bases e valores calculados para os recibos de férias importados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote competence: type: string format: date description: Competência employees: type: array items: type: string description: Colaboradores excludedEmployees: type: array items: type: string description: Colaboradores excluídos do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/vacationReceiptExclusionFinished: post: description: Notifica que a exclusão dos recibos de férias finalizou para determinado lote. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/vacationReceiptSaved: post: description: Notifica que a gravação dos recibos de férias foi concluída. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. batchDescription: type: string description: Descrição calculationType: type: string description: Tipo de cálculo hasError: type: boolean description: Indica se hourve erro na gravação dos recibos de férias default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/dismissalAcquisitivePeriodsClosed: post: description: Notifica que a atualização dos períodos aquisitivos quitados por rescisão foi concluída. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/vacationCalculationDeleted: post: description: Sinaliza a finalização da exclusão do cálculo de férias individuais ou coletivas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – employeeVacations properties: employeeVacations: type: array items: type: object allOf: – #/definitions/employeeVacationDeletionData minimum: 1 description: Dados das férias excluídas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/generateVacationCalculationDataFinished: post: description: Sinaliza que o processo de geração de dados de cálculo de férias foi concluído x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeAcquisitivePeriodEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeAcquisitivePeriodEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationScheduleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationScheduleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationPaymentTitleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationPaymentTitleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationPaymentTitleStatusHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationPaymentTitleStatusHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationReceiptEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationReceiptEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationReceiptInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationReceiptInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationReceiptDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationReceiptDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importDisregardVacationReceiptDayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportDisregardVacationReceiptDayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importPropertiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportPropertiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationEmployeeDependentAlimonyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationEmployeeDependentAlimonyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationEmployeeDependentAlimonyPayeeHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationEmployeeDependentAlimonyPayeeHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationProvisionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationProvisionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationProvisionDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationProvisionDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVacationProvisionBasisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVacationProvisionBasisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importWiipoVacationExclusionPendencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportWiipoVacationExclusionPendencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importVariableEntryVacationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportVariableEntryVacationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importWageTypeTableEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportWageTypeTableEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importWageTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportWageTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importWageTypePayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportWageTypePayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSyndicateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSyndicateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationHistoryVacationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationHistoryVacationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importDisregardVacationDayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportDisregardVacationDayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipPayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipPayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importESocialCategoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportESocialCategoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCharacteristicsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCharacteristicsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importRulesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportRulesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationPayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationPayrollEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeDependentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeDependentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeSnapshotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeSnapshotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCompanyIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCompanyIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE044ccuEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE044ccuEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importGenerateVacationDataProcessControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportGenerateVacationDataProcessControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE030banEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE030banEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE030ageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE030ageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE034tccEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE034tccEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE600ccoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE600ccoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importBankIntegrationAccountConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportBankIntegrationAccountConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importBankIntegrationPaymentOriginEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportBankIntegrationPaymentOriginEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/entities/employeeAcquisitivePeriod: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeAcquisitivePeriod responses: 200: description: The created resource schema: #/definitions/employeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeAcquisitivePeriod responses: 200: description: The created resource schema: #/definitions/employeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeAcquisitivePeriod/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeAcquisitivePeriod responses: 200: description: Ok schema: #/definitions/editEmployeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeAcquisitivePeriod responses: 200: description: Ok schema: #/definitions/employeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeAcquisitivePeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeAcquisitivePeriod/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeAcquisitivePeriod responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationSchedule: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationSchedule responses: 200: description: The created resource schema: #/definitions/vacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationSchedule responses: 200: description: The created resource schema: #/definitions/vacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationSchedule/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editVacationSchedule responses: 200: description: Ok schema: #/definitions/editVacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationSchedule responses: 200: description: Ok schema: #/definitions/vacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationSchedule/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationSchedule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationPaymentTitle: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationPaymentTitle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationReceipt: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationReceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationReceiptInformation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationReceiptInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationReceiptDetail: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationReceiptDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/disregardVacationReceiptDay: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/disregardVacationReceiptDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationEmployeeDependentAlimonyHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationEmployeeDependentAlimonyHistory responses: 200: description: The created resource schema: #/definitions/vacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationEmployeeDependentAlimonyHistory responses: 200: description: The created resource schema: #/definitions/vacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationEmployeeDependentAlimonyHistory/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editVacationEmployeeDependentAlimonyHistory responses: 200: description: Ok schema: #/definitions/editVacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationEmployeeDependentAlimonyHistory responses: 200: description: Ok schema: #/definitions/vacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationEmployeeDependentAlimonyHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationEmployeeDependentAlimonyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationProvision: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationProvision 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationProvisionDetail: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationProvisionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/vacationProvisionBasis: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vacationProvisionBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntryVacation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/variableEntryVacation responses: 200: description: The created resource schema: #/definitions/variableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/variableEntryVacation responses: 200: description: The created resource schema: #/definitions/variableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/variableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntryVacation/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editVariableEntryVacation responses: 200: description: Ok schema: #/definitions/editVariableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/variableEntryVacation responses: 200: description: Ok schema: #/definitions/variableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/variableEntryVacation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntryVacation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variableEntryVacation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/generateVacationDataProcessControl: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/generateVacationDataProcessControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim situationPeriodType: type: string enum: – OPEN – PAID_NORMALLY – PAID_TERMINATION – PAID_ABSENCES – PAID_LEAVE_ONE_HUNDRED_AND_EIGHTY_DAYS – PAID_LICENCE_PAID_THIRTY_DAYS – PAID_COLLECTIVE_LESS_THAN_ONE_YEAR_STARTING_NEW_PERIOD – PAID_TRANSFER – GENERATED_BY_ADJUSTMENT – PAID_LACK_OF_ENJOYMENT – PAID_TOTAL_LOSS_PERIOD description: Situação do período: * `OPEN` – Aberto * `PAID_NORMALLY` – Quitado normal * `PAID_TERMINATION` – Quitado por rescisão * `PAID_ABSENCES` – Quitado por faltas * `PAID_LEAVE_ONE_HUNDRED_AND_EIGHTY_DAYS` – Quitado por afastamento de mais de cento e oitenta dias * `PAID_LICENCE_PAID_THIRTY_DAYS` – Quitado por licença remunerada de mais de trinta dias * `PAID_COLLECTIVE_LESS_THAN_ONE_YEAR_STARTING_NEW_PERIOD` – Quitado por férias coletivas, menos de um ano, iniciando novo período * `PAID_TRANSFER` – Quitado por transferência * `GENERATED_BY_ADJUSTMENT` – Gerado por ajuste * `PAID_LACK_OF_ENJOYMENT` – Quitado por falta de gozo * `PAID_TOTAL_LOSS_PERIOD` – Quitado por perda total do período statusType: type: string enum: – PROGRAMMED – CALCULATED – SENT_WIIPO description: Status: * `PROGRAMMED` – Programada * `CALCULATED` – Calculada * `SENT_WIIPO` – Enviado Wiipo vacationType: type: string enum: – INDIVIDUAL – COLLECTIVE description: Tipo de férias: * `INDIVIDUAL` – Individual * `COLLECTIVE` – Coletiva collectiveExclusionVacationType: type: string enum: – INDIVIDUAL – COLLECTIVE – BOTH description: Tipo de férias – Exclusão coletiva: * `INDIVIDUAL` – Individual * `COLLECTIVE` – Coletiva * `BOTH` – Ambos identificationType: type: string enum: – SALARY_PROCEEDS_OR_ALLOWANCE – DEDUCTION – INFORMATIVE – DEDUCTIVE_INFORMATIVE description: Tipo Evento: * `SALARY_PROCEEDS_OR_ALLOWANCE` – Vencimento, provento ou pensão devida * `DEDUCTION` – Desconto * `INFORMATIVE` – Informativa * `DEDUCTIVE_INFORMATIVE` – Informativa dedutora calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL – THIRD_PARTY_PAYMENT – VACATION_PROVISION – THIRTEENTH_PROVISION description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `INDIVIDUAL_VACATION` – Férias individuais * `COLLECTIVE_VACATION` – Férias coletivas * `DISMISSAL` – Rescisão individual * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio * `THIRD_PARTY_PAYMENT` – Cálculo de RPA * `VACATION_PROVISION` – Provisão de férias * `THIRTEENTH_PROVISION` – Provisão de décimo terceiro processStatusType: type: string enum: – PENDING – PROCESSING – DONE – ERROR description: Tipo de status do processo: * `PENDING` – Pendente * `PROCESSING` – Processando * `DONE` – Concluído * `ERROR` – Com erro hiredInCurrentYearType: type: string enum: – CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN – OPEN_NEW_ACQUISITIVE_PERIOD description: Admitidos no ano: * `CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN` – Período aquisitivo permanece aberto. Apenas fecha o período aquisitivo se os dias de direito forem totalmente consumidos. * `OPEN_NEW_ACQUISITIVE_PERIOD` – Abre novo período aquisitivo. orderType: type: string enum: – ASC – DESC description: Sentidos de ordenação: * `ASC` – Crescente * `DESC` – Decrescente vacationReceiptDetailOrderType: type: string enum: – WAGE_TYPE_CODE – REFERENCE – VALUE description: Enumeração dos campos ordenáveis do recibo de férias: * `WAGE_TYPE_CODE` – Código do evento * `REFERENCE` – Refência * `VALUE` – Valor activityNatureType: type: string enum: – V01 – V02 description: Tipo da Natureza da Atividade: * `V01` – Trabalhador Urbano * `V02` – Trabalhador Rural welfarePolicyType: type: string enum: – V1 – V3 description: Tipo de regime previdenciário do colaborador: * `V1` – Regime Geral de Previdência Social – RGPS * `V3` – Regime de Previdência Social no exterior contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro situationType: type: string enum: – WORKING – VACATION – ILLNESSAID – LABORACCIDENT – MILITARYSERVICE – MATERNITYLEAVE – CITIZENCOMPANYMATERNITY – INSSMATERNITYLEAVE – LEAVEWITHOUTCOMPENSATION – PAIDLEAVE – PATERNITYLEAVE – CITIZENCOMPANYPATERNITY – COLLECTIVEVACATION – MEDICALLEAVE – MEDICALLEAVEWITHOUTINSS – ABSENCES – OVERTIME – TIMEEVALUATIONSITUATION – PRECAUTIONREADINESS – TRADEUNIONMANDATE – WORKACCIDENTLEAVE – WORKACCIDENTLEAVEWITHOUTINSS – RETIREMENTDUETODISABILITY – PROFESSIONALQUALIFICATION – PRIORNOTICEHOURSWORKED – OTHERS – REINSTATEMENT – CONTRACTSUSPENDEDINDIRECTRESCISSION – CONTRACTSUSPENDEDMISCONDUCTINQUIRY – MATERNITYLEAVENONCRIMINALABORTION – MATERNITYLEAVEANTICIPATIONEXTENSION – MATERNITYLEAVE60DAYSLEI15156 proportionType: type: string enum: – NOT_PROPORTIONALIZE – PROPORTIONALIZE_VALUE_ONLY – PROPORTIONALIZE_VALUE_REFERENCE description: Tipo de proporção do evento de férias: * `NOT_PROPORTIONALIZE` – Não proporcionalizar * `PROPORTIONALIZE_VALUE_ONLY` – Proporcionalizar apenas valor * `PROPORTIONALIZE_VALUE_REFERENCE` – Proporcionalizar valor e referência characteristicType: type: string enum: – NORMAL_DAYTIME_HOURS – DSR_DAYTIME_HOURS – OVERTIME_DAYTIME – DSR_OVERTIME – IRRF – FGTS – INSS – FAMILY_SALARY – ADDITIONAL_NIGHT – NORMAL_NIGHT_HOURS – DSR_NIGHT_HOURS – DAYTIME_MEDICAL_LEAVE – NIGHTTIME_MEDICAL_LEAVE – DAYTIME_WORK_ACCIDENT_LEAVE – NIGHTTIME_WORK_ACCIDENT_LEAVE – DAYTIME_ABSENCE – DAYTIME_LOST_DSR – NIGHTTIME_ABSENCE – NIGHTTIME_LOST_DSR – DAYTIME_MATERNITY_LEAVE – NIGHTTIME_MATERNITY_LEAVE – DAYTIME_ILLNESS_AID – NIGHTTIME_ILLNESS_AID – DAYTIME_LABOR_ACCIDENT – NIGHTTIME_LABOR_ACCIDENT – DAYTIME_MILITARY_SERVICE – NIGHTTIME_MILITARY_SERVICE – DAYTIME_PAID_LEAVE – NIGHTTIME_PAID_LEAVE – DAYTIME_LEAVE_WITHOUT_COMPENSATION – NIGHTTIME_LEAVE_WITHOUT_COMPENSATION – DAYTIME_PATERNITY_LEAVE – NIGHTTIME_PATERNITY_LEAVE – DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – DAYTIME_CITIZEN_COMPANY_MATERNITY – NIGHTTIME_CITIZEN_COMPANY_MATERNITY – DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS – NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS – DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – DAYTIME_INSS_MATERNITY_LEAVE – NIGHTTIME_INSS_MATERNITY_LEAVE – HAZARD – ADDITIONAL_HOURS_ENTRY – OVERTIME_NIGHTTIME – INSALUBRITY – ALLOWANCE – TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION – TRANSPORTATION_VOUCHER – MEDICAL_EXPENSES – TIPS – PREMIUMS – DAY_CARE_REIMBURSEMENT – NANNY_REIMBURSEMENT – TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION – OTHER_PROCEEDS – OTHER_DEDUCTIONS – TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT – EXCEEDING_FOOD_VOUCHER_MEAL_TICKET – PRECAUTION_HOURS – CORPORATE_OFFICER_WAGE – JUDICIAL_ALIMONY_MONTH – COMMISSIONS – DSR_COMMISSIONS – COMPLEMENT_SALARY – DAYTIME_OVERTIME_COMMISSION – NIGHTTIME_OVERTIME_COMMISSION – MONTH_OVERFLOW – PREVIOUS_MONTH_OVERFLOW – MONTH_REFUND – PREVIOUS_MONTH_REFUND – SYNDICATE_CONTRIBUTIONS – DAYTIME_RETIREMENT_DUE_TO_DISABILITY – NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY – DAYTIME_OTHERS – NIGHTTIME_OTHERS – ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ADVANCE_THIRTEENTH_SALARY – JUDICIAL_ALIMONY_THIRTEENTH_SALARY – ALIMONY_ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY – THIRTEENTH_SALARY – MATERNITY_THIRTEENTH_SALARY – MATERNITY_INSS_THIRTEENTH_SALARY – BASE_WORK_ACCIDENT_THIRTEENTH_SALARY – BASE_MILITARY_SERVICE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY – ADDITIONAL_ADVANCE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY – ADDITIONAL_THIRTEENTH_SALARY – FGTS_THIRTEENTH_SALARY – COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_MATERNITY_THIRTEENTH_SALARY – RETURN_MATERNITY_INSS_THIRTEENTH_SALARY – RETURN_INSS_THIRTEENTH_SALARY – IRRF_ADVANCE_SALARY – SALARY_ADVANCE_DISCOUNT – INSS_THIRTEENTH_SALARY – IRRF_THIRTEENTH_SALARY – DAYTIME_VACATION_HOURS – NIGHTTIME_VACATION_HOURS – THIRD_OF_VACATION – THIRD_OF_VACATION_PREMIUM – DOUBLE_VACATION_FINE – DOUBLE_VACATION_PREMIUM_FINE – VACATION_PREMIUM – INSS_VACATION_PAY – JUDICIAL_ALIMONY_VACATION – IRRF_VACATION_PAY – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_VARIABLE_VALUES_VACATION – AVERAGE_VARIABLE_VALUES_PREMIUM – AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_COMPENSATED – AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_NOT_FULLFILLED – AVERAGE_VARIABLE_VALUES_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_VARIABLE_VALUES_VACATION_COMPENSATED_DISMISSAL – AVERAGE_VARIABLE_VALUES_MATERNITY_LEAVE – AVERAGE_VARIABLE_VALUES_INSS_MATERNITY_LEAVE – AVERAGE_VARIABLE_VALUES_CITIZEN_MATERNITY – AVERAGE_OVERTIME_VACATION – AVERAGE_OVERTIME_PREMIUM – AVERAGE_OVERTIME_VACATION_COMPENSATED_DISMISSAL – AVERAGE_OVERTIME_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_COMPENSATED – AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_NOT_FULLFILLED – AVERAGE_OVERTIME_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – AVERAGE_OVERTIME_STABILITY_DISMISSAL – AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_OVERTIME_THIRTEENTH_SALARY_PROPORTIONAL – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_PROPORTIONAL – AVERAGE_VARIABLE_VALUES_STABILITY_DISMISSAL – ADDITIONAL_MATERNITY_SALARY – ADDITIONAL_INSS_MATERNITY_SALARY – ADDITIONAL_THIRTEENTH_SALARY_PROPORTIONAL – ADDITIONAL_PREMIUM – ADDITIONAL_CITIZEN_MATERNITY – ADDITIONAL_PRIOR_NOTICE_COMPENSATED – ADDITIONAL_PRIOR_NOTICE_NOT_FULLFILLED – ADDITIONAL_VACATION_COMPENSATED_DISMISSAL – ADDITIONAL_THIRTEENTH_SALARY_COMPENSATED – ADDITIONAL_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – ADDITIONAL_STABILITY_DISMISSAL – ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – VACATION_PREMIUM_DIFFERENCE – VACATION_DIFFERENCE – VACATION_ADVANCE_DISCOUNT – NEGATIVE_VACATION_DIFFERENCE – NEGATIVE_VACATION_PREMIUM_DIFFERENCE – JUDICIAL_ALIMONY_VACATION_DIFFERENCE – IRRF_VACATION_DIFFERENCE – IRRF_VACATION_DISCOUNT_MONTH_PROPORTIONAL – INSS_VACATION_DIFFERENCE – INSS_VACATION_RETURN – AVERAGE_OVERTIME_MATERNITY_LEAVE – AVERAGE_OVERTIME_INSS_MATERNITY_LEAVE – AVERAGE_OVERTIME_CITIZEN_COMPANY_MATERNITY – PRIOR_NOTICE_COMPENSATED – PRIOR_NOTICE_NOT_FULLFILLED – THIRTEENTH_SALARY_PROPORTIONAL – MATERNITY_THIRTEENTH_SALARY_PROPORTIONAL – THIRTEENTH_SALARY_COMPENSATED – FGTS_DISMISSAL_THIRTEENTH_SALARY_DEPOSITED – FGTS_DISMISSAL_DEPOSITED – VACATION_OVERDUE_DISMISSAL – THIRD_OF_VACATION_OVERDUE_DISMISSAL – DOUBLE_VACATION_OVERDUE_DISMISSAL – VACATION_PROPORTIONAL_DISMISSAL – VACATION_COMPENSATED_DISMISSAL – DISMISSAL_STABILITY – ADDITIONAL_NIGHT_VACATION – AVERAGE_INSALUBRITY_VACATION – AVERAGE_HAZARD_VACATION – COMPENSATED_PREVIOUS_MONTH_BASE_DATE – THIRD_OF_VACATION_COMPENSATED_DISMISSAL – DOUBLE_VACATION_COMPENSATED_DISMISSAL – COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_EMPLOYEE – COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_EMPLOYEE – THIRD_OF_VACATION_PROPORTIONAL_DISMISSAL – AVERAGE_OVERTIME_VACATION_PROPORTIONAL_DISMISSAL – AVERAGE_VARIABLE_VALUES_VACATION_PROPORTIONAL_DISMISSAL – ADDITIONAL_VACATION_PROPORTIONAL_DISMISSAL – ADDITIONAL_VACATION_OVERDUE_DISMISSAL – DAYTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS – NIGHTTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS – PROFESSIONAL_QUALIFICATION_FINE – BALANCE_OF_SALARY – DSR_BALANCE_OF_SALARY – DAYTIME_PRIOR_NOTICE_HOURS_WORKED – NIGHTTIME_PRIOR_NOTICE_HOURS_WORKED – DAYTIME_JUSTIFIED_HOURS – NIGHTTIME_JUSTIFIED_HOURS – BIRTH_AID – CASH_SHORTAGE_ADDITIONAL – DEDUCTION_ADVANCE_THIRTEENTH_SALARY_DISMISSAL_WITHOUT_THIRTEENTH_SALARY – ABSENCES_AS_DEDUCTION – FGTS_THIRTEENTH_SALARY_PROPORTIONAL_MILITARY_SERVICE – FGTS_THIRTEENTH_SALARY_PROPORTIONAL_WORK_ACCIDENT – FGTS_THIRTEENTH_SALARY_PAID_MONTH – FGTS_COMPENSATED – FGTS_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_OVERTIME_VACATION_OVERDUE_DISMISSAL – AVERAGE_VARIABLE_VALUES_VACATION_OVERDUE_DISMISSAL – FGTS_DISMISSAL_FINE – DISMISSAL_NET – THIRD_OF_NEGATIVE_VACATION_DIFFERENCE – THIRD_OF_NEGATIVE_VACATION_PREMIUM_DIFFERENCE – THIRD_OF_VACATION_DIFFERENCE – THIRD_OF_VACATION_PREMIUM_DIFFERENCE – FINE_FOR_LATE_PAYMENT_TERMINATION – COMPENSATION_AS_DISMISSAL_INCENTIVE – DAYTIME_VACATION_HOURS_PAYROLL – NIGHTTIME_VACATION_HOURS_PAYROLL – AVERAGE_OVERTIME_VACATION_PAYROLL – AVERAGE_VARIABLE_VALUES_VACATION_PAYROLL – ADDITIONAL_NIGHT_VACATION_PAYROLL – AVERAGE_INSALUBRITY_VACATION_PAYROLL – AVERAGE_HAZARD_VACATION_PAYROLL – THIRD_OF_VACATION_PAYROLL – DOUBLE_VACATION_FINE_PAYROLL – VACATION_PREMIUM_PAYROLL – AVERAGE_OVERTIME_PREMIUM_PAYROLL – AVERAGE_VARIABLE_VALUES_PREMIUM_PAYROLL – ADDITIONAL_PREMIUM_PAYROLL – THIRD_OF_VACATION_PREMIUM_PAYROLL – DOUBLE_VACATION_PREMIUM_FINE_PAYROLL – INSS_VACATION_PAY_PAYROLL – JUDICIAL_ALIMONY_VACATION_PAYROLL – INSS_REFUND – JUDICIAL_ALIMONY_CALCULATION_RRA – JUDICIAL_ALIMONY_CALCULATION_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – IRRF_CALCULATION_RRA – INSS_DEDUCTION_RRA – INSS_VACATION_CALCULATION_RRA – INSS_THIRTEENTH_SALARY_CALCULATION_RRA – INSS_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – INSS_THIRTEENTH_SALARY_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – PIS_VALUE_THIRTEENTH_SALARY_MONTHLY_PAYROLL – PIS_MONTHLY_PAYROLL_VALUE – PIS_DISMISSAL_VALUE – INSALUBRITY_PREGNANT_EMPLOYEE_HEALTHY_ENVIRONMENT – PREVIOUS_DISMISSAL_OVERFLOW – INSS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – INSS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – FGTS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – FGTS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – THIRD_PARTY_INCOME – THIRD_PARTY_DEDUCTIONS – THIRD_PARTY_INSS – THIRD_PARTY_IRRF – THIRD_PARTY_SEST – THIRD_PARTY_SENAT – THIRD_PARTY_ISS – THIRD_PARTY_JUDICIAL_ALIMONY – HEALTH_PLAN_HOLDER_COMPANY_MONTHLY_FEE – HEALTH_PLAN_HOLDER_EMPLOYEE_MONTHLY_FEE – HEALTH_PLAN_DEPENDENT_COMPANY_MONTHLY_FEE – HEALTH_PLAN_DEPENDENT_EMPLOYEE_MONTHLY_FEE – HEALTH_PLAN_COPAYMENT_DEDUCTION – WORKER_CREDIT_LOAN – WORKER_CREDIT_LOAN_DIFFERENCE – WORKER_CREDIT_PROVISION_SALARY_ADVANCE – WORKER_CREDIT_PROVISION_VACATION – WORKER_CREDIT_PROVISION_VACATION_PAYROLL – COMPLEMENTARY_PENSION – COMPLEMENTARY_PENSION_VACATION – COMPLEMENTARY_PENSION_THIRTEENTH_SALARY – WORKER_CREDIT_LOAN_DISMISSAL description: Característica: * `NORMAL_DAYTIME_HOURS` – Horas Normais Diurnas * `DSR_DAYTIME_HOURS` – Horas DSR Diurnas * `OVERTIME_DAYTIME` – Horas Extras Diurnas * `DSR_OVERTIME` – DSR Horas Extras * `IRRF` – IRRF * `FGTS` – FGTS * `INSS` – INSS * `FAMILY_SALARY` – Salário família * `ADDITIONAL_NIGHT` – Adicional Noturno * `NORMAL_NIGHT_HOURS` – Horas Normais Noturnas * `DSR_NIGHT_HOURS` – Horas Repouso Remunerado Noturnas * `DAYTIME_MEDICAL_LEAVE` – Licença auxílio doença diurna * `NIGHTTIME_MEDICAL_LEAVE` – Licença auxílio doença noturna * `DAYTIME_WORK_ACCIDENT_LEAVE` – Licença acidente de trabalho diurna * `NIGHTTIME_WORK_ACCIDENT_LEAVE` – Licença acidente de trabalho noturna * `DAYTIME_ABSENCE` – Horas faltas diurnas * `DAYTIME_LOST_DSR` – Horas faltas repouso remunerado diurnas * `NIGHTTIME_ABSENCE` – Horas faltas noturnas * `NIGHTTIME_LOST_DSR` – Horas faltas repouso remunerado noturnas * `DAYTIME_MATERNITY_LEAVE` – Horas licença maternidade diurnas * `NIGHTTIME_MATERNITY_LEAVE` – Horas licença maternidade noturnas * `DAYTIME_ILLNESS_AID` – Horas auxílio doença diurnas * `NIGHTTIME_ILLNESS_AID` – Horas auxílio doença noturnas * `DAYTIME_LABOR_ACCIDENT` – Horas acidente de trabalho diurnas * `NIGHTTIME_LABOR_ACCIDENT` – Horas acidente de trabalho noturnas * `DAYTIME_MILITARY_SERVICE` – Horas serviço militar diurnas * `NIGHTTIME_MILITARY_SERVICE` – Horas serviço militar noturnas * `DAYTIME_PAID_LEAVE` – Horas licença com remuneração diurnas * `NIGHTTIME_PAID_LEAVE` – Horas licença com remuneração noturnas * `DAYTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração diurnas * `NIGHTTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração noturnas * `DAYTIME_PATERNITY_LEAVE` – Horas licença paternidade diurnas * `NIGHTTIME_PATERNITY_LEAVE` – Horas licença paternidade noturnas * `DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã diurna * `NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã noturna * `DAYTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã diurna * `NIGHTTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã noturna * `DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Diurnas * `NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Noturnas * `DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS diurnas * `NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS noturnas * `DAYTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS diurnas * `NIGHTTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS noturnas * `HAZARD` – Periculosidade * `ADDITIONAL_HOURS_ENTRY` – Adicionais lançados em horas * `OVERTIME_NIGHTTIME` – Horas extras noturnas * `INSALUBRITY` – Insalubridade * `ALLOWANCE` – Ajuda de custo * `TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem até 50% remuneração * `TRANSPORTATION_VOUCHER` – Vale transporte * `MEDICAL_EXPENSES` – Despesas médicas * `TIPS` – Gorjetas * `PREMIUMS` – Prêmios * `DAY_CARE_REIMBURSEMENT` – Reembolso creche * `NANNY_REIMBURSEMENT` – Reembolso babá * `TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem acima 50% remuneração * `OTHER_PROCEEDS` – Proventos diversos * `OTHER_DEDUCTIONS` – Descontos diversos * `TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT` – Reembolso vale alimentação/transporte * `EXCEEDING_FOOD_VOUCHER_MEAL_TICKET` – Vale alimentação/refeição excedente * `PRECAUTION_HOURS` – Horas de sobreaviso * `CORPORATE_OFFICER_WAGE` – Pró-labore * `JUDICIAL_ALIMONY_MONTH` – Pensão judicial mensal * `COMMISSIONS` – Comissões * `DSR_COMMISSIONS` – Repouso sobre comissões * `COMPLEMENT_SALARY` – Complemento Salarial * `DAYTIME_OVERTIME_COMMISSION` – Hora extra comissão diurna * `NIGHTTIME_OVERTIME_COMMISSION` – Hora extra comissão noturna * `MONTH_OVERFLOW` – Estouro do mês * `PREVIOUS_MONTH_OVERFLOW` – Estouro do mês anterior * `MONTH_REFUND` – Troco do mês * `PREVIOUS_MONTH_REFUND` – Troco do mês anterior * `SYNDICATE_CONTRIBUTIONS` – Contribuições do sindicato * `DAYTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas diurnas – Aposentadoria por invalidez * `NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas noturnas – Aposentadoria por invalidez * `DAYTIME_OTHERS` – Outras Horas Diurnas * `NIGHTTIME_OTHERS` – Outras Horas Noturnas * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `DISCOUNT_ADVANCE_THIRTEENTH_SALARY` – Desconto adiantamento 13º salário * `JUDICIAL_ALIMONY_THIRTEENTH_SALARY` – Pensão judicial sobre 13º salário * `ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Pensão judicial sobre adiantamento do 13º salário * `DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Desconto de pensão judicial no adiantamento do 13º salário * `THIRTEENTH_SALARY` – 13º salário integral * `MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade * `MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS * `BASE_WORK_ACCIDENT_THIRTEENTH_SALARY` – Base 13º salário acidente de trabalho * `BASE_MILITARY_SERVICE_THIRTEENTH_SALARY` – Base 13º salário serviço militar * `AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY` – Média de horas extras adiantamento 13° salário * `AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY` – Média de valores variáveis adiantamento 13° salário * `ADDITIONAL_ADVANCE_THIRTEENTH_SALARY` – Adicionais de adiantamento 13° salário * `AVERAGE_OVERTIME_THIRTEENTH_SALARY` – Média de horas extras 13° salário integral * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY` – Média de valores variáveis 13° salário Integral * `ADDITIONAL_THIRTEENTH_SALARY` – Adicionais de 13° salário integral * `FGTS_THIRTEENTH_SALARY` – FGTS sobre 13º salário * `COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar * `RETURN_COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar a devolver * `RETURN_MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade a devolver * `RETURN_MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS a devolver * `RETURN_INSS_THIRTEENTH_SALARY` – Devolução INSS 13° salário * `IRRF_ADVANCE_SALARY` – IRRF sobre adiantamento salarial * `SALARY_ADVANCE_DISCOUNT` – Desconto adiantamento salarial * `INSS_THIRTEENTH_SALARY` – INSS sobre 13º salário * `IRRF_THIRTEENTH_SALARY` – IRRF sobre 13º salário * `DAYTIME_VACATION_HOURS` – Horas férias diurnas * `NIGHTTIME_VACATION_HOURS` – Horas férias noturnas * `THIRD_OF_VACATION` – 1/3 sobre férias * `THIRD_OF_VACATION_PREMIUM` – 1/3 sobre abono pecuniário * `DOUBLE_VACATION_FINE` – Multa dobro de férias * `DOUBLE_VACATION_PREMIUM_FINE` – Multa dobro do abono pecuniário * `VACATION_PREMIUM` – Abono pecuniário * `INSS_VACATION_PAY` – INSS sobre recibo de férias * `JUDICIAL_ALIMONY_VACATION` – Pensão judicial sobre férias * `IRRF_VACATION_PAY` – IRRF sobre recibo de férias * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_COMPENSATED` – Média de valores variáveis de 13º salário indenizado * `AVERAGE_VARIABLE_VALUES_VACATION` – Média de valores variáveis de férias * `AVERAGE_VARIABLE_VALUES_PREMIUM` – Média de valores variáveis de abono * `AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_COMPENSATED` – Média de valores variáveis de aviso prévio indenizado * `AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_NOT_FULLFILLED` – Média de valores variáveis de aviso prévio reavido * `AVERAGE_VARIABLE_VALUES_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Média de valores variáveis indenizados no mês anterior da data-base * `AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Média de valores variáveis indenizados no fim do contrato antecipado pela empresa * `AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Média de valores variáveis indenizados no fim do contrato antecipado pelo colaborador * `AVERAGE_VARIABLE_VALUES_VACATION_COMPENSATED_DISMISSAL` – Média de valores variáveis de férias indenizadas na rescisão * `AVERAGE_VARIABLE_VALUES_MATERNITY_LEAVE` – Média de valores variáveis de salário maternidade * `AVERAGE_VARIABLE_VALUES_INSS_MATERNITY_LEAVE` – Média de valores variáveis de salário maternidade INSS * `AVERAGE_VARIABLE_VALUES_CITIZEN_MATERNITY` – Média de valores variáveis de salário maternidade empresa cidadã * `AVERAGE_OVERTIME_VACATION` – Média de horas extras de férias * `AVERAGE_OVERTIME_PREMIUM` – Média de horas extras de abono * `AVERAGE_OVERTIME_VACATION_COMPENSATED_DISMISSAL` – Média de horas extras de férias indenizadas na rescisão * `AVERAGE_OVERTIME_THIRTEENTH_SALARY_COMPENSATED` – Média de horas extras de 13° salário indenizado * `AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_COMPENSATED` – Média de horas extras de aviso prévio indenizado * `AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_NOT_FULLFILLED` – Média de horas extras de aviso prévio reavido * `AVERAGE_OVERTIME_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Média de horas extras indenizadas no mês anterior da data-base * `AVERAGE_OVERTIME_STABILITY_DISMISSAL` – Média de horas extras de estabilidade na rescisão * `AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Média de horas extras indenizadas no fim do contrato antecipado pelo colaborador * `AVERAGE_OVERTIME_THIRTEENTH_SALARY_PROPORTIONAL` – Média de horas extras de 13° salário proporcional * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_PROPORTIONAL` – Média de valores variáveis de 13° salário proporcional * `AVERAGE_VARIABLE_VALUES_STABILITY_DISMISSAL` – Média de valores variáveis de estabilidade na rescisão * `ADDITIONAL_MATERNITY_SALARY` – Adicionais de salário maternidade * `ADDITIONAL_INSS_MATERNITY_SALARY` – Adicionais de salário maternidade INSS * `ADDITIONAL_THIRTEENTH_SALARY_PROPORTIONAL` – Adicionais de 13° salário proporcional * `ADDITIONAL_PREMIUM` – Adicionais de abono * `ADDITIONAL_CITIZEN_MATERNITY` – Adicionais de auxílio maternidade – Empresa cidadã * `ADDITIONAL_PRIOR_NOTICE_COMPENSATED` – Adicionais de aviso prévio indenizado * `ADDITIONAL_PRIOR_NOTICE_NOT_FULLFILLED` – Adicionais de aviso prévio reavido * `ADDITIONAL_VACATION_COMPENSATED_DISMISSAL` – Adicionais de férias indenizadas na rescisão * `ADDITIONAL_THIRTEENTH_SALARY_COMPENSATED` – Adicionais de 13° salário indenizado * `ADDITIONAL_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Adicionais de indenização no mês anterior da data-base * `ADDITIONAL_STABILITY_DISMISSAL` – Adicionais de estabilidade na rescisão * `ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Adicionais de indenização no fim do contrato antecipado pela empresa * `ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Adicionais de indenização no fim do contrato antecipado pelo colaborador * `VACATION_PREMIUM_DIFFERENCE` – Diferença de abono * `VACATION_DIFFERENCE` – Diferença de férias * `VACATION_ADVANCE_DISCOUNT` – Desconto de adiantamento de férias * `NEGATIVE_VACATION_DIFFERENCE` – Diferença negativa de férias * `NEGATIVE_VACATION_PREMIUM_DIFFERENCE` – Diferença negativa do abono * `JUDICIAL_ALIMONY_VACATION_DIFFERENCE` – Diferença de pensão judicial sobre férias * `IRRF_VACATION_DIFFERENCE` – Diferença de IRRF sobre férias * `IRRF_VACATION_DISCOUNT_MONTH_PROPORTIONAL` – IRRF sobre férias com desconto proporcional na folha * `INSS_VACATION_DIFFERENCE` – Diferença de INSS sobre férias * `INSS_VACATION_RETURN` – Devolução de INSS sobre férias * `AVERAGE_OVERTIME_MATERNITY_LEAVE` – Média de horas extras salário maternidade * `AVERAGE_OVERTIME_INSS_MATERNITY_LEAVE` – Média de horas extras salário maternidade INSS * `AVERAGE_OVERTIME_CITIZEN_COMPANY_MATERNITY` – Média de horas extras salário maternidade empresa cidadã * `PRIOR_NOTICE_COMPENSATED` – Aviso prévio indenizado * `PRIOR_NOTICE_NOT_FULLFILLED` – Aviso prévio reavido * `THIRTEENTH_SALARY_PROPORTIONAL` – 13º salário proporcional * `MATERNITY_THIRTEENTH_SALARY_PROPORTIONAL` – 13º salário proporcional maternidade * `THIRTEENTH_SALARY_COMPENSATED` – 13º salário indenizado * `FGTS_DISMISSAL_THIRTEENTH_SALARY_DEPOSITED` – FGTS sobre 13º salário depositado na rescisão * `FGTS_DISMISSAL_DEPOSITED` – FGTS depositado na rescisão * `VACATION_OVERDUE_DISMISSAL` – Férias vencidas na rescisão * `THIRD_OF_VACATION_OVERDUE_DISMISSAL` – 1/3 sobre férias vencidas na rescisão * `DOUBLE_VACATION_OVERDUE_DISMISSAL` – Multa por dobro de férias vencidas na rescisão * `VACATION_PROPORTIONAL_DISMISSAL` – Férias proporcionais na rescisão * `VACATION_COMPENSATED_DISMISSAL` – Férias indenizadas na rescisão * `DISMISSAL_STABILITY` – Estabilidade na rescisão * `ADDITIONAL_NIGHT_VACATION` – Adicional noturno de férias * `AVERAGE_INSALUBRITY_VACATION` – Média de insalubridade de férias * `AVERAGE_HAZARD_VACATION` – Média de periculosidade de férias * `COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Indenização no mês anterior da data-base * `THIRD_OF_VACATION_COMPENSATED_DISMISSAL` – 1/3 sobre férias indenizadas na rescisão * `DOUBLE_VACATION_COMPENSATED_DISMISSAL` – Multa por dobro de férias indenizadas na rescisão * `COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização no fim do contrato antecipado pela empresa * `COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização no fim do contrato antecipado pelo colaborador * `AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Média de horas extras indenizadas no fim do contrato antecipado pela empresa * `COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização de férias no fim do contrato antecipado pela empresa * `COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização de férias no fim do contrato antecipado pelo colaborador * `COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização de 13º salário no fim do contrato antecipado pela empresa * `COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização de 13º salário no fim do contrato antecipado pelo colaborador * `THIRD_OF_VACATION_PROPORTIONAL_DISMISSAL` – 1/3 sobre férias proporcionais na rescisão * `AVERAGE_OVERTIME_VACATION_PROPORTIONAL_DISMISSAL` – Média de horas extras de férias proporcionais na rescisão * `AVERAGE_VARIABLE_VALUES_VACATION_PROPORTIONAL_DISMISSAL` – Média de valores variáveis de férias proporcionais na rescisão * `ADDITIONAL_VACATION_PROPORTIONAL_DISMISSAL` – Adicionais de férias proporcionais na rescisão * `ADDITIONAL_VACATION_OVERDUE_DISMISSAL` – Adicionais de férias vencidas na rescisão * `DAYTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS` – Horas diurnas – Afastamento para qualificação profissional * `NIGHTTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS` – Horas noturnas – Afastamento para qualificação profissional * `PROFESSIONAL_QUALIFICATION_FINE` – Multa de qualificação profissional * `BALANCE_OF_SALARY` – Saldo de salário * `DSR_BALANCE_OF_SALARY` – Repouso sobre saldo de salário * `DAYTIME_PRIOR_NOTICE_HOURS_WORKED` – Horas diurnas – Aviso prévio trabalhado * `NIGHTTIME_PRIOR_NOTICE_HOURS_WORKED` – Horas noturnas – Aviso prévio trabalhado * `DAYTIME_JUSTIFIED_HOURS` – Horas diurnas – Justificadas * `NIGHTTIME_JUSTIFIED_HOURS` – Horas noturnas – Justificadas * `BIRTH_AID` – Auxílio natalidade * `CASH_SHORTAGE_ADDITIONAL` – Adicional de quebra de caixa * `DEDUCTION_ADVANCE_THIRTEENTH_SALARY_DISMISSAL_WITHOUT_THIRTEENTH_SALARY` – Desconto de adiantamento de 13° salário e rescisão sem 13° salário pago * `ABSENCES_AS_DEDUCTION` – Faltas como desconto * `FGTS_THIRTEENTH_SALARY_PROPORTIONAL_MILITARY_SERVICE` – FGTS sobre 13º salário proporcional serviço militar * `FGTS_THIRTEENTH_SALARY_PROPORTIONAL_WORK_ACCIDENT` – FGTS sobre 13º salário proporcional acidente de trabalho * `FGTS_THIRTEENTH_SALARY_PAID_MONTH` – FGTS sobre 13º salário pago no mês * `FGTS_COMPENSATED` – FGTS indenizado * `FGTS_THIRTEENTH_SALARY_COMPENSATED` – FGTS sobre 13º indenizado * `AVERAGE_OVERTIME_VACATION_OVERDUE_DISMISSAL` – Média de horas extras de férias vencidas na rescisão * `AVERAGE_VARIABLE_VALUES_VACATION_OVERDUE_DISMISSAL` – Média de valores variáveis de férias vencidas na rescisão * `FGTS_DISMISSAL_FINE` – Multa de FGTS na rescisão * `DISMISSAL_NET` – Líquido da rescisão * `THIRD_OF_NEGATIVE_VACATION_DIFFERENCE` – Diferença negativa de 1/3 sobre férias * `THIRD_OF_NEGATIVE_VACATION_PREMIUM_DIFFERENCE` – Diferença negativa de 1/3 sobre abono * `THIRD_OF_VACATION_DIFFERENCE` – Diferença de 1/3 sobre férias * `THIRD_OF_VACATION_PREMIUM_DIFFERENCE` – Diferença de 1/3 sobre abono * `FINE_FOR_LATE_PAYMENT_TERMINATION` – Multa por pagamento fora do prazo. Art. 477 * `COMPENSATION_AS_DISMISSAL_INCENTIVE` – Indenização a título de incentivo a demissão * `DAYTIME_VACATION_HOURS_PAYROLL` – Horas férias diurnas na folha * `NIGHTTIME_VACATION_HOURS_PAYROLL` – Horas férias noturnas na folha * `AVERAGE_OVERTIME_VACATION_PAYROLL` – Média de horas extras de férias na folha * `AVERAGE_VARIABLE_VALUES_VACATION_PAYROLL` – Média de valores variáveis de férias na folha * `ADDITIONAL_NIGHT_VACATION_PAYROLL` – Adicional noturno de férias na folha * `AVERAGE_INSALUBRITY_VACATION_PAYROLL` – Média de insalubridade de férias na folha * `AVERAGE_HAZARD_VACATION_PAYROLL` – Média de periculosidade de férias na folha * `THIRD_OF_VACATION_PAYROLL` – 1/3 sobre férias na folha * `DOUBLE_VACATION_FINE_PAYROLL` – Multa dobro de férias na folha * `VACATION_PREMIUM_PAYROLL` – Abono pecuniário na folha * `AVERAGE_OVERTIME_PREMIUM_PAYROLL` – Média de horas extras de abono na folha * `AVERAGE_VARIABLE_VALUES_PREMIUM_PAYROLL` – Média de valores variáveis de abono na folha * `ADDITIONAL_PREMIUM_PAYROLL` – Adicionais de abono na folha * `THIRD_OF_VACATION_PREMIUM_PAYROLL` – 1/3 sobre abono pecuniário na folha * `DOUBLE_VACATION_PREMIUM_FINE_PAYROLL` – Multa dobro do abono pecuniário na folha * `INSS_VACATION_PAY_PAYROLL` – INSS sobre férias na folha * `JUDICIAL_ALIMONY_VACATION_PAYROLL` – Pensão judicial sobre férias na folha * `INSS_REFUND` – Devolução de INSS * `JUDICIAL_ALIMONY_CALCULATION_RRA` – Pensão judicial de cálculo RRA * `JUDICIAL_ALIMONY_CALCULATION_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – Pensão judicial de cálculo RRA dissídio coletivo rescisão * `IRRF_CALCULATION_RRA` – IRRF de cálculo RRA * `INSS_DEDUCTION_RRA` – Desconto INSS de RRA * `INSS_VACATION_CALCULATION_RRA` – INSS férias de cálculo RRA * `INSS_THIRTEENTH_SALARY_CALCULATION_RRA` – INSS 13º salário de cálculo RRA * `INSS_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS RRA dissídio coletivo rescisão * `INSS_THIRTEENTH_SALARY_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS 13º salário RRA dissídio coletivo rescisão * `PIS_VALUE_THIRTEENTH_SALARY_MONTHLY_PAYROLL` – Valor do PIS de 13º salário na folha mensal * `PIS_MONTHLY_PAYROLL_VALUE` – Valor do PIS na folha mensal * `PIS_DISMISSAL_VALUE` – Valor do PIS na rescisão * `INSALUBRITY_PREGNANT_EMPLOYEE_HEALTHY_ENVIRONMENT` – Insalubridade gestante em local salubre * `PREVIOUS_DISMISSAL_OVERFLOW` – Estouro da rescisão anterior * `INSS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS sobre 13º salário no dissídio coletivo na rescisão * `INSS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS no dissídio coletivo na rescisão * `FGTS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – FGTS sobre 13º salário no dissídio coletivo na rescisão * `FGTS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – FGTS no dissídio coletivo na rescisão * `THIRD_PARTY_INCOME` – Proventos de terceiros * `THIRD_PARTY_DEDUCTIONS` – Descontos de terceiros * `THIRD_PARTY_INSS` – INSS de terceiros * `THIRD_PARTY_IRRF` – IRRF de terceiros * `THIRD_PARTY_SEST` – SEST de terceiros * `THIRD_PARTY_SENAT` – SENAT de terceiros * `THIRD_PARTY_ISS` – ISS de terceiros * `THIRD_PARTY_JUDICIAL_ALIMONY` – Pensão judicial de terceiros * `HEALTH_PLAN_HOLDER_COMPANY_MONTHLY_FEE` – Mensalidade de plano de saúde titular parte empresa * `HEALTH_PLAN_HOLDER_EMPLOYEE_MONTHLY_FEE` – Mensalidade de plano de saúde titular parte colaborador * `HEALTH_PLAN_DEPENDENT_COMPANY_MONTHLY_FEE` – Mensalidade de plano de saúde dependente parte empresa * `HEALTH_PLAN_DEPENDENT_EMPLOYEE_MONTHLY_FEE` – Mensalidade de plano de saúde dependente parte colaborador * `HEALTH_PLAN_COPAYMENT_DEDUCTION` – Desconto de coparticipação de plano de saúde * `WORKER_CREDIT_LOAN` – Empréstimo do crédito do trabalhador – desconto mensal * `WORKER_CREDIT_LOAN_DIFFERENCE` – Diferença de empréstimo do crédito do trabalhador * `WORKER_CREDIT_PROVISION_SALARY_ADVANCE` – Provisão de crédito do trabalhador sobre adiantamento salarial * `WORKER_CREDIT_PROVISION_VACATION` – Provisão de desconto do crédito do trabalhador sobre férias * `WORKER_CREDIT_PROVISION_VACATION_PAYROLL` – Provisão de crédito do trabalhador sobre férias na folha * `COMPLEMENTARY_PENSION` – Previdência complementar * `COMPLEMENTARY_PENSION_VACATION` – Previdência complementar sobre férias * `COMPLEMENTARY_PENSION_THIRTEENTH_SALARY` – Previdência complementar sobre 13º salário * `WORKER_CREDIT_LOAN_DISMISSAL` – Empréstimo do crédito do trabalhador na rescisão ruleType: type: string enum: – HOURS – OVERTIME – DSR_OVERTIME – IRRF – FGTS – INSS – FAMILY_SALARY – ADDITIONAL_NIGHT – HAZARD – CALCULATION_BASIS_INFORMED_VALUE_CALCULATION_VALUE – INSALUBRITY – CALCULATION_VALUE_CALCULATION_BASIS – INFORMED_VALUE_CALCULATION_VALUE – JUDICIAL_ALIMONY_MONTH – COMMISSIONS – DSR_COMMISSIONS – MONTH_OVERFLOW – MONTH_REFUND – SYNDICATE_CONTRIBUTIONS – DISCOUNT_ADVANCE_THIRTEENTH_SALARY – MATERNITY_THIRTEENTH_SALARY – AVERAGE_OVERTIME – AVERAGE_VARIABLE_VALUES – ANNUITIES – COMPLEMENTARY_THIRTEENTH_SALARY – SALARY_ADVANCE – MILITARY_SERVICE_WORK_ACCIDENT_THIRTEENTH_SALARY – DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY – THIRD_OF_VACATION_AND_VACATION_PREMIUM – DOUBLE_VACATION_AND_VACATION_PREMIUM_FINE – VACATION_DAYS_AND_DISMISSAL – DISMISSAL_NET – VACATION_DIFFERENCE – THIRD_PARTY_REPORTED_VALUE – THIRD_PARTY_TAXES – HEALTH_PLAN – WORKER_CREDIT_LOAN description: Regra: * `HOURS` – Horas * `OVERTIME` – Horas extras * `DSR_OVERTIME` – DSR Horas Extras * `IRRF` – IMPOSTO DE RENDA * `FGTS` – FGTS * `INSS` – INSS * `FAMILY_SALARY` – Salário família * `ADDITIONAL_NIGHT` – Adicional Noturno * `HAZARD` – Periculosidade * `CALCULATION_BASIS_INFORMED_VALUE_CALCULATION_VALUE` – Base de cálculo x Valor informado x Valor de cálculo * `INSALUBRITY` – Insalubridade * `CALCULATION_VALUE_CALCULATION_BASIS` – Valor de cálculo x Base de cálculo * `INFORMED_VALUE_CALCULATION_VALUE` – Valor informado x Valor de cálculo * `JUDICIAL_ALIMONY_MONTH` – Pensão judicial mensal * `COMMISSIONS` – Comissões * `DSR_COMMISSIONS` – Repouso sobre comissões * `MONTH_OVERFLOW` – Estouro do mês * `MONTH_REFUND` – Troco do mês * `SYNDICATE_CONTRIBUTIONS` – Contribuições do sindicato * `DISCOUNT_ADVANCE_THIRTEENTH_SALARY` – Desconto adiantamento 13º salário * `MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade * `AVERAGE_OVERTIME` – Média horas extras * `AVERAGE_VARIABLE_VALUES` – Média valores variáveis * `ANNUITIES` – Anuidades * `COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar * `SALARY_ADVANCE` – Adiantamento salarial * `MILITARY_SERVICE_WORK_ACCIDENT_THIRTEENTH_SALARY` – Avos de 13º salário acidente de trabalho/serviço militar * `DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Desconto de pensão judicial no adiantamento do 13º salário * `THIRD_OF_VACATION_AND_VACATION_PREMIUM` – 1/3 sobre férias e abono pecuniário * `DOUBLE_VACATION_AND_VACATION_PREMIUM_FINE` – Multa por dobro de férias * `VACATION_DAYS_AND_DISMISSAL` – Dias nas férias e rescisões * `DISMISSAL_NET` – Líquido da rescisão * `VACATION_DIFFERENCE` – Diferença de férias * `THIRD_PARTY_REPORTED_VALUE` – Valor informado de terceiros * `THIRD_PARTY_TAXES` – Impostos de terceiros * `HEALTH_PLAN` – Plano de saúde * `WORKER_CREDIT_LOAN` – Empréstimo de crédito do trabalhador calculationMonthlyPaidWorkerDayType: type: string enum: – WORKSCHEDULE_CLOCKING_REGISTER – DSR_MINUTES_WORKSHIFT – NO_CALCULATE description: Tipo do cálculo dia mensalista: * `WORKSCHEDULE_CLOCKING_REGISTER` – Considera horário da escala do dia * `DSR_MINUTES_WORKSHIFT` – Considera horas DSR da escala * `NO_CALCULATE` – Não calcula o dia para faltas vacationInfluenceType: type: string enum: – NOT_INFLUENCE – LOSES_REFERENCE_PERIOD_180_DAYS – LOSES_REFERENCE_PERIOD_30_DAYS – STOPS_AND_CONTINUES_AFTER_RETURN – COUNT_ABSENCES_FOR_VACATION description: Tipo de influência férias: * `NOT_INFLUENCE` – Não influencia no direito a férias * `LOSES_REFERENCE_PERIOD_180_DAYS` – Perde período aquisitivo se maior que 180 dias * `LOSES_REFERENCE_PERIOD_30_DAYS` – Perde direito período aquisitivo se maior que 30 dias * `STOPS_AND_CONTINUES_AFTER_RETURN` – Interrompe e continua no retorno * `COUNT_ABSENCES_FOR_VACATION` – Considera falta para fins de perda de férias calculationHourlyCommissionedPaidWorkerDayType: type: string enum: – WORKSCHEDULE_CLOCKING_REGISTER – DSR_MINUTES_WORKSHIFT – NO_CALCULATE description: Tipo de cálculo dia horista e comissionado: * `WORKSCHEDULE_CLOCKING_REGISTER` – Considera horário da escala do dia * `DSR_MINUTES_WORKSHIFT` – Considera horas DSR da escala * `NO_CALCULATE` – Não calcula o dia para faltas enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumAnaSin: type: string enum: – VA – VS description: Analítico ou Sintético: * `VA` – Analítico(a) * `VS` – Sintético(a) enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo alimonyCalculationType: type: string enum: – VACATION – THIRTEENTH_SALARY description: Tipo de cálculo de pensão judicial nas férias: * `VACATION` – Férias * `THIRTEENTH_SALARY` – 13º salário provisionType: type: string enum: – VACATION – THIRD_VACATION – INSS – FGTS – PIS description: Tipo da provisão: * `VACATION` – Férias * `THIRD_VACATION` – 1/3 Férias * `INSS` – INSS * `FGTS` – FGTS * `PIS` – PIS provisionBasisType: type: string enum: – VACATION – THIRD_VACATION description: Tipo da base da provisão: * `VACATION` – Férias * `THIRD_VACATION` – 1/3 Férias timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno do horário: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral salaryType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 description: Tipo do salário: * `V1` – Por hora * `V2` – Por dia * `V3` – Por semana * `V4` – Por quinzena * `V5` – Por mês * `V6` – Por tarefa * `V7` – Comissionado – salário exclusivamente variável userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status filterBatchDTO: description: Filtro de batch type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores advancedFilter: type: string maxLength: 36 description: Filtro avançado vacationScheduleDTO: description: DTO de programação de férias type: object required: – startDate – paymentDateVacation – paidLeaveCollectiveVacation properties: id: type: string description: Identificador único startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final vacationPremiumDays: type: number format: double description: Dias de abono minimum: 0 maximum: 99.99 vacationDays: type: number format: double description: Dias de férias minimum: 0 maximum: 99.99 thirteenthSalaryVacation: type: boolean description: Décimo terceiro salário default: false paymentDateVacation: type: string format: date description: Data de pagamento paidLeaveCollectiveVacation: type: number format: double description: Licença remunerada férias coletivas minimum: 0 maximum: 99.99 payDoubleVacationFine: type: boolean description: Pagar multa de férias em dobro default: true deleteVacationScheduleBatchDTO: description: DTO de exclusão coletiva de programação de férias type: object required: – startDate – endDate – vacationType properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final vacationType: type: string allOf: – #/definitions/collectiveExclusionVacationType description: Tipo de férias – Exclusão coletiva deleteVacationReceiptBatchDTO: description: DTO de exclusão coletiva do recibo de férias type: object required: – startDate – endDate – vacationType properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final vacationType: type: array items: type: string allOf: – #/definitions/vacationType minimum: 1 description: Tipo de férias vacationPaymentTitleIntegrationEligibilityDTO: description: Elegibilidade de um título de pagamento de férias para integração bancária type: object required: – id properties: id: type: string maxLength: 36 description: Identificador do título de pagamento number: type: string maxLength: 20 description: Número do título status: type: string maxLength: 255 description: Status do título payeeName: type: string maxLength: 100 description: Nome do favorecido needsReason: type: boolean description: Indica se o envio exige motivo default: false errorMessage: type: string maxLength: 255 description: Motivo da inelegibilidade vacationPaymentTitleSidebarPaymentDTO: description: Dados do pagamento de um título para a barra lateral type: object required: – id – status – paymentCategory – paymentDate – netValue – beneficiaryType properties: id: type: string maxLength: 36 description: Identificador do título de pagamento accountPayableNumber: type: string maxLength: 20 description: Número do título, nulo até o primeiro envio status: type: string maxLength: 255 description: Status do título statusReason: type: string maxLength: 255 description: Motivo do status paymentOriginType: type: string maxLength: 255 description: Origem do pagamento paymentCategory: type: string maxLength: 255 description: Categoria do pagamento paymentDate: type: string format: date description: Data de pagamento netValue: type: string description: Valor líquido beneficiaryType: type: string maxLength: 255 description: Tipo de favorecido beneficiaryName: type: string maxLength: 255 description: Nome do favorecido employeeCode: type: integer format: int64 description: Código do colaborador employeeName: type: string maxLength: 255 description: Nome do colaborador companyCode: type: integer format: int64 description: Código da empresa companyName: type: string maxLength: 255 description: Nome da empresa branchCode: type: integer format: int64 description: Código da filial branchName: type: string maxLength: 255 description: Nome da filial branchError: type: string maxLength: 255 description: Motivo de a filial não ter sido resolvida vacationPaymentTitleSidebarBankAccountDTO: description: Conta bancária do favorecido de um título para a barra lateral type: object properties: bankCode: type: string maxLength: 10 description: Código do banco bankName: type: string maxLength: 255 description: Nome do banco branchCode: type: string maxLength: 10 description: Código da agência accountNumber: type: string maxLength: 30 description: Número da conta accountDigit: type: string maxLength: 5 description: Dígito da conta accountType: type: string maxLength: 255 description: Tipo de conta no cadastro de origem effective: type: boolean description: Indica se a conta estava vigente na data de pagamento, nulo para dependente startDate: type: string format: date description: Início da vigência da conta endDate: type: string format: date description: Fim da vigência da conta vacationPaymentTitleSidebarStatusHistoryDTO: description: Mudança de status de um título para a barra lateral type: object required: – newStatus properties: previousStatus: type: string maxLength: 255 description: Status anterior newStatus: type: string maxLength: 255 description: Novo status eventSource: type: string maxLength: 255 description: Origem do evento reason: type: string maxLength: 255 description: Motivo createdBy: type: string maxLength: 255 description: Usuário que registrou a mudança createdDate: type: string format: date-time description: Data e hora da mudança integrateBankPaymentItemDTO: description: Título de pagamento de férias selecionado para integração bancária type: object required: – id properties: id: type: string maxLength: 36 description: Identificador do título de pagamento reason: type: string maxLength: 255 description: Motivo do reenvio integrateBankPaymentsBatchDTO: description: Seleção de títulos de pagamento processada pelo processo em lote de integração bancária type: object required: – titles properties: titles: type: array items: type: object allOf: – #/definitions/integrateBankPaymentItemDTO minimum: 1 description: Títulos de pagamento selecionados para integração saveVacationScheduleBatchDTO: description: DTO de geração em lote de programação de férias type: object required: – vacationType – startDate – paymentDateVacation – thirteenthSalaryVacation properties: summaryId: type: string description: Identificador único do processo vacationType: type: string allOf: – #/definitions/vacationType description: Tipo de férias startDate: type: string format: date description: Data inicial vacationPremiumDays: type: number format: double description: Dias de abono minimum: 0 maximum: 99.99 vacationDays: type: number format: double description: Dias de férias minimum: 0 maximum: 99.99 paymentDateVacation: type: string format: date description: Data de pagamento thirteenthSalaryVacation: type: boolean description: Décimo terceiro salário warningMessages: type: array items: type: string description: Mensagens de aviso employeeAcquisitivePeriodCustomDTO: description: DTO de retorna o período aquisitivo do colaborador type: object required: – id – startAcquisitivePeriod – endAcquisitivePeriod – balanceDays – debitDays – vacationDaysLost – situationPeriodType – rightDays – endDateChanged – maxRightDays properties: id: type: string description: Identificador único startAcquisitivePeriod: type: string format: date description: Data de início do período aquisitívo endAcquisitivePeriod: type: string format: date description: Data de fim do período aquisitivo balanceDays: type: number format: double description: Dias de saldo do período debitDays: type: number format: double description: Dias de débito vacationDaysLost: type: integer format: int64 description: Dias perdidos situationPeriodType: type: string allOf: – #/definitions/situationPeriodType description: Tipo de situação do período rightDays: type: number format: double description: Dias de direito endDateChanged: type: boolean description: Data fim foi alterada maxRightDays: type: number format: double description: Dias de direito máximo employeeIdDTO: description: Identificador do colaborador type: object required: – id – code – companyCode properties: id: type: string description: ids do colaborador code: type: integer format: int64 description: Codigo do colaborador companyCode: type: integer format: int64 description: Código da empresa companyData: description: Dados da empresa type: object required: – id – code – description properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código description: type: string description: Nome calculationDefinitionData: description: Dados do código de cálculo type: object required: – id – code – competence – calculationType – paymentDate – startDatePayroll – endDatePayroll properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código competence: type: string format: date description: Competência calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo paymentDate: type: string format: date description: Data de pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final advanceThirteenthSalaryPercentage: type: number format: double description: % adiantamento 13º lookupItem: description: Resultado de consulta de lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro ordinationVacationReceiptDetail: description: Ordenação do demonstrativo de pagamento type: object required: – field – order properties: field: type: string allOf: – #/definitions/vacationReceiptDetailOrderType description: Campo order: type: string allOf: – #/definitions/orderType description: Ordenação vacationReceiptDetailCustomDTO: description: Dados dos detalhes do recibo de férias type: object required: – id – wageTypeId – wageTypeCode – wageTypeDescription – identificationType – reference – value properties: id: type: string description: Identificador do detalhe do recibo de férias wageTypeId: type: string description: Identificador do evento wageTypeCode: type: integer format: int64 description: Código do evento wageTypeDescription: type: string description: Descrição do evento identificationType: type: string allOf: – #/definitions/identificationType description: Tipo do evento reference: type: number format: double description: Refência value: type: number format: double description: Valor vacationProvisionDTO: description: Dados da provisão de férias (cabeçalho + detalhes + bases) type: object required: – id – employeeAcquisitivePeriod – startAcquisitivePeriod – endAcquisitivePeriod – competence – companyBranch – costCenter – processId – details – basis properties: id: type: string description: Identificador único employeeAcquisitivePeriod: type: string description: Período aquisitivo startAcquisitivePeriod: type: string format: date description: Data de início do período aquisitivo endAcquisitivePeriod: type: string format: date description: Data de fim do período aquisitivo competence: type: string format: date description: Competência companyBranch: type: string description: Filial costCenter: type: string description: Centro de custo costCenterCode: type: string description: Código do centro de custo costCenterName: type: string description: Descrição do centro de custo processId: type: string description: Identificador do processo details: type: array items: type: object allOf: – #/definitions/vacationProvisionDetailDTO minimum: 1 description: Detalhes da provisão (Férias, 1/3, INSS, FGTS, PIS) basis: type: array items: type: object allOf: – #/definitions/vacationProvisionBasisDTO minimum: 1 description: Bases da provisão por evento vacationProvisionDetailDTO: description: Detalhe da provisão de férias type: object required: – id – provisionType properties: id: type: string description: Identificador único provisionType: type: string allOf: – #/definitions/provisionType description: Tipo da provisão base: type: string description: Base percentageOrDays: type: number format: double description: Percentual ou dias previousBalance: type: string description: Saldo anterior transferredBalance: type: string description: Saldo transferido adjustment: type: string description: Ajuste monthlyProvision: type: string description: Provisão do mês paid: type: string description: Pagas previousPaidInExcess: type: string description: Pagas a Maior Mês Anterior paidInExcessOffset: type: string description: Valor Mês Pagas a Maior paidInExcess: type: string description: Pagas a Maior paidInExcessBalance: type: string description: Saldo Pagas a Maior paidInExcessAdjustment: type: string description: Ajuste Pagas a Maior indemnified: type: string description: Indenizado balance: type: string description: Saldo vacationProvisionBasisDTO: description: Base da provisão de férias type: object required: – id – wageType properties: id: type: string description: Identificador único wageType: type: string description: Evento wageTypeCode: type: integer format: int64 description: Código da verba do evento wageTypeDescription: type: string description: Descrição da verba do evento, no idioma da requisição value: type: string description: Valor provisionBasisType: type: string allOf: – #/definitions/provisionBasisType description: Tipo da base da provisão hasInssIncidence: type: boolean description: Incidência INSS hasFgtsIncidence: type: boolean description: Incidência FGTS hasPisIncidence: type: boolean description: Incidência PIS vacationProvisionDashboardKpiDTO: description: Indicadores (KPIs) do dashboard executivo da provisão de férias type: object required: – totalBalance – monthlyProvision – adjustments – payments properties: totalBalance: type: string description: Saldo total — soma de vacationProvisionDetail.balance de todos os provisionType (Férias, 1/3, INSS, FGTS, PIS) no escopo/competência monthlyProvision: type: string description: Provisão do mês — soma de monthlyProvision no escopo/competência adjustments: type: string description: Ajustes — soma de adjustment no escopo/competência payments: type: string description: Pagamentos — soma de (paid + indemnified) no escopo/competência vacationProvisionDashboardHistoryItemDTO: description: Ponto da série histórica do dashboard executivo da provisão de férias type: object required: – competence – balance – monthlyProvision – adjustments – payments properties: competence: type: string format: date description: Competência do ponto balance: type: string description: Saldo na competência monthlyProvision: type: string description: Provisão do mês na competência adjustments: type: string description: Ajustes na competência payments: type: string description: Pagamentos (baixas por recibo e rescisão) na competência vacationScheduleWiipoIntegrationDataDTO: description: Informação da programação de férias para integração com a Wiipo type: object properties: vacationScheduleId: type: string description: Id da programação de férias employeeId: type: string description: Id do colaborador startDate: type: string format: date description: Data inicial das férias (chave de relacionamento com os dados do colaborador: employeeId + vacationStartDate) receipts: type: array items: type: object allOf: – #/definitions/vacationReceiptWiipoIntegrationDataDTO description: Recibos de férias da programação. Pode vir vazio quando a programação foi contada mas não possui recibos calculados no período. vacationReceiptWiipoIntegrationDataDTO: description: Informação do recibo de férias para integração com a Wiipo type: object properties: acquisitivePeriodStartDate: type: string format: date description: Data inicial do período aquisitivo acquisitivePeriodEndDate: type: string format: date description: Data final do período aquisitivo vacationDays: type: number format: double description: Dias de férias vacationPremiumDays: type: number format: double description: Dias de abono startDate: type: string format: date description: Data inicial das férias endDate: type: string format: date description: Data final das férias returnDate: type: string format: date description: Data de retorno das férias paymentDate: type: string format: date description: Data de pagamento das férias baseSalary: type: string description: Salário base totalDiscounts: type: string description: Total de descontos totalIncome: type: string description: Total de proventos totalValue: type: string description: Total líquido receiptsEventsInformation: type: array items: type: object allOf: – #/definitions/receiptDetailsWiipoIntegrationDataDTO description: Eventos do recibo de férias invalidatedDates: type: string description: Dias desconsiderados no recibo de férias receiptDetailsWiipoIntegrationDataDTO: description: Informação dos eventos do recibo de férias para integração com a Wiipo type: object properties: reference: type: number format: double description: Referência value: type: string description: Valor wageTypeCode: type: integer format: int64 description: Código do evento wageTypeShortName: type: string description: Nome do evento detailType: type: integer format: int64 description: Tipo do evento vacationScheduleValidationDTO: description: Dados da programação de férias para o cálculo da data final type: object required: – startDate – vacationDays properties: startDate: type: string format: date description: vacationDays: type: integer format: int64 description: endDate: type: string format: date description: vacationReceiptWageTypeDTO: description: Informações do evento calculado no recibo de férias type: object required: – wageTypeId – code – characteristicType – ruleType – reference – value – acquisitivePeriodStartDate – processId properties: wageTypeId: type: string maxLength: 36 description: Identificador único do evento code: type: integer format: int64 description: Código do evento characteristicType: type: string allOf: – #/definitions/characteristicType description: Característica ruleType: type: string allOf: – #/definitions/ruleType description: Regra reference: type: number format: double description: Referência value: type: string description: Valor acquisitivePeriodStartDate: type: string format: date description: Data inicial do perído aquisitivo processId: type: string maxLength: 36 description: Identificador único do processo vacationReceiptBatchItem: description: Item da exclusão em lote de recibo de férias type: object required: – vacationScheduleId – startDate – paymentDateVacation – vacationReceiptItemDTO properties: vacationScheduleId: type: string description: Identificador da programação de férias startDate: type: string format: date description: Data inicial do período das férias endDate: type: string format: date description: Data final do período das férias paymentDateVacation: type: string format: date description: Data de pagamento do recibo de férias sentWiipo: type: boolean description: Indica se a programação estava com status Enviado Wiipo antes da exclusão vacationReceiptItemDTO: type: array items: type: object allOf: – #/definitions/vacationReceiptItemDTO minimum: 1 description: Dados do recibo de férias para o item da exclusão em lote de recibos vacationReceiptItemDTO: description: Dados do recibo de férias para o item da exclusão em lote de recibos type: object required: – id – vacationScheduleId – processId – employeeId – employeeAcquisitivePeriodId – startDate – vacationDays – vacationPremiumDays properties: id: type: string description: Identificador único vacationScheduleId: type: string description: Identificador da programação de férias processId: type: string description: Identificador do processo employeeId: type: string description: Identificador do colaborador employeeAcquisitivePeriodId: type: string description: Identificador do período aquisitivo startDate: type: string format: date description: Data inicial vacationDays: type: number format: double description: Dias de férias vacationPremiumDays: type: number format: double description: Dias de abono employeeAcquisitivePeriodData: description: Dados do período aquisitivo do colaborador. type: object required: – id – employeeId – companyCode – companyName – employeeCode – employeeName – startAcquisitivePeriod – situationPeriodType – endDateChanged – maxRightDays properties: id: type: string description: Identificador único employeeId: type: string description: Identificador único do colaborador companyCode: type: integer format: int64 description: Código da empresa companyName: type: string description: Nome da empresa employeeCode: type: integer format: int64 description: Código do colaborador employeeName: type: string description: Nome do colaborador startAcquisitivePeriod: type: string format: date description: Início do período aquisitivo endAcquisitivePeriod: type: string format: date description: Fim do período aquisitivo rightDays: type: number format: double description: Dias de direito absenceDays: type: number format: double description: Dias de falta leaveDays: type: number format: double description: Dias de afastamento paidLeaveDays: type: number format: double description: Dias de licença remunerada debitDays: type: number format: double description: Dias de débito unpaidLeaveDays: type: number format: double description: Dias de licença não remunerada militaryServiceDays: type: number format: double description: Dias de serviço militar cashAllowanceDays: type: number format: double description: Dias de abono pecuniário balanceDays: type: number format: double description: Dias de saldo vacationFractionDenominator: type: integer format: int64 description: Avos de férias vacationDaysLost: type: integer format: int64 description: Dias perdidos situationPeriodType: type: string allOf: – #/definitions/situationPeriodType description: Situação do período endDateChanged: type: boolean description: Data fim foi alterada maxRightDays: type: number format: double description: Dias de direito máximo employeeDependentCompanyTransferData: description: Dados dos dependentes do colaborador transferido type: object required: – previousEmployeeDependent – newEmployeeDependent properties: previousEmployeeDependent: type: string maxLength: 36 description: Colaborador origem newEmployeeDependent: type: string maxLength: 36 description: Colaborador destino employeeVacationDeletionData: description: Dados das férias excluídas por colaborador type: object required: – employee – vacations properties: employee: type: string description: Colaborador vacations: type: array items: type: object allOf: – #/definitions/vacationDeletedData minimum: 1 description: Dados das férias excluídas vacationDeletedData: description: Dados do cálculo das férias excluídas type: object required: – starDate – endDate – paymentDate properties: starDate: type: string format: date description: Data de início endDate: type: string format: date description: Data fim paymentDate: type: string format: date description: Data de pagamento vacationReceiptData: type: array items: type: object allOf: – #/definitions/vacationReceiptData description: Dados dos recibos de férias vacationReceiptData: description: Dados do recibo de férias excluído type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data de início do recibo endDate: type: string format: date description: Data de fim do recibo employeeAcquisitivePeriod: description: Período aquisitivo type: object required: – employee – startAcquisitivePeriod – situationPeriodType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador startAcquisitivePeriod: type: string format: date description: Início do período aquisitivo endAcquisitivePeriod: type: string format: date description: Fim do período aquisitivo rightDays: type: number format: double description: Dias de direito maximum: 99999.99 default: 0.0 absenceDays: type: number format: double description: Dias de falta maximum: 99999.99 default: 0.0 leaveDays: type: number format: double description: Dias de afastamento maximum: 99999.99 default: 0.0 paidLeaveDays: type: number format: double description: Dias de licença remurada maximum: 99999.99 default: 0.0 debitDays: type: number format: double description: Dias de débito maximum: 99999.99 default: 0.0 unpaidLeaveDays: type: number format: double description: Dias de licença não remunerada maximum: 99999.99 default: 0.0 militaryServiceDays: type: number format: double description: Dias de serviço militar maximum: 99999.99 default: 0.0 cashAllowanceDays: type: number format: double description: Dias de abono pecuniário maximum: 99999.99 default: 0.0 balanceDays: type: number format: double description: Dias de saldo maximum: 99999.99 default: 0.0 vacationFractionDenominator: type: integer format: int64 description: Avos de férias maximum: 999 default: 0 vacationDaysLost: type: integer format: int64 description: Dias perdidos maximum: 99 default: 0 situationPeriodType: type: string allOf: – #/definitions/situationPeriodType description: Situação do período endDateChanged: type: boolean description: Data fim foi alterada default: false maxRightDays: type: number format: double description: Dias de direito máximo default: 30.0 imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeAcquisitivePeriod: type: object required: – id allOf: – #/definitions/employeeAcquisitivePeriod vacationSchedule: description: Programação de férias type: object required: – employee – startDate – paymentDateVacation – statusType – vacationType – paidLeaveCollectiveVacation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador employeeAcquisitivePeriod: type: object allOf: – #/definitions/employeeAcquisitivePeriod description: Período aquisitivo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final vacationPremiumDays: type: number format: double description: Dias de abono minimum: 0 maximum: 99.99 vacationDays: type: number format: double description: Dias de férias minimum: 0 maximum: 99.99 thirteenthSalaryVacation: type: boolean description: Décimo terceiro salário default: false paymentDateVacation: type: string format: date description: Data de pagamento doubleVacationPremium: type: number format: double description: Dobro de abono minimum: 0 maximum: 99.99 doubleVacation: type: number format: double description: Dobro de férias minimum: 0 maximum: 99.99 statusType: type: string allOf: – #/definitions/statusType description: Status vacationType: type: string allOf: – #/definitions/vacationType description: Tipo de férias paidLeaveCollectiveVacation: type: number format: double description: Licença remunerada férias coletivas minimum: 0 maximum: 99.99 payDoubleVacationFine: type: boolean description: Pagar multa de férias em dobro default: true returnDate: type: string format: date description: Data de retorno imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVacationSchedule: type: object required: – id allOf: – #/definitions/vacationSchedule vacationPaymentTitle: description: Título de pagamento type: object required: – bankIntegrationAccountConfig – beneficiaryAccountId – beneficiaryType – paymentCategory – paymentDate – netValue – status properties: id: type: string format: uuid description: Identificador único compartilhado com a programação de férias bankIntegrationAccountConfig: type: string format: uuid description: Configuração de conta de integração bancária beneficiaryAccountId: type: string format: uuid description: Conta do beneficiário employee: type: object allOf: – #/definitions/employee description: Colaborador beneficiário employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente beneficiário beneficiaryType: type: string maxLength: 255 description: Tipo de beneficiário vacationReceipt: type: object allOf: – #/definitions/vacationReceipt description: Recibo de férias de origem vacationSchedule: type: object allOf: – #/definitions/vacationSchedule description: Programação de férias de origem accountPayableNumber: type: string maxLength: 20 description: Número do título paymentCategory: type: string maxLength: 255 description: Categoria do pagamento paymentDate: type: string format: date description: Data de pagamento acquisitionPeriodStart: type: string format: date description: Início do período aquisitivo vacationStartDate: type: string format: date description: Data de início das férias netValue: type: string description: Valor líquido do título paidValue: type: string description: Valor efetivamente pago minimum: 0 status: type: string maxLength: 255 description: Status do título statusReason: type: string maxLength: 255 description: Motivo do status atual bankAuthentication: type: string maxLength: 255 description: Autenticação bancária payDate: type: string format: date description: Data de liquidação retryCount: type: integer format: int64 description: Quantidade de tentativas de envio default: 0 paymentOriginType: type: string maxLength: 255 description: Origem do pagamento overvalued: type: boolean description: Define se foi atribuído valor adicional a este título para alcançar 100% no rateio default: false deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationPaymentTitleStatusHistory: description: Histórico de status do título de pagamento type: object required: – vacationPaymentTitle – newStatus properties: id: type: string format: uuid description: Identificador único vacationPaymentTitle: type: object allOf: – #/definitions/vacationPaymentTitle description: Título de pagamento relacionado previousStatus: type: string maxLength: 255 description: Status anterior newStatus: type: string maxLength: 255 description: Novo status reason: type: string maxLength: 255 description: Motivo da transição eventSource: type: string maxLength: 255 description: Origem do evento da transição sentValue: type: string description: Valor enviado na transição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationReceipt: description: Recibos de férias type: object required: – processId – employee – employeeAcquisitivePeriod – vacationSchedule – startDate properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo employee: type: object allOf: – #/definitions/employee description: Colaborador employeeAcquisitivePeriod: type: object allOf: – #/definitions/employeeAcquisitivePeriod description: Período aquisitivo vacationSchedule: type: object allOf: – #/definitions/vacationSchedule description: Programação de férias startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final returnDate: type: string format: date description: Data de retorno vacationDays: type: number format: double description: Dias de férias minimum: 0.0 maximum: 99.99 default: 0.0 vacationPremiumDays: type: number format: double description: Dias de abono minimum: 0.0 maximum: 99.99 default: 0.0 paidLeaveCollectiveVacation: type: number format: double description: Dias de licença remunerada de férias coletivas minimum: 0.0 maximum: 99.99 default: 0.0 imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationReceiptInformation: description: Recibos de férias type: object required: – vacationReceipt – baseSalary – dependentsIRRF – basesIRRF – irrfValue – totalIncome – totalDiscounts – totalValue – totalAlimony – basesINSS – inssValue – totalLegalDeductionsWithoutDependents – totalThirteenthSalaryValue properties: id: type: string format: uuid description: Identificador único vacationReceipt: type: object allOf: – #/definitions/vacationReceipt description: Recibo de férias baseSalary: type: string description: Salário base dependentsIRRF: type: integer format: int64 description: Dependentes IRRF basesIRRF: type: string description: Base IRRF irrfValue: type: string description: Valor do IRRF totalIncome: type: string description: Total de proventos totalDiscounts: type: string description: Total de descontos totalValue: type: string description: Total líquido totalAlimony: type: string description: Total de pensão basesINSS: type: string description: Base INSS inssValue: type: string description: Valor do INSS totalLegalDeductionsWithoutDependents: type: string description: Total de deduções legais sem dependentes totalThirteenthSalaryValue: type: string description: Total de 13° salário pago no adiantamento nas férias createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationReceiptDetail: description: Detalhes dos recibos de férias type: object required: – vacationReceipt – wageType – reference – value – proportionType properties: id: type: string format: uuid description: Identificador único vacationReceipt: type: object allOf: – #/definitions/vacationReceipt description: Recibo de férias wageType: type: object allOf: – #/definitions/wageType description: Código do evento reference: type: number format: double description: Referência minimum: 0.0 value: type: string description: Valor minimum: 0.0 proportionType: type: string allOf: – #/definitions/proportionType description: Tipo de proporção do evento de férias imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: disregardVacationReceiptDay: description: Dias a desconsiderar no recibo de férias type: object required: – vacationReceipt – disregardedDay properties: id: type: string format: uuid description: Identificador único vacationReceipt: type: object allOf: – #/definitions/vacationReceipt description: Recibo de férias disregardedDay: type: string format: date description: Dia desconsiderado imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: properties: description: Propriedades type: object required: – key – value – updateDateTime properties: id: type: string format: uuid description: Identificador único key: type: string maxLength: 60 description: Chave da propriedade value: type: string maxLength: 255 description: Valor da chave updateDateTime: type: string format: date-time description: Data da última atualização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationEmployeeDependentAlimonyHistory: description: Histórico de pensão judicial nas férias type: object required: – employeeDependent – vacationReceiptOrigin – alimonyCalculationType – alimonyValue properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente vacationReceiptOrigin: type: object allOf: – #/definitions/vacationReceipt description: Recibo de férias de origem alimonyCalculationType: type: string allOf: – #/definitions/alimonyCalculationType description: Tipo de cálculo de pensão judicial alimonyValue: type: string description: Valor da pensão imported: type: boolean description: Registro importado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVacationEmployeeDependentAlimonyHistory: type: object required: – id allOf: – #/definitions/vacationEmployeeDependentAlimonyHistory vacationEmployeeDependentAlimonyPayeeHistory: description: Histórico de beneficiário de pensão judicial nas férias type: object required: – vacationEmployeeDependentAlimonyHistory – employeeDependent – alimonyValue properties: id: type: string format: uuid description: Identificador vacationEmployeeDependentAlimonyHistory: type: object allOf: – #/definitions/vacationEmployeeDependentAlimonyHistory description: Histórico de pensão judicial nas férias employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente alimonyValue: type: string description: Valor da pensão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationProvision: description: Provisão de férias type: object required: – employeeAcquisitivePeriod – competence – companyBranch – costCenter – processId properties: id: type: string format: uuid description: Identificador único employeeAcquisitivePeriod: type: object allOf: – #/definitions/employeeAcquisitivePeriod description: Período aquisitivo competence: type: string format: date description: Competência companyBranch: type: object allOf: – #/definitions/e070fil description: Filial costCenter: type: object allOf: – #/definitions/e044ccu description: Centro de custo processId: type: string format: uuid description: Identificador do processo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationProvisionDetail: description: Detalhe da provisão de férias type: object required: – vacationProvision – provisionType properties: id: type: string format: uuid description: Identificador único vacationProvision: type: object allOf: – #/definitions/vacationProvision description: Provisão de férias provisionType: type: string allOf: – #/definitions/provisionType description: Tipo da provisão base: type: string description: Base percentageOrDays: type: number format: double description: Percentual ou dias previousBalance: type: string description: Saldo anterior default: 0.0 transferredBalance: type: string description: Saldo transferido default: 0.0 adjustment: type: string description: Ajuste default: 0.0 monthlyProvision: type: string description: Provisão do mês paid: type: string description: Pagas default: 0.0 previousPaidInExcess: type: string description: Pagas a Maior Mês Anterior default: 0.0 paidInExcessOffset: type: string description: Valor Mês Pagas a Maior default: 0.0 paidInExcess: type: string description: Pagas a Maior default: 0.0 paidInExcessBalance: type: string description: Saldo Pagas a Maior default: 0.0 paidInExcessAdjustment: type: string description: Ajuste Pagas a Maior default: 0.0 indemnified: type: string description: Indenizado default: 0.0 balance: type: string description: Saldo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vacationProvisionBasis: description: Base da provisão de férias type: object required: – vacationProvision – wageType properties: id: type: string format: uuid description: Identificador único vacationProvision: type: object allOf: – #/definitions/vacationProvision description: Provisão de férias wageType: type: object allOf: – #/definitions/wageType description: Evento value: type: string description: Valor provisionBasisType: type: string allOf: – #/definitions/provisionBasisType description: Tipo da base da provisão hasInssIncidence: type: boolean description: Incidência INSS default: false hasFgtsIncidence: type: boolean description: Incidência FGTS default: false hasPisIncidence: type: boolean description: Incidência PIS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wiipoVacationExclusionPendency: description: Pendência de exclusão de programação de férias na Wiipo type: object properties: id: type: string format: uuid description: Identificador único vacationSchedule: type: string format: uuid description: Programação de férias employee: type: string format: uuid description: Colaborador vacationStartDate: type: string format: date description: Data de início das férias vacationEndDate: type: string format: date description: Data fim das férias processId: type: string format: uuid description: Identificador do processo processFinished: type: boolean description: Indica se o processo associado já foi finalizado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: variableEntryVacation: description: Lançamento variável da programação de férias type: object required: – employee – vacationSchedule – wageType – reference – value properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador vacationSchedule: type: object allOf: – #/definitions/vacationSchedule description: Programação de férias wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 value: type: string description: Valor minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVariableEntryVacation: type: object required: – id allOf: – #/definitions/variableEntryVacation e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 companyIndications: type: object allOf: – #/definitions/companyIndications description: Assinalamentos da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – codPes – nomPes properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 14 description: CPF/CNPJ deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employmentRelationship: description: Vínculo empregatício type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome x-i18n: true deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato employmentRelationshipStructure: type: object allOf: – #/definitions/employmentRelationshipStructure description: Estrutura de vínculo empregatício eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do eSocial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. employee: description: Colaborador type: object required: – hireDate – code properties: id: type: string format: uuid description: Identificador único employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo empregatício person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de demissão employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador code: type: integer format: int64 description: Cadastro deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação companyTransferDate: type: string format: date description: Data da transferência de empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wageTypeTable: description: Tabela de eventos type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição x-i18n: true deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. wageType: description: Eventos type: object required: – code – shortName – wageTypeTable properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código shortName: type: string maxLength: 30 description: Descrição reduzida x-i18n: true wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: shortName: type: string maxLength: 30 example: pt-BR: shortName: Exemplo de texto usando locale pt-BR. en-US: shortName: Text example using en-US locale. wageTypePayroll: description: Evento – Definições Gerais da Folha type: object required: – identificationType properties: id: type: string format: uuid description: Identificador único wageType: type: object allOf: – #/definitions/wageType description: Código do Evento identificationType: type: string allOf: – #/definitions/identificationType description: Tipo Evento payrollVacationWageType: type: object allOf: – #/definitions/wageType description: Evento de férias na folha characteristic: type: object allOf: – #/definitions/characteristics description: Característica rule: type: object allOf: – #/definitions/rules description: Regra deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: syndicate: description: Sindicato type: object required: – code properties: id: type: string format: uuid description: Identificador code: type: integer format: int64 description: Código name: type: string description: Razão social do sindicato abbreviation: type: string maxLength: 20 description: Sigla cnpj: type: string maxLength: 14 description: CNPJ entityCode: type: string maxLength: 20 description: Código da entidade deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: collectiveNegotiation: description: Negociação coletiva type: object required: – code – name properties: id: type: string format: uuid description: Identificador único syndicate: type: object allOf: – #/definitions/syndicate description: Sindicato code: type: integer format: int64 description: Código name: type: string description: Descrição deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: collectiveNegotiationHistory: description: Histórico de negociação coletiva type: object required: – startDate – startNightHours – endNightHours properties: id: type: string format: uuid description: Identificador único collectiveNegotiation: type: object allOf: – #/definitions/collectiveNegotiation description: Negociação coletiva startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Date Final startNightHours: type: integer format: int64 description: Início horas noturnas minimum: 0 maximum: 1440 endNightHours: type: integer format: int64 description: Fim horas noturnas minimum: 0 maximum: 1440 observation: type: string maxLength: 999 description: Observação deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: collectiveNegotiationHistoryVacation: description: Definições de férias type: object required: – illnessAidDays – daysPaidLeave properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistory: type: object allOf: – #/definitions/collectiveNegotiationHistory description: Histórico de negociação coletiva illnessAidDays: type: integer format: int64 description: Dias de auxílio-doença minimum: 1 maximum: 999 daysPaidLeave: type: integer format: int64 description: Dias de licença remunerada minimum: 1 maximum: 999 suspendConcessionPeriodDuringMaternityLeave: type: boolean description: Suspender período concessório durante licença maternidade default: false deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: disregardVacationDay: description: Desconsiderar dias de férias type: object required: – disregardedDay properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistoryVacation: type: object allOf: – #/definitions/collectiveNegotiationHistoryVacation description: Definições de férias disregardedDay: type: string format: date description: Dia desconsiderado deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employmentRelationshipStructure: description: Estrutura do vínculo empregatício type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string maxLength: 255 description: Descrição x-i18n: true deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. employmentRelationshipStructureCompanyHistory: description: Histórico de estrutura de vínculo da empresa type: object required: – company – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa employmentRelationshipStructure: type: object allOf: – #/definitions/employmentRelationshipStructure description: Estrutura do vínculo empregatício startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employmentRelationshipPayroll: description: Vínculo empregatício – Definições da Folha type: object required: – activityNatureType – calculatePayroll – thirteenSalary – createVacationPeriod – calculationByInssTaxRange properties: id: type: string format: uuid description: Identificador único employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo activityNatureType: type: string allOf: – #/definitions/activityNatureType description: Natureza da atividade calculatePayroll: type: boolean description: Calcula folha thirteenSalary: type: boolean description: Recebe 13º createVacationPeriod: type: boolean description: Cria período férias calculationByInssTaxRange: type: boolean description: Cálculo pelas faixas de INSS percentageInssTax: type: number format: double description: Percentual de contribuição INSS maximum: 99.99 welfarePolicyType: type: string allOf: – #/definitions/welfarePolicyType description: Tipo de regime previdenciário do colaborador deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eSocialCategory: description: Categorias eSocial type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string maxLength: 300 description: Descrição deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situation: description: Situação type: object required: – code – name – situationType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome x-i18n: true situationType: type: string allOf: – #/definitions/situationType description: Tipo da situação justifiedDaySituation: type: object allOf: – #/definitions/situation description: Situação dias justificados deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. situationStructure: description: Estrutura de situação type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string maxLength: 255 description: Nome x-i18n: true deleted: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. situationStructureCompanyHistory: description: Histórico de estrutura de situação da empresa type: object required: – company – situationStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleted: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: characteristics: description: Características dos eventos da folha type: object required: – description – characteristicType properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição x-i18n: true characteristicType: type: string allOf: – #/definitions/characteristicType description: Característica XTCharacteristicCode: type: string maxLength: 4 description: Característica na XT deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: description: type: string example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. rules: description: Regras dos eventos da folha type: object required: – description – ruleType properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição x-i18n: true ruleType: type: string allOf: – #/definitions/ruleType description: Regra XTRuleCode: type: string maxLength: 4 description: Regra na XT deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: description: type: string example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. situationPayroll: description: Situação – Definição da folha type: object required: – situation – startDate – demonstrateRegistrationForm properties: id: type: string format: uuid description: Identificador único situation: type: object allOf: – #/definitions/situation description: Código da situação startDate: type: string format: date description: Competência inicial endDate: type: string format: date description: Competência final calculationMonthlyPaidWorkerDayType: type: string allOf: – #/definitions/calculationMonthlyPaidWorkerDayType description: Cálculo dia mensalista losesDsr: type: boolean description: Perde DSR default: false losesHoliday: type: boolean description: Perde feriado default: false demonstrateRegistrationForm: type: boolean description: Demonstra na ficha registro calculationHourlyCommissionedPaidWorkerDayType: type: string allOf: – #/definitions/calculationHourlyCommissionedPaidWorkerDayType description: Cálculo dia horista e comissionado vacationInfluenceType: type: string allOf: – #/definitions/vacationInfluenceType description: Influência férias paysThirteenthSalary: type: boolean description: Paga 13º salário default: false positiveAdjustmentMonthlyPaidWorker: type: boolean description: Ajustar horas mensalistas se positivo default: false negativeAdjustmentMonthlyPaidWorker: type: boolean description: Ajustar horas mensalistas se negativo default: true losesSalaryAdvance: type: boolean description: Perde adiantamento salarial default: false serviceTime: type: boolean description: Tempo de serviço default: false deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeDependent: description: Dependente do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dependent: type: object allOf: – #/definitions/e001pes description: Dependente deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeSnapshot: description: Históricos correntes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador company: type: string format: uuid description: Empresa corrente do colaborador companyCode: type: integer format: int64 description: Código da empresa corrente do colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador companyBranchName: type: string description: Nome da filial employmentRelationship: type: string format: uuid description: Vínculo empregatício corrente do colaborador employmentRelationshipCode: type: string description: Código do vínculo empregatício corrente do colaborador employmentRelationshipContractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato vínculo empregatício corrente do colaborador jobPosition: type: string format: uuid description: Cargo corrente do colaborador jobPositionCode: type: integer format: int64 description: Código do cargo corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador positionCode: type: integer format: int64 description: Código da posição corrente do colaborador salaryHistorySalaryType: type: string allOf: – #/definitions/salaryType description: Tipo de salário corrente do colaborador syndicate: type: string format: uuid description: Sindicato corrente do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato corrente do colaborador workshift: type: string format: uuid description: Escala corrente do colaborador workshiftCode: type: integer format: int64 description: Código da escala corrente do colaborador workshiftTimeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno do horário corrente do colaborador workshiftGroup: type: string format: uuid description: Turma da escala corrente do colaborador workshiftGroupCode: type: integer format: int64 description: Código da turma da escala corrente do colaborador costCenter: type: string format: uuid description: Centro de custo corrente do colaborador costCenterCode: type: string maxLength: 9 description: Código do centro de custo corrente do colaborador location: type: string format: uuid description: Local corrente do colaborador locationCode: type: integer format: int64 description: Código do local corrente do colaborador deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyIndications: description: Assinalamentos da empresa type: object properties: id: type: string format: uuid description: Identificador único wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos company: type: object allOf: – #/definitions/e070emp description: Empresa deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Módulos do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – codFil – nomFil properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e044ccu: description: Centro de Custo type: object required: – codCcu – desCcu properties: id: type: string format: uuid description: Id da entidade codCcu: type: string maxLength: 9 description: Código do centro de custos desCcu: type: string maxLength: 250 description: Descrição do centro de custos e070emp: type: object allOf: – #/definitions/e070emp description: Empresa anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético excluido: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: generateVacationDataProcessControl: description: Controle do processo de geração de dados de férias type: object required: – processId – company – competence – status – totalBatches – completedBatches properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo company: type: object allOf: – #/definitions/e070emp description: Empresa competence: type: string format: date description: Competência sendo processada status: type: string allOf: – #/definitions/processStatusType description: Status do processo totalBatches: type: integer format: int64 description: Total de lotes na competência completedBatches: type: integer format: int64 description: Lotes concluídos startedAt: type: string format: date-time description: Início do processamento completedAt: type: string format: date-time description: Fim do processamento errorMessage: type: string maxLength: 500 description: Mensagem de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e030ban: description: Banco type: object properties: id: type: string format: uuid description: Id da entidade codBan: type: string maxLength: 3 description: Código nomBan: type: string maxLength: 100 description: Nome do banco excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e030age: description: Agência type: object properties: id: type: string format: uuid description: Id da entidade codAge: type: string maxLength: 7 description: Código digAge: type: string maxLength: 2 description: Dígito verificador nomAge: type: string maxLength: 30 description: Nome da agência excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e034tcc: description: Tipo de Conta Corrente type: object properties: id: type: string format: uuid description: Id da entidade codTcc: type: string maxLength: 3 description: Código desTcc: type: string maxLength: 30 description: Descrição excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e600cco: description: Conta Interna type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070filProprietario: type: object allOf: – #/definitions/e070fil description: Filial proprietária e030ban: type: object allOf: – #/definitions/e030ban description: Banco e034tcc: type: object allOf: – #/definitions/e034tcc description: Tipo de conta corrente e030age: type: object allOf: – #/definitions/e030age description: Agência numCco: type: string maxLength: 14 description: Conta interna numCta: type: string maxLength: 20 description: Número da conta digCta: type: string maxLength: 5 description: Dígito verificador sitCco: type: string allOf: – #/definitions/enumSitReg description: Situação datIni: type: string format: date description: Data inicial de vigência excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: bankIntegrationAccountConfig: description: Configuração de conta de integração bancária type: object properties: id: type: string format: uuid description: Identificador único internalAccount: type: object allOf: – #/definitions/e600cco description: Conta interna company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial covenantCode: type: string maxLength: 20 description: Código do convênio usesErpBanking: type: boolean description: Indica se usa ERP Banking integrateThirdParty: type: boolean description: Indica se integra terceiros bankIntegrationPaymentOrigin: type: array items: type: object allOf: – #/definitions/bankIntegrationPaymentOrigin description: Origens de pagamento deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: bankIntegrationPaymentOrigin: description: Origem de pagamento da integração bancária type: object properties: id: type: string format: uuid description: Identificador único bankIntegrationAccountConfig: type: object allOf: – #/definitions/bankIntegrationAccountConfig description: Configuração de conta de integração bancária calculationType: type: string maxLength: 255 description: Tipo de cálculo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação