• 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_dismissal (HCM - Payroll Dismissal General Processor)/HCM – Payroll Dismissal General (general)
Mais pesquisados:Customização, Tutorial, Documentação

HCM – Payroll Dismissal General (general)

99 views 0 22/09/2025 Atualizado em 11/11/2026 integrador

2.0info: 6.25.0 HCM – Payroll Dismissal General description: HCM – Payroll Dismissal General x-senior-domain: HCM – Payroll Dismissal General x-senior-domain-path: hcm_payroll_dismissal 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_dismissalsecurityDefinitions: 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/dismissalScheduleLookup: post: description: Primitiva para a consulta de dados das Programações de rescisão (dismissalSchedule) usados em campos lookup 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 a consulta de dados das Programações de rescisão (dismissalSchedule) usados em campos lookup 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/dismissalRegisterLookup: post: description: Primitiva para a consulta de dados dos Demonstrativos de rescisão (dismissalRegister) usados em campos lookup 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 a consulta de dados dos Demonstrativos de rescisão (dismissalRegister) usados em campos lookup 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/acquisitivePeriodLookup: post: description: Primitiva para a consulta de dados dos Resumos de período aquisitivo (employeeAcquisitivePeriodResume) usados em campos lookup 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 a consulta de dados dos Resumos de período aquisitivo (employeeAcquisitivePeriodResume) usados em campos lookup 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/wageTypeLookup: post: description: Primitiva para a consulta de dados dos Eventos (wageType) usados em campos lookup 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 a consulta de dados dos Eventos (wageType) usados em campos lookup 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/getDismissalSchedulePriorNoticeProjection: post: description: Calcula a projeção da programação de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – dismissalDate – causeDismissal properties: employee: type: string maxLength: 36 description: Identificador do colaborador dismissalDate: type: string format: date description: Data de demissão priorNoticeDate: type: string format: date description: Data do aviso causeDismissal: type: string maxLength: 36 description: Causa da demissão stability: type: integer format: int64 description: Estabilidade responses: 200: description: Ok schema: type: object required: – priorNoticeNotFullfilled – priorNoticeNotFullfilledAddition – priorNoticeCompensated – priorNoticeCompensatedAddition – endDatePriorNoticeProjection – stability properties: priorNoticeNotFullfilled: type: integer format: int64 description: Aviso reavido priorNoticeNotFullfilledAddition: type: integer format: int64 description: Acréscimo de aviso reavido priorNoticeCompensated: type: number format: double description: Aviso indenizado priorNoticeCompensatedAddition: type: number format: double description: Acréscimo de aviso indenizado endDatePriorNoticeProjection: type: string format: date description: Data projetada para o término do aviso stability: type: integer format: int64 description: Estabilidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Calcula a projeção da programação de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Identificador do colaborador in: query required: true type: string maxLength: 36 – name: dismissalDate description: Data de demissão in: query required: true type: string format: date – name: priorNoticeDate description: Data do aviso in: query type: string format: date – name: causeDismissal description: Causa da demissão in: query required: true type: string maxLength: 36 – name: stability description: Estabilidade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – priorNoticeNotFullfilled – priorNoticeNotFullfilledAddition – priorNoticeCompensated – priorNoticeCompensatedAddition – endDatePriorNoticeProjection – stability properties: priorNoticeNotFullfilled: type: integer format: int64 description: Aviso reavido priorNoticeNotFullfilledAddition: type: integer format: int64 description: Acréscimo de aviso reavido priorNoticeCompensated: type: number format: double description: Aviso indenizado priorNoticeCompensatedAddition: type: number format: double description: Acréscimo de aviso indenizado endDatePriorNoticeProjection: type: string format: date description: Data projetada para o término do aviso stability: type: integer format: int64 description: Estabilidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getDismissalScheduleEndContractDateEndEarly: post: description: Obtém os atributos data final do contrato e final antecipado da entidade programação de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – dismissalDate – causeDismissalId properties: employeeId: type: string maxLength: 36 description: Identificador do colaborador dismissalDate: type: string format: date description: Data de demissão causeDismissalId: type: string maxLength: 36 description: Identificador da causa de demissão responses: 200: description: Ok schema: type: object required: – endContractDate – endEarly – anticipatedEndContractDaysType properties: endContractDate: type: string format: date description: Data final do contrato endEarly: type: integer format: int64 description: Final antecipado anticipatedEndContractDaysType: type: string allOf: – #/definitions/anticipatedEndContractDaysType description: Dias do fim de contrato antecipado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os atributos data final do contrato e final antecipado da entidade programação de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador do colaborador in: query required: true type: string maxLength: 36 – name: dismissalDate description: Data de demissão in: query required: true type: string format: date – name: causeDismissalId description: Identificador da causa de demissão in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – endContractDate – endEarly – anticipatedEndContractDaysType properties: endContractDate: type: string format: date description: Data final do contrato endEarly: type: integer format: int64 description: Final antecipado anticipatedEndContractDaysType: type: string allOf: – #/definitions/anticipatedEndContractDaysType description: Dias do fim de contrato antecipado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listCauseDismissalCustom: post: description: Primitiva que realiza a busca customizada das causas de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dismissalDate: type: string format: date description: Data de rescisão filter: type: object allOf: – #/definitions/listCauseDismissalCustomFilter description: Filtro da listagem 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/ordinationCauseDismissal description: Ordenação. Caso não seja informada, ordenada pelo código. responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/causeDismissalCustomDTO minimum: 1 description: Causas de rescisão 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/getDismissalRegisterInformation: post: description: Informações gerais do demonstrativo de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalScheduleId properties: dismissalScheduleId: type: string maxLength: 36 description: Identificador único da programação de rescisão responses: 200: description: Ok schema: type: object required: – salary – totalIncome – totalDiscount – netValue – fgtsBasis – fgtsBasisThirteenth – inssBasis – inssBasisThirteenth – irrfBalance – irrfBasisThirteenth – irrfBasisVacation – fgtsCompensatedBasis – fgtsThirteenthCompensatedBasis – processId – dismissalRegisterId – dependentsIRRF – dependentsSalaryFamily – imported properties: salary: type: string description: Salário base totalIncome: type: string description: Total de proventos totalDiscount: type: string description: Total de descontos netValue: type: string description: Total líquido fgtsBasis: type: string description: Base do FGTS fgtsBasisThirteenth: type: string description: Base do FGTS de 13º salário inssBasis: type: string description: Base do INSS inssBasisThirteenth: type: string description: Base do INSS de 13º salário irrfBalance: type: string description: Base de saldo de IRRF irrfBasisThirteenth: type: string description: Base do IRRF de 13º salário irrfBasisVacation: type: string description: Base do IRRF de férias fgtsCompensatedBasis: type: string description: Base FGTS indenizado fgtsThirteenthCompensatedBasis: type: string description: Base FGTS de 13º salário indenizado processId: type: string description: Identificador do processo dismissalRegisterId: type: string description: Demonstrativo de rescisão dependentsIRRF: type: integer format: int64 description: Número de dependentes para IRRF dependentsSalaryFamily: type: integer format: int64 description: Número de dependentes para salário família imported: type: boolean description: Registro importado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Informações gerais do demonstrativo de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalScheduleId description: Identificador único da programação de rescisão in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – salary – totalIncome – totalDiscount – netValue – fgtsBasis – fgtsBasisThirteenth – inssBasis – inssBasisThirteenth – irrfBalance – irrfBasisThirteenth – irrfBasisVacation – fgtsCompensatedBasis – fgtsThirteenthCompensatedBasis – processId – dismissalRegisterId – dependentsIRRF – dependentsSalaryFamily – imported properties: salary: type: string description: Salário base totalIncome: type: string description: Total de proventos totalDiscount: type: string description: Total de descontos netValue: type: string description: Total líquido fgtsBasis: type: string description: Base do FGTS fgtsBasisThirteenth: type: string description: Base do FGTS de 13º salário inssBasis: type: string description: Base do INSS inssBasisThirteenth: type: string description: Base do INSS de 13º salário irrfBalance: type: string description: Base de saldo de IRRF irrfBasisThirteenth: type: string description: Base do IRRF de 13º salário irrfBasisVacation: type: string description: Base do IRRF de férias fgtsCompensatedBasis: type: string description: Base FGTS indenizado fgtsThirteenthCompensatedBasis: type: string description: Base FGTS de 13º salário indenizado processId: type: string description: Identificador do processo dismissalRegisterId: type: string description: Demonstrativo de rescisão dependentsIRRF: type: integer format: int64 description: Número de dependentes para IRRF dependentsSalaryFamily: type: integer format: int64 description: Número de dependentes para salário família imported: type: boolean description: Registro importado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listDismissalRegisterDetailInformation: post: description: Informações dos detalhes do demonstrativo de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalScheduleId properties: dismissalScheduleId: type: string maxLength: 36 description: Identificador único da programação de rescisão orderBy: type: object allOf: – #/definitions/dismissalRegisterDetailOrder description: Ordenação dos eventos 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 dismissalCalculationType: type: string allOf: – #/definitions/dismissalCalculationType description: Tipo de cálculo de rescisão responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: dismissalRegisterDetailInformation: type: array items: type: object allOf: – #/definitions/dismissalRegisterDetailInformation description: Informações dos eventos calculados de rescisão employeeAcquisitivePeriodInformation: type: array items: type: object allOf: – #/definitions/employeeAcquisitivePeriodInformation description: Informações dos períodos aquisitivos 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/listDismissalRegisterDetailApiTest: post: description: Lista os eventos calculados de um demonstrativo de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – dismissalDate properties: employee: type: string maxLength: 36 description: Colaborador dismissalDate: type: string format: date description: Data da rescisão dismissalScheduleType: type: string allOf: – #/definitions/dismissalScheduleType description: Tipo de rescisão (NORMAL se não informado) responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/dismissalRegisterWageTypeDTO minimum: 1 description: Eventos calculados do demonstrativo de rescisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os eventos calculados de um demonstrativo de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: dismissalDate description: Data da rescisão in: query required: true type: string format: date – name: dismissalScheduleType description: Tipo de rescisão (NORMAL se não informado) in: query type: string allOf: – #/definitions/dismissalScheduleType responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/dismissalRegisterWageTypeDTO minimum: 1 description: Eventos calculados do demonstrativo de rescisão 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/isValidForCompanyTransfer: post: description: Valida se é possível realizar a transferência de empresa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Resultado da validação message: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Valida se é possível realizar a transferência de empresa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Resultado da validação message: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getTheLastEmployeeReintegrationEffectiveDate: post: description: Obtém a última data efetiva de reintegração do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 200: description: Ok schema: type: object properties: effectiveDate: type: string format: date description: Data efetiva da última reintegração do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a última data efetiva de reintegração do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object properties: effectiveDate: type: string format: date description: Data efetiva da última reintegração do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getESocialDismissalTypeByCauseDismissalAndDate: post: description: Retorna o tipo de desligamento eSocial ativo para uma causa de rescisão em uma data de referência, utilizado para determinar a obrigatoriedade do campo dismissalPaymentInCaseOfDeath. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – causeDismissalId – referenceDate properties: causeDismissalId: type: string maxLength: 36 description: Identificador da causa de rescisão referenceDate: type: string format: date description: Data de referência responses: 200: description: Ok schema: type: object properties: eSocialDismissalType: type: string allOf: – #/definitions/eSocialDismissalType description: Tipo de desligamento eSocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o tipo de desligamento eSocial ativo para uma causa de rescisão em uma data de referência, utilizado para determinar a obrigatoriedade do campo dismissalPaymentInCaseOfDeath. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: causeDismissalId description: Identificador da causa de rescisão in: query required: true type: string maxLength: 36 – name: referenceDate description: Data de referência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object properties: eSocialDismissalType: type: string allOf: – #/definitions/eSocialDismissalType description: Tipo de desligamento eSocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listYearlyThirteenthSalaryValues: post: description: Obtém informações referentes aos valores de eventos de décimo terceiro do colaborador no ano agrupando por competência e característica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – year properties: size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 100 default: 12 offset: type: integer format: int64 description: Número da Página minimum: 0 default: 0 naturalOrder: type: boolean description: Ordenação natural default: true employee: type: string maxLength: 36 description: Colaborador year: type: integer format: int64 description: Ano minimum: 1 maximum: 9999 responses: 200: description: Ok schema: type: object required: – competences – totalElements – totalPages properties: competences: type: array items: type: object allOf: – #/definitions/yearlyThirteenthSalaryCompetence minimum: 1 description: Competências 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 get: description: Obtém informações referentes aos valores de eventos de décimo terceiro do colaborador no ano agrupando por competência e característica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Tamanho da página in: query type: integer format: int64 – name: offset description: Número da Página in: query type: integer format: int64 – name: naturalOrder description: Ordenação natural in: query type: boolean – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: year description: Ano in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – competences – totalElements – totalPages properties: competences: type: array items: type: object allOf: – #/definitions/yearlyThirteenthSalaryCompetence minimum: 1 description: Competências 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/getTheNextDismissalScheduleComplementarySequence: post: description: Obtém a próxima sequência para a programação de rescisão do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – paymentDate properties: employee: type: string maxLength: 36 description: Colaborador paymentDate: type: string format: date description: Data de pagamento responses: 200: description: Ok schema: type: object required: – sequence properties: sequence: type: integer format: int64 description: Próxima sequência para a programação de rescisão do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a próxima sequência para a programação de rescisão do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: paymentDate description: Data de pagamento in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – sequence properties: sequence: type: integer format: int64 description: Próxima sequência para a programação de rescisão do colaborador 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 rescisão 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/dismissalPaymentTitleIntegrationEligibilityDTO 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/dismissalPaymentTitleSidebarPaymentDTO description: Dados do pagamento bankAccount: type: object allOf: – #/definitions/dismissalPaymentTitleSidebarBankAccountDTO 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/dismissalPaymentTitleSidebarStatusHistoryDTO 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/dismissalPaymentTitleSidebarPaymentDTO description: Dados do pagamento bankAccount: type: object allOf: – #/definitions/dismissalPaymentTitleSidebarBankAccountDTO 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/dismissalPaymentTitleSidebarStatusHistoryDTO 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/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/exportCauseDismissalHistory: 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/exportDismissalSchedule: 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/exportCalculationDefinition: 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/exportVariableEntryComplementaryDismissal: 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/exportDismissalEmployeeDependentAlimonyHistory: 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/exportDismissalEmployeeDependentAlimonyPayeeHistory: 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/exportDismissalWageType: 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/exportDismissalRegister: 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/exportDismissalRegisterDetail: 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/exportEmployeeAcquisitivePeriodResume: 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/exportDismissalSyndicateContributionInformation: 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/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/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/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/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/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/exportCollectiveNegotiationDismissal: 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/exportCollectiveNegotiationPriorNoticed: 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/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/exportDismissalReasonESocial: 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/exportCauseDismissal: 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/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/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/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/exportContributionType: 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/exportHealthPlan: 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/exportDismissalHealthPlanCalculation: 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/exportComplementaryPensionDismissalCalculation: 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/exportDismissalPaymentTitle: 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/exportDismissalPaymentTitleStatusHistory: 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/exportAccountingClassificationCode: 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/deleteDismissalCalculation: post: description: Realiza o processo de exclusão das informações de rescisão geradas pelo cálculo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalScheduleId properties: dismissalScheduleId: type: string maxLength: 36 description: Identificador único da programação de rescisão responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteDismissalCalculationBatch: post: description: Realiza o processo de exclusão em lote das informações de rescisão geradas pelo cálculo. 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 identificadores únicos dos colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/saveDismissalRegisterDetailFgtsFine: post: description: Realiza o lançamento do evento de multa FGTS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRegister – wageType – value properties: dismissalRegister: type: string maxLength: 36 description: Demonstrativo de rescisão wageType: type: string maxLength: 36 description: Evento value: type: string description: Valor responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteDismissalRegisterDetailFgtsFine: post: description: Realizar a exclusão do evento de multa FGTS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRegisterId properties: dismissalRegisterId: type: string maxLength: 36 description: Id do registro que será excluído responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/saveVariableEntriesComplementaryDismissal: post: description: Salva os lançamentos variáveis informados na tela de programação de rescisão complementar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalScheduleId properties: dismissalScheduleId: type: string description: Identificador único da programação de rescisão variableEntriesComplementaryDismissal: type: array items: type: object allOf: – #/definitions/variableEntryComplementaryDismissalSaveDto description: Dto com as informaçoes dos lançamentos variáveis da rescisão complementar responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da operação 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/integrateBankPayments: post: description: Integração dos títulos de pagamento de rescisão 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/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/importCauseDismissalHistory: 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/importDismissalSchedule: 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/importCalculationDefinition: 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/importVariableEntryComplementaryDismissal: 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/importDismissalEmployeeDependentAlimonyHistory: 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/importDismissalEmployeeDependentAlimonyPayeeHistory: 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/importDismissalWageType: 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/importDismissalRegister: 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/importDismissalRegisterDetail: 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/importEmployeeAcquisitivePeriodResume: 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/importDismissalSyndicateContributionInformation: 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/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/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/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/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/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/importCollectiveNegotiationDismissal: 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/importCollectiveNegotiationPriorNoticed: 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/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/importDismissalReasonESocial: 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/importCauseDismissal: 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/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/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/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/importContributionType: 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/importHealthPlan: 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/importDismissalHealthPlanCalculation: 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/importComplementaryPensionDismissalCalculation: 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/importDismissalPaymentTitle: 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/importDismissalPaymentTitleStatusHistory: 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/actions/importAccountingClassificationCode: 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/dismissalRegisterSave: post: description: Salva as informações do demonstrativo de 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/dismissalSaveRollback: post: description: Desfaz o salvamento das informações de rescisão 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/integrateBankPaymentsBatchItem: post: description: Integração dos títulos de pagamento de rescisão 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/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/events/dismissalRegisterSaved: post: description: Notifica que a gravação das informações do demonstrativo de rescisão 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 maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string description: Tipo de cálculo hasError: type: boolean description: Indica se houve erro na geração do demonstrativo de rescisão default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/dismissalCalculationDeleted: post: description: Sinaliza a finalização da exclusão do cálculo de rescisão x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dismissalType – dismissals properties: dismissalType: type: string description: Tipo de rescisão dismissals: type: array items: type: object allOf: – #/definitions/dismissalDeletedData minimum: 1 description: Dados das rescisões com cálculos excluídos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCauseDismissalHistoryEvent: 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/exportCauseDismissalHistoryEvent: 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/importDismissalScheduleEvent: 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/exportDismissalScheduleEvent: 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/importCalculationDefinitionEvent: 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/exportCalculationDefinitionEvent: 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/importVariableEntryComplementaryDismissalEvent: 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/exportVariableEntryComplementaryDismissalEvent: 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/importDismissalEmployeeDependentAlimonyHistoryEvent: 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/exportDismissalEmployeeDependentAlimonyHistoryEvent: 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/importDismissalEmployeeDependentAlimonyPayeeHistoryEvent: 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/exportDismissalEmployeeDependentAlimonyPayeeHistoryEvent: 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/importDismissalWageTypeEvent: 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/exportDismissalWageTypeEvent: 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/importDismissalRegisterEvent: 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/exportDismissalRegisterEvent: 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/importDismissalRegisterDetailEvent: 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/exportDismissalRegisterDetailEvent: 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/importEmployeeAcquisitivePeriodResumeEvent: 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/exportEmployeeAcquisitivePeriodResumeEvent: 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/importDismissalSyndicateContributionInformationEvent: 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/exportDismissalSyndicateContributionInformationEvent: 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/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/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/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/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/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/importCollectiveNegotiationDismissalEvent: 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/exportCollectiveNegotiationDismissalEvent: 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/importCollectiveNegotiationPriorNoticedEvent: 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/exportCollectiveNegotiationPriorNoticedEvent: 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/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/importDismissalReasonESocialEvent: 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/exportDismissalReasonESocialEvent: 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/importCauseDismissalEvent: 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/exportCauseDismissalEvent: 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/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/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/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/importContributionTypeEvent: 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/exportContributionTypeEvent: 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/importHealthPlanEvent: 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/exportHealthPlanEvent: 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/importDismissalHealthPlanCalculationEvent: 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/exportDismissalHealthPlanCalculationEvent: 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/importComplementaryPensionDismissalCalculationEvent: 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/exportComplementaryPensionDismissalCalculationEvent: 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/importDismissalPaymentTitleEvent: 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/exportDismissalPaymentTitleEvent: 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/importDismissalPaymentTitleStatusHistoryEvent: 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/exportDismissalPaymentTitleStatusHistoryEvent: 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/events/importAccountingClassificationCodeEvent: 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/exportAccountingClassificationCodeEvent: 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/causeDismissalHistory: 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/causeDismissalHistory responses: 200: description: The created resource schema: #/definitions/causeDismissalHistory 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/causeDismissalHistory responses: 200: description: The created resource schema: #/definitions/causeDismissalHistory 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/causeDismissalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/causeDismissalHistory/{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/editCauseDismissalHistory responses: 200: description: Ok schema: #/definitions/editCauseDismissalHistory 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/causeDismissalHistory responses: 200: description: Ok schema: #/definitions/causeDismissalHistory 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/causeDismissalHistory 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/causeDismissalHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/causeDismissalHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalSchedule: 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/dismissalSchedule responses: 200: description: The created resource schema: #/definitions/dismissalSchedule 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/dismissalSchedule responses: 200: description: The created resource schema: #/definitions/dismissalSchedule 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/dismissalSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalSchedule/{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/editDismissalSchedule responses: 200: description: Ok schema: #/definitions/editDismissalSchedule 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/dismissalSchedule responses: 200: description: Ok schema: #/definitions/dismissalSchedule 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/dismissalSchedule 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/dismissalSchedule/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalSchedule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntryComplementaryDismissal: 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/variableEntryComplementaryDismissal responses: 200: description: The created resource schema: #/definitions/variableEntryComplementaryDismissal 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/variableEntryComplementaryDismissal responses: 200: description: The created resource schema: #/definitions/variableEntryComplementaryDismissal 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/variableEntryComplementaryDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntryComplementaryDismissal/{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/editVariableEntryComplementaryDismissal responses: 200: description: Ok schema: #/definitions/editVariableEntryComplementaryDismissal 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/variableEntryComplementaryDismissal responses: 200: description: Ok schema: #/definitions/variableEntryComplementaryDismissal 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/variableEntryComplementaryDismissal 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/variableEntryComplementaryDismissal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variableEntryComplementaryDismissal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalEmployeeDependentAlimonyHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dismissalEmployeeDependentAlimonyHistory responses: 200: description: The created resource schema: #/definitions/dismissalEmployeeDependentAlimonyHistory 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/dismissalEmployeeDependentAlimonyHistory responses: 200: description: The created resource schema: #/definitions/dismissalEmployeeDependentAlimonyHistory 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/dismissalEmployeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalEmployeeDependentAlimonyHistory/{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/editDismissalEmployeeDependentAlimonyHistory responses: 200: description: Ok schema: #/definitions/editDismissalEmployeeDependentAlimonyHistory 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/dismissalEmployeeDependentAlimonyHistory responses: 200: description: Ok schema: #/definitions/dismissalEmployeeDependentAlimonyHistory 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/dismissalEmployeeDependentAlimonyHistory 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/dismissalEmployeeDependentAlimonyHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalEmployeeDependentAlimonyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalWageType: 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/dismissalWageType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalRegister: 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/dismissalRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalRegisterDetail: 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/dismissalRegisterDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeAcquisitivePeriodResume: 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/employeeAcquisitivePeriodResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalSyndicateContributionInformation: 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/dismissalSyndicateContributionInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalHealthPlanCalculation: 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/dismissalHealthPlanCalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/complementaryPensionDismissalCalculation: 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/complementaryPensionDismissalCalculation responses: 200: description: The created resource schema: #/definitions/complementaryPensionDismissalCalculation 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/complementaryPensionDismissalCalculation responses: 200: description: The created resource schema: #/definitions/complementaryPensionDismissalCalculation 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/complementaryPensionDismissalCalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/complementaryPensionDismissalCalculation/{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/editComplementaryPensionDismissalCalculation responses: 200: description: Ok schema: #/definitions/editComplementaryPensionDismissalCalculation 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/complementaryPensionDismissalCalculation responses: 200: description: Ok schema: #/definitions/complementaryPensionDismissalCalculation 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/complementaryPensionDismissalCalculation 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/complementaryPensionDismissalCalculation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/complementaryPensionDismissalCalculation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/dismissalPaymentTitle: 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/dismissalPaymentTitle 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 enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo noticeDateType: type: string enum: – ALLOWS_INFORMED – NOT_ALLOWS_INFORMED – ASSUMES_DISMISSAL_DATE description: Data de aviso: * `ALLOWS_INFORMED` – Permite informar * `NOT_ALLOWS_INFORMED` – Não permite informar * `ASSUMES_DISMISSAL_DATE` – Assume a data de demissão paymentCompensatedDaysType: type: string enum: – NO_PAYMENT – YES_PAYMENT_THIRTY_DAYS – PAYMENT_DIVIDED_EMPLOYEE_COMPANY description: Pagar dias indenizados: * `NO_PAYMENT` – Não há pagamento * `YES_PAYMENT_THIRTY_DAYS` – Dias de direito (trinta dias mais acréscimo) * `PAYMENT_DIVIDED_EMPLOYEE_COMPANY` – Metade dos dias de direito (acordo mútuo) paymentNotFullfilledDaysType: type: string enum: – NO_PAYMENT – YES_PAYMENT_THIRTY_DAYS description: Pagar dias reavidos: * `NO_PAYMENT` – Não há pagamento * `YES_PAYMENT_THIRTY_DAYS` – Dias de direito (trinta dias mais acréscimo) anticipatedEndContractDaysType: type: string enum: – NO_CONSIDERED – COMPANY – EMPLOYEE description: Dias do fim de contrato antecipado: * `NO_CONSIDERED` – Não considera * `COMPANY` – Empresa * `EMPLOYEE` – Colaborador anticipatedEndContractVacationThirteenthSalaryType: type: string enum: – NO_PROJECTION – PROJECT_UNTIL_END_CONTRACT – PROJECT_MIDDLE_DAYS_END_CONTRACT description: Avos do fim de contrato antecipado de férias e 13º salário: * `NO_PROJECTION` – Não projeta * `PROJECT_UNTIL_END_CONTRACT` – Projeta até o final do contrato * `PROJECT_MIDDLE_DAYS_END_CONTRACT` – Projeta metade dos dias até o final do contrato paymentThirteenthSalaryCompensatedType: type: string enum: – NO_PAYMENT – PAYMENT_ONLY_IF_RIGHT description: Pagar 13º salário indenizado: * `NO_PAYMENT` – Não há pagamento * `PAYMENT_ONLY_IF_RIGHT` – Pagamento somente se tiver direito paymentVacationProportionalAndCompensatedType: type: string enum: – ALWAYS_PAYMENT – NO_PAYMENT description: Pagar férias proporcionais/indenizadas: * `ALWAYS_PAYMENT` – Sempre há pagamento * `NO_PAYMENT` – Não há pagamento paymentCompensatedPreviousMonthBaseDateType: type: string enum: – YES_ADD_NOTICE_DAY – YES_WITHOUT_ADD_NOTICE_DAY – NO_PAYMENT description: Pagar indenizações no mês que antecede o dissídio: * `YES_ADD_NOTICE_DAY` – Sim, somando os dias de aviso * `YES_WITHOUT_ADD_NOTICE_DAY` – Sim, sem somar os dias de aviso * `NO_PAYMENT` – Não há pagamento deductionEarlyVacationType: type: string enum: – NO_DISCOUNT – DISCOUNT_WITH_HIRE_DATE – DISCOUNT_WITH_NOTICE_END_DATE description: Descontar férias antecipadas: * `NO_DISCOUNT` – Não há desconto * `DISCOUNT_WITH_HIRE_DATE` – Descontar com base na data de demissão * `DISCOUNT_WITH_NOTICE_END_DATE` – Descontar com base na data final do aviso salaryAfterDismissalType: type: string enum: – NOT_APPLICABLE – QUARANTINE – DISMISSAL_RECOGNIZED_BY_COURT description: Indicativo de remuneração após o desligamento: * `NOT_APPLICABLE` – Não se aplica * `QUARANTINE` – Quarentena * `DISMISSAL_RECOGNIZED_BY_COURT` – Desligamento/término reconhecido judicialmente com data anterior a competências com remunerações já informadas no eSocial statusType: type: string enum: – PROGRAMMED – CALCULATED description: Status: * `PROGRAMMED` – Programada * `CALCULATED` – Calculada periodType: type: string enum: – DAYS – MONTHS – NOT_APPLICABLE description: Tipo do período: * `DAYS` – Dias * `MONTHS` – Meses * `NOT_APPLICABLE` – Não se aplica eSocialDismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 description: Tipo de desligamento eSocial: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Rescisão com justa causa, por iniciativa do empregador * `V2` – 2 – Rescisão sem justa causa, por iniciativa do empregador * `V3` – 3 – Rescisão antecipada do contrato a termo por iniciativa do empregador * `V4` – 4 – Rescisão antecipada do contrato a termo por iniciativa do empregado * `V5` – 5 – Rescisão por culpa recíproca * `V6` – 6 – Rescisão por término do contrato a termo * `V7` – 7 – Rescisão do contrato de trabalho por iniciativa do empregado * `V8` – 8 – Rescisão do contrato de trabalho por interesse do(a) empregado(a), nas hipóteses previstas nos arts. 394 e 483, § 1º, da CLT * `V9` – 9 – Rescisão por opção do empregado em virtude de falecimento do empregador individual ou empregador doméstico * `V10` – 10 – Rescisão por falecimento do empregado * `V11` – 11 – Transferência de empregado para empresa do mesmo grupo empresarial que tenha assumido os encargos trabalhistas, sem que tenha havido rescisão do contrato de trabalho * `V12` – 12 – Transferência de empregado da empresa consorciada para o consórcio que tenha assumido os encargos trabalhistas, e vice-versa, sem que tenha havido rescisão do contrato de trabalho * `V13` – 13 – Transferência de empregado de empresa ou consórcio, para outra empresa ou consórcio que tenha assumido os encargos trabalhistas por motivo de sucessão (fusão, cisão ou incorporação), sem que tenha havido rescisão do contrato de trabalho * `V14` – 14 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades ou falecimento do empregador individual ou empregador doméstico sem continuação da atividade * `V15` – 15 – Rescisão do contrato de aprendizagem por desempenho insuficiente, inadaptação ou ausência injustificada do aprendiz à escola que implique perda do ano letivo (Válido até 18/07/2021) * `V16` – 16 – Declaração de nulidade do contrato de trabalho por infringência ao inciso II do art. 37 da Constituição Federal, quando mantido o direito ao salário * `V17` – 17 – Rescisão indireta do contrato de trabalho * `V18` – 18 – Aposentadoria compulsória (Válido até 18/07/2021) * `V19` – 19 – Aposentadoria por idade (Válido até 18/07/2021) * `V20` – 20 – Aposentadoria por idade e tempo de contribuição (Válido até 18/07/2021) * `V21` – 21 – Reforma militar * `V22` – 22 – Reserva militar * `V23` – 23 – Exoneração * `V24` – 24 – Demissão * `V25` – 25 – Vacância de cargo efetivo * `V26` – 26 – Rescisão do contrato de trabalho por paralisação temporária ou definitiva da empresa, estabelecimento ou parte das atividades motivada por atos de autoridade municipal, estadual ou federal * `V27` – 27 – Rescisão por motivo de força maior * `V28` – 28 – Término da cessão/requisição (Válido até 18/07/2021) * `V29` – 29 – Redistribuição * `V30` – 30 – Mudança de regime trabalhista * `V31` – 31 – Reversão de reintegração * `V32` – 32 – Extravio de militar * `V33` – 33 – Rescisão por acordo entre as partes (art. 484-A da CLT) * `V34` – 34 – Transferência de titularidade do empregado doméstico para outro representante da mesma unidade familiar * `V35` – 35 – Extinção do contrato de trabalho intermitente (Válido até 30/06/2018) * `V37` – 37 – Remoção, em caso de alteração do órgão declarante * `V38` – 38 – Aposentadoria, exceto por invalidez * `V39` – 39 – Aposentadoria de servidor estatutário, por invalidez * `V40` – 40 – Término do exercício do mandato eletivo * `V41` – 41 – Rescisão do contrato de aprendizagem por desempenho insuficiente ou inadaptação do aprendiz * `V42` – 42 – Rescisão do contrato de aprendizagem por ausência injustificada do aprendiz à escola que implique perda do ano letivo * `V43` – 43 – Transferência de empregado de empresa considerada inapta por inexistência de fato * `V44` – 44 – Agrupamento contratual * `V45` – 45 – Exclusão de militar das Forças Armadas do serviço ativo, com efeitos financeiros * `V46` – 46 – Exclusão de militar das Forças Armadas do serviço ativo, sem efeitos financeiros * `V47` – 47 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades * `V48` – 48 – Falecimento do empregador individual sem continuação da atividade * `V49` – 49 – Falecimento do empregador doméstico sem continuação da atividade dismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V99 description: Tipo de desligamento: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Exoneração do diretor não empregado sem justa causa, por deliberação da assembleia, dos sócios cotistas ou da autoridade competente * `V2` – 2 – Término de mandato do diretor não empregado que não tenha sido reconduzido ao cargo * `V3` – 3 – Exoneração a pedido de diretor não empregado * `V4` – 4 – Exoneração do diretor não empregado por culpa recíproca ou força maior * `V5` – 5 – Morte do diretor não empregado * `V6` – 6 – Exoneração do diretor não empregado por falência, encerramento ou supressão de parte da empresa * `V7` – 7 – Mudança de CPF * `V99` – 99 – Outros dismissalScheduleType: type: string enum: – NORMAL – COMPLEMENTARY description: Tipo de rescisão: * `NORMAL` – Normal * `COMPLEMENTARY` – Complementar 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 causeDismissalOrderType: type: string enum: – CODE – NAME description: Enumeração dos campos ordenáveis da causa de demissão: * `CODE` – Código * `NAME` – Nome orderType: type: string enum: – ASC – DESC description: Sentidos de ordenação: * `ASC` – Crescente * `DESC` – Decrescente dismissalCalculationType: type: string enum: – SUPPLEMENTARY_LABOR_AGREEMENT – SALARY_BALANCE – PRIOR_NOTICE_COMPENSATED – PRIOR_NOTICE_NOT_FULLFILLED – END_CONTRACT_ANTECIPATED_COMPANY – END_CONTRACT_ANTECIPATED_EMPLOYEE – PROFESSIONAL_QUALIFICATION_FINE – COMPENSATED_PREVIOUS_MONTH_BASE_DATE – STABILITY – THIRTEENTH_SALARY_PROPORTIONAL – THIRTEENTH_SALARY_COMPENSATED – VACATION_ACCRUED – VACATION_PROPORTIONAL – VACATION_COMPENSATED – FGTS_TERMINATION – TAXES – NET_VALUE_OVERFLOW – FGTS_FINE description: Tipo de cálculo de rescisão: * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SALARY_BALANCE` – Saldo de salário * `PRIOR_NOTICE_COMPENSATED` – Aviso prévio indenizado * `PRIOR_NOTICE_NOT_FULLFILLED` – Aviso Prévio Reavido * `END_CONTRACT_ANTECIPATED_COMPANY` – Fim contrato antecipado empresa * `END_CONTRACT_ANTECIPATED_EMPLOYEE` – Fim contrato antecipado empregado * `PROFESSIONAL_QUALIFICATION_FINE` – Multa qualificação profissional * `COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Indenização mês anterior data base * `STABILITY` – Estabilidade * `THIRTEENTH_SALARY_PROPORTIONAL` – 13º salário proporcional * `THIRTEENTH_SALARY_COMPENSATED` – 13º salário indenizado * `VACATION_ACCRUED` – Férias vencidas * `VACATION_PROPORTIONAL` – Férias proporcionais * `VACATION_COMPENSATED` – Férias indenizadas * `FGTS_TERMINATION` – FGTS da rescisão * `TAXES` – Impostos * `NET_VALUE_OVERFLOW` – Liquido / estouro * `FGTS_FINE` – Multa FGTS 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 identificationType: type: string enum: – SALARY_PROCEEDS_OR_ALLOWANCE – DEDUCTION – INFORMATIVE – DEDUCTIVE_INFORMATIVE description: Tipo de evento: * `SALARY_PROCEEDS_OR_ALLOWANCE` – Vencimento, provento ou pensão devida * `DEDUCTION` – Desconto * `INFORMATIVE` – Informativa * `DEDUCTIVE_INFORMATIVE` – Informativa dedutora dismissalRegisterDetailOrderFieldsType: type: string enum: – CODE – REFERENCE – VALUE description: Campos de ordenação de eventos de rescisão: * `CODE` – Código * `REFERENCE` – Referência. * `VALUE` – Valor 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 – OVERTIME_NIGHTTIME – ADDITIONAL_HOURS_ENTRY – 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 * `OVERTIME_NIGHTTIME` – Horas extras noturnas * `ADDITIONAL_HOURS_ENTRY` – Adicionais lançados em horas * `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 reasonComplementaryDismissalType: type: string enum: – ERROR_OR_OMISSION – OUTSTANDING_COMMISSIONS – COLLECTIVE_AGREEMENT description: Motivo da rescisão complementar: * `ERROR_OR_OMISSION` – Erro ou omissão * `OUTSTANDING_COMMISSIONS` – Comissões pendentes * `COLLECTIVE_AGREEMENT` – Dissídio coletivo formCorrectionType: type: string enum: – RETIFICATION – PAYMENT_DATE description: Forma de acerto: * `RETIFICATION` – Retificação * `PAYMENT_DATE` – Data de pagamento originType: type: string enum: – TYPED – IMPORTED – CLOCKINGEVENT description: Origem: * `TYPED` – Digitado * `IMPORTED` – Importado * `CLOCKINGEVENT` – Ponto alimonyCalculationType: type: string enum: – MONTH – VACATION – THIRTEENTH_SALARY description: Tipo de cálculo de pensão judicial na rescisão: * `MONTH` – Mensal * `VACATION` – Férias * `THIRTEENTH_SALARY` – 13º salário 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 fgtsPensionType: type: string enum: – NOT_APPLICABLE – PERCENTAGE – VALUE – PERCENTAGE_AND_VALUE description: Tipo de pensão de FGTS: * `NOT_APPLICABLE` – Não se aplica * `PERCENTAGE` – Percentual * `VALUE` – Valor * `PERCENTAGE_AND_VALUE` – Percentual e valor fgtsWithdrawalType: type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V10 – V23 – V26 – V27 – V88 description: Código de saque do FGTS: * `V01` – Despedida, pelo empregador, sem justa causa inclusive a indireta * `V02` – Rescisão do contrato de trabalho por culpa recíproca * `V03` – Rescisão do contrato de trabalho por extinção total da empresa * `V04` – Extinção normal do contrato de trabalho * `V05` – Aposentadoria, inclusive por invalidez * `V06` – Suspensão total do trabalho avulso por período = 90 dias * `V07` – Rescisão do contrato de trabalho por acordo entre trabalhador e empregador – Formalizada a partir de 11/11/2017 – Lei 13.467/2017 * `V10` – Rescisão contratual ou TRCT homologada de acordo com artigo 477 da CLT * `V23` – Falecimento do trabalhador, diretor não empregado ou trabalhador avulso * `V26` – Rescisão ou extinção do contrato de trabalho com tempo de serviço 16/09/2002 * `V27` – Rescisão do contrato de trabalho, motivo de acordo, com pagamento de indenização * `V88` – Determinação judicial enrollmentType: type: string enum: – HOLDER – DEPENDENT description: Tipo de vínculo: * `HOLDER` – Titular * `DEPENDENT` – Dependente detailCalculationType: type: string enum: – MONTHLY – VACATION – THIRTEENTH_SALARY description: Tipo de cálculo da previdência complementar: * `MONTHLY` – Mensal * `VACATION` – Férias * `THIRTEENTH_SALARY` – 13º salário dismissalPaymentInCaseOfDeathType: type: string enum: – EMPLOYEE – BENEFICIARY description: Tipo de pagamento em caso de falecimento do colaborador: * `EMPLOYEE` – Colaborador * `BENEFICIARY` – Beneficiário 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 listCauseDismissalCustomFilter: description: Filtro da listagem customizada de causas de rescisão type: object properties: code: type: integer format: int64 description: Código da causa de rescisão name: type: string description: Nome da causa de rescisão ordinationCauseDismissal: description: Ordenação da causa de rescisão type: object required: – field – order properties: field: type: string allOf: – #/definitions/causeDismissalOrderType description: Campo order: type: string allOf: – #/definitions/orderType description: Ordenação causeDismissalCustomDTO: description: Dados da causa de rescisão type: object required: – id – code – name properties: id: type: string description: Identificador da causa de rescisão code: type: integer format: int64 description: Código name: type: string description: Nome dismissalRegisterDetailInformation: description: Informações do evento calculado de rescisão type: object required: – wageTypeId – code – name – identificationType – dismissalCalculationType – employeeAcquisitivePeriodId – reference – value properties: wageTypeId: type: string maxLength: 36 description: Identificador do evento code: type: integer format: int64 description: Código do evento name: type: string description: Nome do evento identificationType: type: string allOf: – #/definitions/identificationType description: Tipo do evento dismissalCalculationType: type: string allOf: – #/definitions/dismissalCalculationType description: Tipo de cálculo de rescisão employeeAcquisitivePeriodId: type: string description: Identificador do período aquisitivo do colaborador reference: type: number format: double description: Referência value: type: string description: Valor employeeAcquisitivePeriodInformation: description: Informação do período aquisitivo type: object required: – id – startDate – endDate – vacationFractionDenominator – balanceDays properties: id: type: string description: Identificador único startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final vacationFractionDenominator: type: integer format: int64 description: Avos de férias balanceDays: type: number format: double description: Dias de saldo dismissalRegisterDetailOrder: description: Ordenação dos eventos type: object required: – field – order properties: field: type: string allOf: – #/definitions/dismissalRegisterDetailOrderFieldsType description: Campo do evento de rescisão order: type: string allOf: – #/definitions/orderType description: Direção de ordenação dismissalRegisterWageTypeDTO: description: Informações do evento calculado do demonstrativo de rescisão 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íodo aquisitivo processId: type: string maxLength: 36 description: Identificador único do processo variableEntryComplementaryDismissalSaveDto: description: Informações dos eventos variáveis lançados na tela de programação de rescisão complementar type: object required: – wageType – reference – value properties: id: type: string description: Identificador único wageType: type: string description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 99999.98 value: type: number format: double description: Valor minimum: 0.0 maximum: 999999999.99 yearlyThirteenthSalaryCompetence: description: DTO com informações referentes aos valores de eventos de décimo terceiro do colaborador no ano agrupados por competência type: object required: – competence – characteristics properties: competence: type: string format: date description: Competência characteristics: type: array items: type: object allOf: – #/definitions/yearlyThirteenthSalaryCharacteristic minimum: 1 description: Características yearlyThirteenthSalaryCharacteristic: description: DTO com informações referentes aos valores de eventos de décimo terceiro do colaborador no ano agrupados por característica type: object required: – characteristic – value properties: characteristic: type: string allOf: – #/definitions/characteristicType description: Característica value: type: string description: Valor dismissalDeletedData: description: Dados das rescisões com cálculos excluídos type: object required: – employee – dismissalDate – dismissalType – paymentDate properties: reasonComplementaryDismissalType: type: string description: Motivo da rescisão complementar employee: type: string description: Colaborador dismissalDate: type: string format: date description: Data de rescisão dismissalType: type: string description: Tipo de rescisão paymentDate: type: string format: date description: Data de pagamento laborAgreementCompetence: type: string format: date description: Competência do dissídio formCorrectionType: type: string description: Forma de acerto eSocialDismissalType: type: string description: Tipo de desligamento eSocial eSocialDirectorDismissalType: type: string description: Tipo de desligamento do eSocial para diretor não empregado dismissalPaymentInCaseOfDeathType: type: string description: Tipo de pagamento em caso de falecimento do colaborador 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 employeePayrollCalculationCompetenceInformationDto: description: Dto com informações da competência da folha de pagamento do dissídio e da rescisão para validação do cálculo da rescisão type: object required: – isPayrollCalculationOnDismissalCompetence – isPayrollCalculationPaymentDateAfterDismissalDate – calculationType properties: isPayrollCalculationOnDismissalCompetence: type: boolean description: Identifica se a competência da folha calculada é a mesma competência da rescisão isPayrollCalculationPaymentDateAfterDismissalDate: type: boolean description: Identifica se a data de pagamento da folha de pagamento do dissídio calculada é posterior a data de pagamento da rescisão calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo dismissalPaymentTitleIntegrationEligibilityDTO: description: Elegibilidade de um título de pagamento de rescisão 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 dismissalPaymentTitleSidebarPaymentDTO: 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 dismissalPaymentTitleSidebarBankAccountDTO: 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 dismissalPaymentTitleSidebarStatusHistoryDTO: 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 rescisão 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 causeDismissalHistory: description: Histórico de causas de demissão type: object required: – causeDismissal – competenceInitial – noticeDateType – paymentCompensatedDaysType – paymentNotFullfilledDaysType – anticipatedEndContractDaysType – paymentThirteenthSalaryCompensatedType – paymentVacationProportionalAndCompensatedType – paymentCompensatedPreviousMonthBaseDateType – deductionEarlyVacationType properties: id: type: string format: uuid description: Identificador único causeDismissal: type: object allOf: – #/definitions/causeDismissal description: Causa de demissão competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final generateEmployeeLayout: type: boolean description: Gerar leiaute Empregador Web default: false noticeDateType: type: string allOf: – #/definitions/noticeDateType description: Data de aviso paymentCompensatedDaysType: type: string allOf: – #/definitions/paymentCompensatedDaysType description: Pagar dias indenizados paymentNotFullfilledDaysType: type: string allOf: – #/definitions/paymentNotFullfilledDaysType description: Pagar dias reavidos checkStability: type: boolean description: Checar estabilidade default: false anticipatedEndContractDaysType: type: string allOf: – #/definitions/anticipatedEndContractDaysType description: Dias do fim de contrato antecipado anticipatedEndContractVacationThirteenthSalaryType: type: string allOf: – #/definitions/anticipatedEndContractVacationThirteenthSalaryType description: Avos do fim de contrato antecipado de férias e 13º salário paymentDismissalFGTS: type: boolean description: Pagar FGTS na rescisão default: false paymentThirteenthSalaryProportional: type: boolean description: Pagar 13º salário proporcional default: false paymentThirteenthSalaryCompensatedType: type: string allOf: – #/definitions/paymentThirteenthSalaryCompensatedType description: Pagar 13º salário indenizado paymentVacationProportionalAndCompensatedType: type: string allOf: – #/definitions/paymentVacationProportionalAndCompensatedType description: Pagar férias proporcionais/indenizadas paymentCompensatedPreviousMonthBaseDateType: type: string allOf: – #/definitions/paymentCompensatedPreviousMonthBaseDateType description: Pagar indenizações no mês que antecede o dissídio deductionEarlyVacationType: type: string allOf: – #/definitions/deductionEarlyVacationType description: Descontar férias antecipadas fgtsWithdrawalType: type: string allOf: – #/definitions/fgtsWithdrawalType description: Código de saque do FGTS paymentQualificationFine: type: boolean description: Pagar multa de qualificação profissional default: false percentFgtsDismissal: type: number format: double description: Percentual de Multa de FGTS maximum: 999.99 default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCauseDismissalHistory: type: object required: – id allOf: – #/definitions/causeDismissalHistory dismissalSchedule: description: Programação de rescisão type: object required: – employee – dismissalDate – causeDismissal – paymentDate – salaryAfterDismissalType – workDays – statusType – dismissalScheduleType – sequence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dismissalDate: type: string format: date description: Data de demissão causeDismissal: type: object allOf: – #/definitions/causeDismissal description: Causa de demissão priorNoticedDate: type: string format: date description: Data do aviso – Caso o tipo de data de aviso (noticeDatetype) da causa de demissão (causeDismissalHistory) seja ASSUMES_DISMISSAL_DATE, esse campo será salvo com o mesmo valor da data de demissão. paymentDate: type: string format: date description: Data de pagamento salaryAfterDismissalType: type: string allOf: – #/definitions/salaryAfterDismissalType description: Indicativo de remuneração após o desligamento salaryAfterDismissalDate: type: string format: date description: Data de remuneração após o desligamento endContractDate: type: string format: date description: Data final do contrato – Esse atributo sempre é calculado, os valores recebidos nas chamadas serão substituídos pelos valores calculados workDays: type: integer format: int64 description: Dias trabalhados maximum: 99999999999 priorNoticeCompensated: type: number format: double description: Aviso indenizado maximum: 999.99 default: 0.0 priorNoticeCompensatedAddition: type: number format: double description: Programação rescisão normal: Acréscimo de aviso indenizado – Esse atributo sempre é calculado, os valores recebidos nas chamadas serão substituídos pelos valores calculados\nProgramação Rescisão complementar: Acréscimo de aviso indenizado – Esse atributo será carregado com os dados da rescisão normal podendo o usuário alterar maximum: 999.99 default: 0.0 priorNoticeNotFullfilledAddition: type: integer format: int64 description: Programação rescisão normal: Acréscimo de aviso reavido – Esse atributo sempre é calculado, os valores recebidos nas chamadas serão substituídos pelos valores calculados\nProgramação Rescisão complementar: Acréscimo de aviso reavido – Esse atributo será carregado com os dados da rescisão normal podendo o usuário alterar maximum: 999 default: 0 priorNoticeNotFullfilled: type: integer format: int64 description: Aviso reavido maximum: 999 default: 0 endEarly: type: integer format: int64 description: Final antecipado – Em determinadas situações esse atributo é calculado, nesses casos os valores recebidos nas chamadas serão substituídos pelos valores calculados maximum: 9999 default: 0 stability: type: integer format: int64 description: Estabilidade minimum: 0 maximum: 9999 default: 0 professionalQualificationFineDays: type: integer format: int64 description: Dias de multa sobre qualificação profissional maximum: 9999 default: 0 salaryEndNotice: type: string description: Salário final do aviso maximum: 99999999.99 default: 0.0 salaryHistoryDate: type: string format: date description: Data do histórico salarial fgtsPensionType: type: string allOf: – #/definitions/fgtsPensionType description: Pensão de FGTS – Esse valor é controlado pelo sistema, caso o usuário informe o campo, o valor informado será substituído fgtsPensionValue: type: string description: Valor de pensão de FGTS – Em determinadas casos, o valor do campo será controlado pelo sistema, substituindo o valor informado pelo usuário minimum: 0 maximum: 99999999.99 default: 0 fgtsPensionPercentage: type: number format: double description: Percentual de pensão de FGTS minimum: 0.0 maximum: 100.00 default: 0.0 laborProcess: type: string maxLength: 20 description: Processo trabalhista observationEsocial: type: string maxLength: 50 description: Observação para o eSocial statusType: type: string allOf: – #/definitions/statusType description: Status endDatePriorNoticedProjection: type: string format: date description: Data projetada para o término do aviso – Esse atributo sempre é calculado, os valores recebidos nas chamadas serão substituídos pelos valores calculados payDoubleVacationFine: type: boolean description: Pagar multa de férias em dobro default: true calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Definição de cálculo reasonComplementaryDismissalType: type: string allOf: – #/definitions/reasonComplementaryDismissalType description: Motivo da rescisão complementar formCorrectionType: type: string allOf: – #/definitions/formCorrectionType description: Forma de acerto dismissalScheduleType: type: string allOf: – #/definitions/dismissalScheduleType description: Tipo de rescisão dismissalScheduleOrigin: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão original calculationDate: type: string format: date-time description: Data/hora do cálculo fgtsBalance: type: string description: Saldo de FGTS maximum: 999999.99 sequence: type: integer format: int64 description: Sequência minimum: 1 maximum: 99 dismissalPaymentInCaseOfDeathType: type: string allOf: – #/definitions/dismissalPaymentInCaseOfDeathType description: Tipo de pagamento em caso de falecimento do colaborador 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: editDismissalSchedule: type: object required: – id allOf: – #/definitions/dismissalSchedule calculationDefinition: description: Código de cálculo type: object required: – code – calculationType – competence – paymentDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa code: type: integer format: int64 description: Código do cálculo minimum: 1 calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo calculationDefinitionOrigin: type: object allOf: – #/definitions/calculationDefinition description: Definição de cálculo de origem competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha 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: variableEntryComplementaryDismissal: description: Lançamentos de eventos da rescisão complementar type: object required: – dismissalSchedule – wageType – reference – value – originType properties: id: type: string format: uuid description: Identificador único dismissalSchedule: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 99999.98 value: type: number format: double description: Valor minimum: 0.0 maximum: 999999999.99 originType: type: string allOf: – #/definitions/originType description: Origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVariableEntryComplementaryDismissal: type: object required: – id allOf: – #/definitions/variableEntryComplementaryDismissal dismissalEmployeeDependentAlimonyHistory: description: Histórico de pensão judicial na rescisão type: object required: – employeeDependent – dismissalScheduleOrigin – alimonyCalculationType – alimonyValue properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente dismissalScheduleOrigin: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão 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: editDismissalEmployeeDependentAlimonyHistory: type: object required: – id allOf: – #/definitions/dismissalEmployeeDependentAlimonyHistory dismissalEmployeeDependentAlimonyPayeeHistory: description: Histórico de beneficiário de pensão judicial na rescisão type: object required: – dismissalEmployeeDependentAlimonyHistory – employeeDependent – alimonyValue properties: id: type: string format: uuid description: Identificador único dismissalEmployeeDependentAlimonyHistory: type: object allOf: – #/definitions/dismissalEmployeeDependentAlimonyHistory description: Histórico de pensão judicial na rescisão 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: dismissalWageType: description: Eventos de rescisão type: object required: – employee – dismissalSchedule – wageType – reference – value properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dismissalSchedule: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão wageType: type: object allOf: – #/definitions/wageType description: Código do evento reference: type: number format: double description: Referência minimum: 0 value: type: string description: Valor minimum: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dismissalRegister: description: Demonstrativo de rescisão type: object required: – employee – dismissalSchedule – salary – processId – totalIncome – totalDiscount – netValue – fgtsBasis – fgtsBasisThirteenth – inssBasis – inssBasisThirteenth – irrfBalance – irrfBasisThirteenth – irrfBasisVacation – fgtsCompensatedBasis – fgtsThirteenthCompensatedBasis – dependentsIRRF – dependentsSalaryFamily properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dismissalSchedule: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão salary: type: string description: Salário base processId: type: string format: uuid description: Identificador do processo totalIncome: type: string description: Total de proventos totalDiscount: type: string description: Total de descontos netValue: type: string description: Total líquido fgtsBasis: type: string description: Base do FGTS fgtsBasisThirteenth: type: string description: Base do FGTS de 13º salário inssBasis: type: string description: Base do INSS inssBasisThirteenth: type: string description: Base do INSS de 13º salário irrfBalance: type: string description: Base de saldo de IRRF irrfBasisThirteenth: type: string description: Base do IRRF de 13º salário irrfBasisVacation: type: string description: Base do IRRF de férias fgtsCompensatedBasis: type: string description: Base de FGTS indenizado fgtsThirteenthCompensatedBasis: type: string description: Base de FGTS de 13º salário indenizado dependentsIRRF: type: integer format: int64 description: Número de dependentes para IRRF dependentsSalaryFamily: type: integer format: int64 description: Número de dependentes para salário família 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: dismissalRegisterDetail: description: Detalhe do demonstrativo de rescisão type: object required: – dismissalRegister – dismissalCalculationType – wageType – reference – value properties: id: type: string format: uuid description: Identificador único dismissalRegister: type: object allOf: – #/definitions/dismissalRegister description: Demonstrativo de rescisão dismissalCalculationType: type: string allOf: – #/definitions/dismissalCalculationType description: Tipo de cálculo de rescisão employeeAcquisitivePeriodResume: type: object allOf: – #/definitions/employeeAcquisitivePeriodResume description: Período aquisitivo wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência value: type: string description: Valor 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: employeeAcquisitivePeriodResume: description: Resumo do período aquisitivo type: object required: – employee – startDate – endDate – balanceDays – vacationFractionDenominator properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final balanceDays: type: number format: double description: Dias de saldo vacationFractionDenominator: type: integer format: int64 description: Avos 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: dismissalSyndicateContributionInformation: description: Informações de contribuição sindical de rescisão type: object required: – dismissalRegister – wageType – contributionType – value properties: id: type: string format: uuid description: Identificador único dismissalRegister: type: object allOf: – #/definitions/dismissalRegister description: Demonstrativo de rescisão wageType: type: object allOf: – #/definitions/wageType description: Evento contributionType: type: object allOf: – #/definitions/contributionType description: Tipo de contribuição value: type: string description: Valor minimum: 0.0 base: type: string description: Base minimum: 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: 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 nomEmp: type: string maxLength: 100 description: Nome da empresa companyIndications: type: object allOf: – #/definitions/companyIndications description: Assinalamentos 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: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome da filial numCgc: type: string maxLength: 18 description: CPF/CNPJ deleted: 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: 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 description: Cpf/Cnpj regAns: type: integer format: int64 description: Registro ANS 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 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 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: 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: collectiveNegotiationHistory: description: Histórico de negociação coletiva type: object required: – collectiveNegotiation – 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: collectiveNegotiation: description: Negociação coletiva type: object required: – syndicate – 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: collectiveNegotiationDismissal: description: Definições de rescisão type: object required: – collectiveNegotiationHistory – periodType properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistory: type: object allOf: – #/definitions/collectiveNegotiationHistory description: Histórico de negociação coletiva periodType: type: string allOf: – #/definitions/periodType description: Tipo de período do termo de quitação numberDaysMonths: type: integer format: int64 description: Quantidade de dias ou meses do termo de quitação minimum: 0 maximum: 999 default: 0 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: collectiveNegotiationPriorNoticed: description: Definições de aviso prévio type: object required: – collectiveNegotiationHistory – daysPriorNoticed – daysPriorNotFulfilled – addDaysNoticedYear – addDaysNotFulfilledYear properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistory: type: object allOf: – #/definitions/collectiveNegotiationHistory description: Histórico de negociação coletiva daysPriorNoticed: type: integer format: int64 description: Dias de aviso indenizado minimum: 0 maximum: 999 daysPriorNotFulfilled: type: integer format: int64 description: Dias de aviso reavido minimum: 0 maximum: 999 addDaysNoticedYear: type: integer format: int64 description: Acréscimo de dias indenizado por ano minimum: 0 maximum: 99 addDaysNotFulfilledYear: type: integer format: int64 description: Acréscimo de dias reavido por ano minimum: 0 maximum: 99 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: 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: Evento type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código shortName: type: string maxLength: 30 description: Nome reduzido x-i18n: true validityStart: type: string format: date description: Competência de início da validade validityEnd: type: string format: date description: Competência de término da validade 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 – characteristic – rule 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 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: 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. dismissalReasonESocial: description: Motivos de desligamento do eSocial type: object required: – causeDismissal – startDate properties: id: type: string format: uuid description: Identificador único causeDismissal: type: object allOf: – #/definitions/causeDismissal description: Causa de recisão startDate: type: string format: date description: Competência eSocialDismissalType: type: string allOf: – #/definitions/eSocialDismissalType description: Tipo de desligamento eSocial dismissalType: type: string allOf: – #/definitions/dismissalType description: Tipo de desligamento voluntaryDismissalProgram: type: boolean description: Programa de demissão voluntária 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: causeDismissal: description: Causa de rescisão 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: Nome 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: 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 externalId: type: string maxLength: 255 description: Identificador externo 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: employeeDependent: description: Dependentes do colaborador type: object required: – employee – dependent 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 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: 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: 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: contributionType: description: Tipos de contribuições sindicais 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 description: Nome 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: healthPlan: description: Plano de saúde type: object required: – code – description – provider properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 description: type: string maxLength: 255 description: Descrição provider: type: object allOf: – #/definitions/e001pes description: Operadora 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: dismissalHealthPlanCalculation: description: Informações do cálculo de plano de saúde de rescisão type: object required: – company – employee – enrollmentType – healthPlan – dismissalSchedule – totalMonthlyFeeValue – companyMonthlyFeeValue – employeeMonthlyFeeValue – copaymentValue properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa employee: type: object allOf: – #/definitions/employee description: Colaborador employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente enrollmentType: type: string allOf: – #/definitions/enrollmentType description: Tipo de vínculo healthPlan: type: object allOf: – #/definitions/healthPlan description: Plano de saúde dismissalSchedule: type: object allOf: – #/definitions/dismissalSchedule description: Programação de rescisão totalMonthlyFeeValue: type: string description: Valor total da mensalidade minimum: 0 companyMonthlyFeeValue: type: string description: Valor da mensalidade parte empresa minimum: 0 employeeMonthlyFeeValue: type: string description: Valor da mensalidade parte colaborador minimum: 0 copaymentValue: type: string description: Valor da coparticipação minimum: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: complementaryPensionDismissalCalculation: description: Previdência complementar para rescisão type: object required: – dismissalRegister – companyComplementaryPension – detailCalculationType – paymentValue properties: id: type: string format: uuid description: Identificador único dismissalRegister: type: object allOf: – #/definitions/dismissalRegister description: Informações do demonstrativo de rescisão companyComplementaryPension: type: object allOf: – #/definitions/e001pes description: Empresa da previdência complementar detailCalculationType: type: string allOf: – #/definitions/detailCalculationType description: Tipo de cálculo irrfTaxationCode: type: string description: Código de tributação do IRRF paymentValue: type: string description: Valor da previdência complementar createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editComplementaryPensionDismissalCalculation: type: object required: – id allOf: – #/definitions/complementaryPensionDismissalCalculation dismissalPaymentTitle: 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 o cálculo/dismissalSchedule 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 dismissalDate: type: string format: date description: Data de demissão dismissalRegister: type: object allOf: – #/definitions/dismissalRegister description: Demonstrativo de rescisão 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 sequence: type: integer format: int64 description: Sequência minimum: 0 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 calculationType: type: string maxLength: 255 description: Tipo de cálculo em execução 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: dismissalPaymentTitleStatusHistory: description: Histórico de status do título de pagamento type: object required: – dismissalPaymentTitle – newStatus properties: id: type: string format: uuid description: Identificador único dismissalPaymentTitle: type: object allOf: – #/definitions/dismissalPaymentTitle 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: e030ban: description: Banco type: object properties: id: type: string format: uuid description: Identificador único codBan: type: string maxLength: 3 description: Código do banco nomBan: type: string maxLength: 100 description: Nome do banco deleted: 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: Identificador único codAge: type: string maxLength: 7 description: Código da agência digAge: type: string maxLength: 2 description: Dígito da agência nomAge: type: string maxLength: 30 description: Nome da agência deleted: 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 type: object properties: id: type: string format: uuid description: Identificador único codTcc: type: string maxLength: 3 description: Código do tipo de conta desTcc: type: string maxLength: 100 description: Descrição do tipo de conta deleted: 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: Identificador único 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 e030age: type: object allOf: – #/definitions/e030age description: Agência e034tcc: type: object allOf: – #/definitions/e034tcc description: Tipo de conta 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 da conta sitCco: type: string allOf: – #/definitions/enumSitReg description: Situação datIni: type: string format: date description: Data base do saldo inicial da conta deleted: 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: 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: 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: 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: accountingClassificationCode: description: Código de Lançamento Contábil type: object properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 description: type: string maxLength: 120 description: Descrição wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos deleted: 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: 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