HCM – Payroll Financial Statement General (general)

2.0info: 2.6.0 HCM – Payroll Financial Statement General description: HCM – Payroll Financial Statement General x-senior-domain: HCM – Payroll Financial Statement General x-senior-domain-path: hcm_payroll_financial_statement 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_financial_statementsecurityDefinitions: 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/listPayrollRegisterCustomFilter: post: description: Busca os demonstrativos de pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: 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/ordinationPayrollRegister description: Ordenação. Caso não seja informada, ordenada pela data da última alteração de forma descendente. filter: type: object allOf: – #/definitions/filterPayrollRegisterDTO description: Filtro responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/payrollRegisterDTO minimum: 1 description: Demonstrativos de pagamento totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/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/navigationPayrollRegisterByEmployee: post: description: Navegar demonstrativo de pagamento por colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition – directionNavigation properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo directionNavigation: type: string allOf: – #/definitions/directionNavigation description: Direção para navegação responses: 200: description: Ok schema: type: object allOf: – #/definitions/navigationPayrollRegisterDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Navegar demonstrativo de pagamento por colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: calculationDefinition description: Definição de cálculo in: query required: true type: string maxLength: 36 – name: directionNavigation description: Direção para navegação in: query required: true type: string allOf: – #/definitions/directionNavigation responses: 200: description: Ok schema: type: object allOf: – #/definitions/navigationPayrollRegisterDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listFinancialStatementCustom: post: description: Listar eventos do demonstrativo de pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo 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/ordinationFinancialStatement description: Ordenação. Caso não seja informada, ordenada por tipo evento. responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/financialStatementDTO minimum: 1 description: Demonstrativos de pagamento totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listFinancialStatementThirdPartyCustom: post: description: Listar eventos do demonstrativo de pagamento de terceiros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paymentInformationThirdPartyId properties: paymentInformationThirdPartyId: type: string maxLength: 36 description: informações de pagamento para terceiros 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/ordinationFinancialStatement description: Ordenação. Caso não seja informada, ordenada por tipo evento. responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/financialStatementDTO minimum: 1 description: Demonstrativos de pagamento totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getPayrollRegisterInformation: post: description: Busca as informações do demonstrativo de pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo responses: 200: description: Ok schema: type: object required: – payrollRegisterInformation properties: payrollRegisterInformation: type: object allOf: – #/definitions/payrollRegisterInformationDTO description: Informações do demonstrativo de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações do demonstrativo de pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: calculationDefinition description: Definição de cálculo in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – payrollRegisterInformation properties: payrollRegisterInformation: type: object allOf: – #/definitions/payrollRegisterInformationDTO description: Informações do demonstrativo de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listFinancialStatementApiTest: post: description: Listar os eventos dos colaboradores para testes automatizados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/financialStatementWageTypeDTO minimum: 1 description: Demonstrativos de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar os eventos dos colaboradores para testes automatizados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – name: calculationDefinition description: Definição de cálculo in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/financialStatementWageTypeDTO minimum: 1 description: Demonstrativos de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/payrollRegisterLookup: post: description: 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: 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/payrollRegisterDataLookup: post: description: 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: 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/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/hasPayment: post: description: Verifica se o colaborador possui algum holerite ou pagamento de terceiros. 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: Identificador do colaborador responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o colaborador possui algum holerite ou pagamento de terceiros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o colaborador possui algum holerite ou pagamento de terceiros. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Identificador do colaborador in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o colaborador possui algum holerite ou pagamento de terceiros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getTotalizerMonthlyInformationValueSum: post: description: Obtém a soma do valor dos registros de informações mensais do totalizador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: calculationDefinitionOrigin: type: string maxLength: 36 description: Definição de cálculo de origem totalizer: type: string maxLength: 36 description: Totalizador company: type: string maxLength: 36 description: Empresa employee: type: string maxLength: 36 description: Colaborador advancedFilter: type: string maxLength: 36 description: Filtro avançado initialCompetence: type: string format: date description: Competência inicial finalCompetence: type: string format: date description: Competência final responses: 200: description: Ok schema: type: object required: – valueSum properties: valueSum: type: string description: Soma do valor dos registros de informações mensais do totalizador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a soma do valor dos registros de informações mensais do totalizador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: calculationDefinitionOrigin description: Definição de cálculo de origem in: query type: string maxLength: 36 – name: totalizer description: Totalizador in: query type: string maxLength: 36 – name: company description: Empresa in: query type: string maxLength: 36 – name: employee description: Colaborador in: query type: string maxLength: 36 – name: advancedFilter description: Filtro avançado in: query type: string maxLength: 36 – name: initialCompetence description: Competência inicial in: query type: string format: date – name: finalCompetence description: Competência final in: query type: string format: date responses: 200: description: Ok schema: type: object required: – valueSum properties: valueSum: type: string description: Soma do valor dos registros de informações mensais do totalizador 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/exportFinancialStatement: 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/exportPayrollRegister: 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/exportPayrollRegisterInformation: 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/exportTotalizerMonthlyInformation: 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/exportPayrollRegisterData: 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/exportEmployeeDependentAlimonyHistory: 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/exportPayrollRegisterDataBasisAndValues: 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/exportCalculationMonthlyInformation: 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/exportPaymentInformationThirdParty: 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/exportFinancialStatementThirdParty: 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/exportThirdPartyJudicialAlimonyPaymentHistory: 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/exportThirdPartyPaymentBasesAndValues: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationship: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/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/exportJobPosition: 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/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/exportTotalizer: 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/exportEmployeeOtherContracts: 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/exportAccumulatedIncomeReceived: 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/exportAccumulatedIncomeReceivedLawyers: 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/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/exportNextCalculationEntry: 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/exportCompanyLinkedLocation: 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/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/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: Realiza a compensação da 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/deleteCalculationBatch: post: description: Exclusão de cálculo em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – calculationDefinitionId – filter properties: calculationDefinitionId: type: string description: Identificador da definição de cálculo filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro de exclusã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/deleteCalculation: post: description: Exclusão do cálculo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio de ficha financeira. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – previousCompany – newCompany – previousEmployee – newEmployee properties: processId: type: string maxLength: 36 description: Identificador do processo previousCompany: type: string maxLength: 36 description: Empresa origem newCompany: type: string maxLength: 36 description: Empresa destino previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino employeeDependentData: type: array items: type: object allOf: – #/definitions/employeeDependentCompanyTransferData description: Dados dos dependentes do colaborador transferido responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeCompanyTransfer: post: description: Desfaz o processo da transferência de empresa de um colaborador no domínio de ficha financeira. tags: – Actions 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/savePaymentInformationThirdParty: post: description: Cria e atualiza as informações de pagamento, as fichas financeiras e os históricos de pagamento de pensão judicial de terceiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paymentInformationThirdParty – financialStatementThirdParties properties: paymentInformationThirdParty: type: object allOf: – #/definitions/paymentInformationThirdPartyDTO description: Informações de pagamentos para terceiros financialStatementThirdParties: type: array items: type: object allOf: – #/definitions/financialStatementThirdPartyDTO minimum: 1 description: fichas financeiras de terceiros thirdPartyJudicialAlimonyPaymentHistories: type: array items: type: object allOf: – #/definitions/thirdPartyJudicialAlimonyPaymentHistoryDTO description: Histórico de pagamento de pensão judicial de terceiros responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deletePaymentInformationThirdPartyById: post: description: Exclui as informações de pagamento, as fichas financeiras e os históricos de pagamento de pensão judicial de terceiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paymentInformationThirdPartyId properties: paymentInformationThirdPartyId: type: string maxLength: 36 description: informações de pagamento para terceiros responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteCalculationThirdParty: post: description: Exclusão do cálculo RPA tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – competence – calculationSequence properties: employee: type: string maxLength: 36 description: Terceiro competence: type: string format: date description: Competência calculationSequence: type: integer format: int64 description: Sequência para o cálculo minimum: 0 maximum: 999 responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deletePaymentInformationThirdPartyBatch: post: description: Exclusão do cálculo RPA – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: paymentInformationThirdParty: type: object allOf: – #/definitions/deletePaymentInformationThirdPartyBatchDTO description: Dto com infromação usada para exclusão filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro de exclusã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/importFinancialStatement: 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/importPayrollRegister: 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/importPayrollRegisterInformation: 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/importTotalizerMonthlyInformation: 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/importPayrollRegisterData: 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/importEmployeeDependentAlimonyHistory: 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/importPayrollRegisterDataBasisAndValues: 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/importCalculationMonthlyInformation: 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/importPaymentInformationThirdParty: 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/importFinancialStatementThirdParty: 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/importThirdPartyJudicialAlimonyPaymentHistory: 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/importThirdPartyPaymentBasesAndValues: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationship: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/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/importJobPosition: 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/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/importTotalizer: 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/importEmployeeOtherContracts: 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/importAccumulatedIncomeReceived: 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/importAccumulatedIncomeReceivedLawyers: 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/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/importNextCalculationEntry: 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/importCompanyLinkedLocation: 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/signals/calculationSave: post: description: Grava o resultado do cálculo da folha. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – company – calculationDefinitionData – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa. calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo. 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 idNextCalculationEntrySettlementList: type: array items: type: string description: Lista de lançamentos da próxima definição de cálculo quitados nextCalculationEntry: type: array items: type: object allOf: – #/definitions/nextCalculationEntryDTO description: Lista de lançamentos da próxima definição do cálculo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deleteCalculationBatchItem: post: description: Exclusão de cálculo em lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/deletePayrollRegisterBatchDTO description: Dto com o filtro de exclusão itens: type: array items: type: object allOf: – #/definitions/payrollRegisterBatchItem minimum: 1 description: Dto com os itens a serem excluídos 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/signals/calculationThirdPartySave: post: description: Grava o resultado do cálculo de RPA tags: – Signals 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 calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo competence: type: string format: date description: Competência logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deletePaymentInformationThirdPartyBatchItem: post: description: Exclusão do cálculo RPA – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/deletePaymentInformationThirdPartyBatchDTO description: Dto com infromação usada para exclusão itens: type: array items: type: string minimum: 1 description: Lista de itens a ser excluído 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/events/calculationThirdPartySaved: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/financialStatementSaved: post: description: Notifica que a gravação do cálculo finalizou para determinado lote. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – company – calculationDefinitionData – batchDescription properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores. company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa. calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo. batchDescription: type: string description: Descrição calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo – Necessário para o cálculo de RPA competence: type: string format: date description: Competência – Necessário para o cálculo de RPA logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importFinancialStatementEvent: 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/exportFinancialStatementEvent: 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/importPayrollRegisterEvent: 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/exportPayrollRegisterEvent: 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/importPayrollRegisterInformationEvent: 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/exportPayrollRegisterInformationEvent: 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/importTotalizerMonthlyInformationEvent: 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/exportTotalizerMonthlyInformationEvent: 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/importPayrollRegisterDataEvent: 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/exportPayrollRegisterDataEvent: 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/importEmployeeDependentAlimonyHistoryEvent: 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/exportEmployeeDependentAlimonyHistoryEvent: 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/importPayrollRegisterDataBasisAndValuesEvent: 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/exportPayrollRegisterDataBasisAndValuesEvent: 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/importCalculationMonthlyInformationEvent: 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/exportCalculationMonthlyInformationEvent: 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/importPaymentInformationThirdPartyEvent: 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/exportPaymentInformationThirdPartyEvent: 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/importFinancialStatementThirdPartyEvent: 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/exportFinancialStatementThirdPartyEvent: 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/importThirdPartyJudicialAlimonyPaymentHistoryEvent: 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/exportThirdPartyJudicialAlimonyPaymentHistoryEvent: 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/importThirdPartyPaymentBasesAndValuesEvent: 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/exportThirdPartyPaymentBasesAndValuesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/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/importJobPositionEvent: 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/exportJobPositionEvent: 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/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/importTotalizerEvent: 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/exportTotalizerEvent: 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/importEmployeeOtherContractsEvent: 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/exportEmployeeOtherContractsEvent: 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/importAccumulatedIncomeReceivedEvent: 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/exportAccumulatedIncomeReceivedEvent: 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/importAccumulatedIncomeReceivedLawyersEvent: 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/exportAccumulatedIncomeReceivedLawyersEvent: 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/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/importNextCalculationEntryEvent: 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/exportNextCalculationEntryEvent: 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/importCompanyLinkedLocationEvent: 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/exportCompanyLinkedLocationEvent: 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/entities/financialStatement: 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/financialStatement responses: 200: description: The created resource schema: #/definitions/financialStatement 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/financialStatement responses: 200: description: The created resource schema: #/definitions/financialStatement 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/financialStatement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/financialStatement/{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/editFinancialStatement responses: 200: description: Ok schema: #/definitions/editFinancialStatement 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/financialStatement responses: 200: description: Ok schema: #/definitions/financialStatement 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/financialStatement 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/financialStatement/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/financialStatement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegister: 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/payrollRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegisterInformation: 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/payrollRegisterInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/totalizerMonthlyInformation: 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/totalizerMonthlyInformation responses: 200: description: The created resource schema: #/definitions/totalizerMonthlyInformation 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/totalizerMonthlyInformation responses: 200: description: The created resource schema: #/definitions/totalizerMonthlyInformation 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/totalizerMonthlyInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/totalizerMonthlyInformation/{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/editTotalizerMonthlyInformation responses: 200: description: Ok schema: #/definitions/editTotalizerMonthlyInformation 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/totalizerMonthlyInformation responses: 200: description: Ok schema: #/definitions/totalizerMonthlyInformation 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/totalizerMonthlyInformation 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/totalizerMonthlyInformation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/totalizerMonthlyInformation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegisterData: 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/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegister/{parentId}/payrollRegisterData: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollRegisterData responses: 200: description: The created resource schema: #/definitions/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollRegisterData responses: 200: description: The created resource schema: #/definitions/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegister/{parentId}/payrollRegisterData/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPayrollRegisterData responses: 200: description: Ok schema: #/definitions/editPayrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollRegisterData responses: 200: description: Ok schema: #/definitions/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/payrollRegisterData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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/employeeDependentAlimonyHistory: 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/employeeDependentAlimonyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/payrollRegisterDataBasisAndValues: 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/payrollRegisterDataBasisAndValues 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/calculationMonthlyInformation: 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/calculationMonthlyInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/paymentInformationThirdParty: 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/paymentInformationThirdParty responses: 200: description: The created resource schema: #/definitions/paymentInformationThirdParty 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/paymentInformationThirdParty responses: 200: description: The created resource schema: #/definitions/paymentInformationThirdParty 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/paymentInformationThirdParty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/paymentInformationThirdParty/{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/editPaymentInformationThirdParty responses: 200: description: Ok schema: #/definitions/editPaymentInformationThirdParty 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/paymentInformationThirdParty responses: 200: description: Ok schema: #/definitions/paymentInformationThirdParty 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/paymentInformationThirdParty 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/paymentInformationThirdParty/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentInformationThirdParty responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/financialStatementThirdParty: 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/financialStatementThirdParty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/thirdPartyJudicialAlimonyPaymentHistory: 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/thirdPartyJudicialAlimonyPaymentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/thirdPartyPaymentBasesAndValues: 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/thirdPartyPaymentBasesAndValues 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOtherContracts: 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/employeeOtherContracts responses: 200: description: The created resource schema: #/definitions/employeeOtherContracts 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/employeeOtherContracts responses: 200: description: The created resource schema: #/definitions/employeeOtherContracts 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/employeeOtherContracts 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOtherContracts/{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/editEmployeeOtherContracts responses: 200: description: Ok schema: #/definitions/editEmployeeOtherContracts 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/employeeOtherContracts responses: 200: description: Ok schema: #/definitions/employeeOtherContracts 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/employeeOtherContracts 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/employeeOtherContracts/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeOtherContracts responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/accumulatedIncomeReceived: 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/accumulatedIncomeReceived responses: 200: description: The created resource schema: #/definitions/accumulatedIncomeReceived 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/accumulatedIncomeReceived responses: 200: description: The created resource schema: #/definitions/accumulatedIncomeReceived 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/accumulatedIncomeReceived 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/accumulatedIncomeReceived/{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/editAccumulatedIncomeReceived responses: 200: description: Ok schema: #/definitions/editAccumulatedIncomeReceived 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/accumulatedIncomeReceived responses: 200: description: Ok schema: #/definitions/accumulatedIncomeReceived 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/accumulatedIncomeReceived 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/accumulatedIncomeReceived/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accumulatedIncomeReceived responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/accumulatedIncomeReceivedLawyers: 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/accumulatedIncomeReceivedLawyers responses: 200: description: The created resource schema: #/definitions/accumulatedIncomeReceivedLawyers 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/accumulatedIncomeReceivedLawyers responses: 200: description: The created resource schema: #/definitions/accumulatedIncomeReceivedLawyers 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/accumulatedIncomeReceivedLawyers 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/accumulatedIncomeReceivedLawyers/{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/editAccumulatedIncomeReceivedLawyers responses: 200: description: Ok schema: #/definitions/editAccumulatedIncomeReceivedLawyers 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/accumulatedIncomeReceivedLawyers responses: 200: description: Ok schema: #/definitions/accumulatedIncomeReceivedLawyers 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/accumulatedIncomeReceivedLawyers 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/accumulatedIncomeReceivedLawyers/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accumulatedIncomeReceivedLawyers responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/nextCalculationEntry: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/nextCalculationEntry responses: 200: description: The created resource schema: #/definitions/nextCalculationEntry 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/nextCalculationEntry responses: 200: description: The created resource schema: #/definitions/nextCalculationEntry 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/nextCalculationEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/nextCalculationEntry/{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/editNextCalculationEntry responses: 200: description: Ok schema: #/definitions/editNextCalculationEntry 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/nextCalculationEntry responses: 200: description: Ok schema: #/definitions/nextCalculationEntry 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/nextCalculationEntry 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/nextCalculationEntry/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/nextCalculationEntry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e070fil: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e070fil/{id}: 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/e070fil 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 calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – 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 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 * `VACATION` – Férias * `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 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_MATERNITY_LEAVE_NONCRIMINAL_ABORTION – NIGHTTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION – DAYTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION – NIGHTTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION – DAYTIME_ILLNESS_AID – NIGHTTIME_ILLNESS_AID – DAYTIME_LABOR_ACCIDENT – NIGHTTIME_LABOR_ACCIDENT – DAYTIME_MILITARY_SERVICE – NIGHTTIME_MILITARY_SERVICE – DAYTIME_PAID_LEAVE – NIGHTTIME_PAID_LEAVE – DAYTIME_LEAVE_WITHOUT_COMPENSATION – NIGHTTIME_LEAVE_WITHOUT_COMPENSATION – DAYTIME_PATERNITY_LEAVE – NIGHTTIME_PATERNITY_LEAVE – DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – DAYTIME_CITIZEN_COMPANY_MATERNITY – NIGHTTIME_CITIZEN_COMPANY_MATERNITY – DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS – NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS – DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – DAYTIME_INSS_MATERNITY_LEAVE – NIGHTTIME_INSS_MATERNITY_LEAVE – HAZARD – ADDITIONAL_HOURS_ENTRY – OVERTIME_NIGHTTIME – INSALUBRITY – ALLOWANCE – TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION – TRANSPORTATION_VOUCHER – MEDICAL_EXPENSES – TIPS – PREMIUMS – DAY_CARE_REIMBURSEMENT – NANNY_REIMBURSEMENT – TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION – OTHER_PROCEEDS – OTHER_DEDUCTIONS – TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT – EXCEEDING_FOOD_VOUCHER_MEAL_TICKET – PRECAUTION_HOURS – CORPORATE_OFFICER_WAGE – JUDICIAL_ALIMONY_MONTH – COMMISSIONS – DSR_COMMISSIONS – COMPLEMENT_SALARY – DAYTIME_OVERTIME_COMMISSION – NIGHTTIME_OVERTIME_COMMISSION – MONTH_OVERFLOW – PREVIOUS_MONTH_OVERFLOW – MONTH_REFUND – PREVIOUS_MONTH_REFUND – SYNDICATE_CONTRIBUTIONS – DAYTIME_RETIREMENT_DUE_TO_DISABILITY – NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY – DAYTIME_OTHERS – NIGHTTIME_OTHERS – ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ADVANCE_THIRTEENTH_SALARY – JUDICIAL_ALIMONY_THIRTEENTH_SALARY – ALIMONY_ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY – THIRTEENTH_SALARY – MATERNITY_THIRTEENTH_SALARY – MATERNITY_INSS_THIRTEENTH_SALARY – BASE_WORK_ACCIDENT_THIRTEENTH_SALARY – BASE_MILITARY_SERVICE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY – ADDITIONAL_ADVANCE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY – ADDITIONAL_THIRTEENTH_SALARY – FGTS_THIRTEENTH_SALARY – COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_MATERNITY_THIRTEENTH_SALARY – RETURN_MATERNITY_INSS_THIRTEENTH_SALARY – RETURN_INSS_THIRTEENTH_SALARY – IRRF_ADVANCE_SALARY – SALARY_ADVANCE_DISCOUNT – INSS_THIRTEENTH_SALARY – IRRF_THIRTEENTH_SALARY – DAYTIME_VACATION_HOURS – NIGHTTIME_VACATION_HOURS – THIRD_OF_VACATION – THIRD_OF_VACATION_PREMIUM – DOUBLE_VACATION_FINE – DOUBLE_VACATION_PREMIUM_FINE – VACATION_PREMIUM – INSS_VACATION_PAY – INSS_VACATION_MONTH – JUDICIAL_ALIMONY_VACATION – IRRF_VACATION_PAY – IRRF_VACATION_MONTH – 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_FORTY_PERCENT_DEPOSITED – 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 – IRRF_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 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_MATERNITY_LEAVE_NONCRIMINAL_ABORTION` – Licença maternidade – Aborto não criminoso Diurno * `NIGHTTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION` – Licença maternidade – Aborto não criminoso Noturno * `DAYTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION` – Licença maternidade – Prorrogação mediante atestado médico Diurno * `NIGHTTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION` – Licença maternidade – Prorrogação mediante atestado médico Noturno * `DAYTIME_ILLNESS_AID` – Horas auxílio doença diurnas * `NIGHTTIME_ILLNESS_AID` – Horas auxílio doença noturnas * `DAYTIME_LABOR_ACCIDENT` – Horas acidente de trabalho diurnas * `NIGHTTIME_LABOR_ACCIDENT` – Horas acidente de trabalho noturnas * `DAYTIME_MILITARY_SERVICE` – Horas serviço militar diurnas * `NIGHTTIME_MILITARY_SERVICE` – Horas serviço militar noturnas * `DAYTIME_PAID_LEAVE` – Horas licença com remuneração diurnas * `NIGHTTIME_PAID_LEAVE` – Horas licença com remuneração noturnas * `DAYTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração diurnas * `NIGHTTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração noturnas * `DAYTIME_PATERNITY_LEAVE` – Horas licença paternidade diurnas * `NIGHTTIME_PATERNITY_LEAVE` – Horas licença paternidade noturnas * `DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã diurna * `NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã noturna * `DAYTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã diurna * `NIGHTTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã noturna * `DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Diurnas * `NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Noturnas * `DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS diurnas * `NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS noturnas * `DAYTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS diurnas * `NIGHTTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS noturnas * `HAZARD` – Periculosidade * `ADDITIONAL_HOURS_ENTRY` – Adicionais lançados em horas * `OVERTIME_NIGHTTIME` – Horas extras noturnas * `INSALUBRITY` – Insalubridade * `ALLOWANCE` – Ajuda de custo * `TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem até 50% remuneração * `TRANSPORTATION_VOUCHER` – Vale transporte * `MEDICAL_EXPENSES` – Despesas médicas * `TIPS` – Gorjetas * `PREMIUMS` – Prêmios * `DAY_CARE_REIMBURSEMENT` – Reembolso creche * `NANNY_REIMBURSEMENT` – Reembolso babá * `TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem acima 50% remuneração * `OTHER_PROCEEDS` – Proventos diversos * `OTHER_DEDUCTIONS` – Descontos diversos * `TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT` – Reembolso vale alimentação/transporte * `EXCEEDING_FOOD_VOUCHER_MEAL_TICKET` – Vale alimentação/refeição excedente * `PRECAUTION_HOURS` – Horas de sobreaviso * `CORPORATE_OFFICER_WAGE` – Pró-labore * `JUDICIAL_ALIMONY_MONTH` – Pensão judicial mensal * `COMMISSIONS` – Comissões * `DSR_COMMISSIONS` – Repouso sobre comissões * `COMPLEMENT_SALARY` – Complemento Salarial * `DAYTIME_OVERTIME_COMMISSION` – Hora extra comissão diurna * `NIGHTTIME_OVERTIME_COMMISSION` – Hora extra comissão noturna * `MONTH_OVERFLOW` – Estouro do mês * `PREVIOUS_MONTH_OVERFLOW` – Estouro do mês anterior * `MONTH_REFUND` – Troco do mês * `PREVIOUS_MONTH_REFUND` – Troco do mês anterior * `SYNDICATE_CONTRIBUTIONS` – Contribuições do sindicato * `DAYTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas diurnas – Aposentadoria por invalidez * `NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas noturnas – Aposentadoria por invalidez * `DAYTIME_OTHERS` – Outras Horas Diurnas * `NIGHTTIME_OTHERS` – Outras Horas Noturnas * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `DISCOUNT_ADVANCE_THIRTEENTH_SALARY` – Desconto adiantamento 13º salário * `JUDICIAL_ALIMONY_THIRTEENTH_SALARY` – Pensão judicial sobre 13º salário * `ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Pensão judicial sobre adiantamento do 13º salário * `DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Desconto de pensão judicial no adiantamento do 13º salário * `THIRTEENTH_SALARY` – 13º salário integral * `MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade * `MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS * `BASE_WORK_ACCIDENT_THIRTEENTH_SALARY` – Base 13º salário acidente de trabalho * `BASE_MILITARY_SERVICE_THIRTEENTH_SALARY` – Base 13º salário serviço militar * `AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY` – Média de horas extras adiantamento 13° salário * `AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY` – Média de valores variáveis adiantamento 13° salário * `ADDITIONAL_ADVANCE_THIRTEENTH_SALARY` – Adicionais de adiantamento 13° salário * `AVERAGE_OVERTIME_THIRTEENTH_SALARY` – Média de horas extras 13° salário integral * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY` – Média de valores variáveis 13° salário Integral * `ADDITIONAL_THIRTEENTH_SALARY` – Adicionais de 13° salário integral * `FGTS_THIRTEENTH_SALARY` – FGTS sobre 13º salário * `COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar * `RETURN_COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar a devolver * `RETURN_MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade a devolver * `RETURN_MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS a devolver * `RETURN_INSS_THIRTEENTH_SALARY` – Devolução INSS 13° salário * `IRRF_ADVANCE_SALARY` – IRRF sobre adiantamento salarial * `SALARY_ADVANCE_DISCOUNT` – Desconto adiantamento salarial * `INSS_THIRTEENTH_SALARY` – INSS sobre 13º salário * `IRRF_THIRTEENTH_SALARY` – IRRF sobre 13º salário * `DAYTIME_VACATION_HOURS` – Horas férias diurnas * `NIGHTTIME_VACATION_HOURS` – Horas férias noturnas * `THIRD_OF_VACATION` – 1/3 sobre férias * `THIRD_OF_VACATION_PREMIUM` – 1/3 sobre abono pecuniário * `DOUBLE_VACATION_FINE` – Multa dobro de férias * `DOUBLE_VACATION_PREMIUM_FINE` – Multa dobro do abono pecuniário * `VACATION_PREMIUM` – Abono pecuniário * `INSS_VACATION_PAY` – INSS sobre recibo de férias * `INSS_VACATION_MONTH` – INSS sobre férias na folha * `JUDICIAL_ALIMONY_VACATION` – Pensão judicial sobre férias * `IRRF_VACATION_PAY` – IRRF sobre recibo de férias * `IRRF_VACATION_MONTH` – IRRF sobre férias na folha * `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_FORTY_PERCENT_DEPOSITED` – FGTS Rescisão 40% depositado * `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 * `IRRF_VACATION_PAY_PAYROLL` – IRRF 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 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 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 identificationType: type: string enum: – SALARY_PROCEEDS_OR_ALLOWANCE – DEDUCTION – INFORMATIVE – DEDUCTIVE_INFORMATIVE description: Tipo Evento: * `SALARY_PROCEEDS_OR_ALLOWANCE` – Vencimento, provento ou pensão devida * `DEDUCTION` – Desconto * `INFORMATIVE` – Informativa * `DEDUCTIVE_INFORMATIVE` – Informativa dedutora 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 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 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 ordinationFieldsPayrollRegisterType: type: string enum: – LAST_CHANGE – EMPLOYEE_CODE – COMPETENCE – CALCULATION_DEFINITION_CODE – COMPANY_CODE – COMPANY_BRANCH_CODE description: Campos de ordenação do demonstrativo de pagamento: * `LAST_CHANGE` – Última modificação * `EMPLOYEE_CODE` – Código do colaborador * `COMPETENCE` – Competência * `CALCULATION_DEFINITION_CODE` – Código da definição de cálculo * `COMPANY_CODE` – Código da empresa * `COMPANY_BRANCH_CODE` – Código da filial ordinationFieldsFinancialStatementType: type: string enum: – CODE_WAGE_TYPE – REFERENCE – VALUE description: Campos de ordenação dos eventos do demonstrativo de pagamento: * `CODE_WAGE_TYPE` – Código do evento * `REFERENCE` – Referência * `VALUE` – Valor orderType: type: string enum: – ASC – DESC description: Tipos de ordenação: * `ASC` – Crescente * `DESC` – Decrescente directionNavigation: type: string enum: – NEXT – CURRENT – PREVIOUS description: Navegação: * `NEXT` – Próximo * `CURRENT` – Atual * `PREVIOUS` – Anterior totalizerType: type: string enum: – VALUE – REFERENCE description: Tipo do Totalizador: * `VALUE` – Valor * `REFERENCE` – Referência originType: type: string enum: – TYPED – CALCULATION description: Tipo de origem: * `TYPED` – Digitado * `CALCULATION` – Cálculo calculateType: type: string enum: – MONTH – VACATION – THIRTEENTH_SALARY – PLR description: Base cálculo: * `MONTH` – Mensal * `VACATION` – Férias * `THIRTEENTH_SALARY` – 13º salário * `PLR` – PLR otherContractType: type: string enum: – IN_COMPANY – OUT_COMPANY description: Tipo do outro contrato: * `IN_COMPANY` – Dentro da empresa * `OUT_COMPANY` – Fora da empresa registrationType: type: string enum: – CNPJ – CPF description: Tipo de inscrição: * `CNPJ` – CNPJ * `CPF` – CPF inssDiscountIndicatorType: type: string enum: – V1 – V2 – V3 description: Tipo de indicador de desconto: * `V1` – Desconto sobre remuneração total informada * `V2` – Desconto sobre diferença do teto e outras remunerações * `V3` – Sem desconto, já atingido teto em outra empresa processType: type: string enum: – ADMINISTRATIVE – JUDICIAL description: Tipo de processo: * `ADMINISTRATIVE` – Administrativo * `JUDICIAL` – Judicial sefipCategoryType: type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V11 – V12 – V13 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V99 description: Tipo da categoria SEFIP: * `V01` – Empregado * `V02` – Trabalhador avulso * `V03` – Trabalhador não vinculado ao RGPS, mas com direito ao FGTS * `V04` – Empregado sob contrato de trabalho por prazo determinado (Lei nº 9.601/98), com as alterações da Medida Provisória n° 2.164-41, de 24/08/2001 e Trabalhador Intermitente * `V05` – Contribuinte individual – Diretor não empregado com FGTS (Lei nº 8.036/90, art.16) * `V06` – Empregado doméstico * `V07` – Aprendiz e Trabalhador Contrato Verde e Amarelo – MP 905/2019 e Lei nº 11.180/2005 * `V11` – Contribuinte individual – Diretor não empregado e demais empresários sem FGTS * `V12` – Demais agentes públicos * `V13` – Contribuinte individual – Trabalhador autônomo ou a este equiparado, inclusive o operador de máquina, com contribuição sobre remuneração; trabalhador associado à cooperativa de produção * `V15` – Contribuinte individual – Transportador autônomo, com contribuição sobre remuneração * `V16` – Contribuinte individual – Transportador autônomo, com contribuição sobre salário-base * `V17` – Contribuinte individual – Cooperado que presta serviços a empresas contratantes da cooperativa de trabalho * `V18` – Contribuinte Individual – Transportador cooperado que presta serviços a empresas contratantes da cooperativa de trabalho * `V19` – Agente Político * `V20` – Servidor Público ocupante, exclusivamente, de cargo em comissão, Servidor Público ocupante de cargo temporário * `V21` – Servidor Público titular de cargo efetivo, magistrado, membro do Ministério Público e do Tribunal e Conselho de Contas * `V22` – Contribuinte individual – contratado por outro contribuinte individual equiparado a empresa ou por produtor rural pessoa física ou por missão diplomática e repartição consular de carreira estrangeiras * `V23` – Contribuinte individual – transportador autônomo contratado por outro contribuinte individual equiparado à empresa ou por produtor rural pessoa física ou por missão diplomática e repartição consular de carreira estrangeiras * `V24` – Contribuinte individual – Cooperado que presta serviços a entidade beneficente de assistência social isenta da cota patronal ou a pessoa física, por intermédio da cooperativa de trabalho * `V25` – Contribuinte individual – Transportador cooperado que presta serviços a entidade beneficente de assistência social isenta da cota patronal ou a pessoa física, por intermédio da cooperativa de trabalho * `V26` – Dirigente sindical, em relação ao adicional pago pelo sindicato; magistrado classista temporário da Justiça do Trabalho; magistrado dos Tribunais Eleitorais, quando, nas três situações, for mantida a qualidade de segurado empregado (sem FGTS) * `V99` – Não considera na SEFIP 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 valueType: type: string enum: – MONTH_OVERFLOW – MONTH_REFUND description: Tipo do valor: * `MONTH_OVERFLOW` – Estouro do mês * `MONTH_REFUND` – Troco do mês 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 deletePaymentInformationThirdPartyBatchDTO: description: DTO de exclusão coletiva do cálculo RPA type: object properties: competence: type: string format: date description: competência 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 filter: description: Filtros discriminator: _discriminator type: object required: – _discriminator properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores advancedFilter: type: string maxLength: 36 description: Filtro avançado _discriminator: type: string description: filterPayrollRegisterDTO: description: Filtros do demonstrativo de pagamento allOf: – #/definitions/filter – type: object properties: id: type: string maxLength: 36 description: Identificador calculationDefinition: type: string maxLength: 36 description: Cálculo competence: type: string format: date description: Competência ordinationPayrollRegister: description: Ordenação do demonstrativo de pagamento type: object required: – field – order properties: field: type: string allOf: – #/definitions/ordinationFieldsPayrollRegisterType description: Campo order: type: string allOf: – #/definitions/orderType description: Ordenação payrollRegisterDTO: description: Demonstrativo de pagamento type: object required: – id – processId – person – employee – calculationDefinition – codeCalculationDefinition – calculationType – competence – paymentDate – startDatePayroll – endDatePayroll properties: id: type: string description: Identificador do demonstrativo de pagamento processId: type: string description: Identificador do processo codeCompany: type: integer format: int64 description: Código da empresa nameCompany: type: string description: Nome empresa codeCompanyBranch: type: integer format: int64 description: Código da filial nameCompanyBranch: type: string description: Nome filial person: type: string description: Identificador da pessoa employee: type: string description: Colaborador codeEmployee: type: integer format: int64 description: Código do colaborador nameEmployee: type: string description: Nome colaborador codeJobPosition: type: integer format: int64 description: Código do cargo nameJobPosition: type: string description: Nome cargo calculationDefinition: type: string description: Definição de cálculo codeCalculationDefinition: type: integer format: int64 description: Código de cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data pagamento photoThumbnailUrl: type: string description: URL para a thumbnail da photo do colaborador startDatePayroll: type: string format: date description: Período inicial da folha endDatePayroll: type: string format: date description: Período final da folha navigationPayrollRegisterDTO: description: Demonstrativo de pagamento type: object required: – id – processId – employee – employeeCode – person – employeeName – calculationDefinition – codeCalculationDefinition – competence – calculationType – paymentDate – startDatePayroll – endDatePayroll properties: id: type: string description: Identificador do demonstrativo de pagamento processId: type: string description: Identificador do processo employee: type: string description: Identificador do colaborador employeeCode: type: integer format: int64 description: Código do colaborador person: type: string description: Identificador da pessoa employeeName: type: string description: Nome da pessoa calculationDefinition: type: string description: Identificador do código de cálculo codeCalculationDefinition: type: integer format: int64 description: Código de cálculo competence: type: string format: date description: Competência do código de cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo paymentDate: type: string format: date description: Data de Pagamento startDatePayroll: type: string format: date description: Período inicial da folha endDatePayroll: type: string format: date description: Período final da folha ordinationFinancialStatement: description: Ordenação dos eventos do demonstrativo de pagamento type: object required: – field – order properties: field: type: string allOf: – #/definitions/ordinationFieldsFinancialStatementType description: Campo order: type: string allOf: – #/definitions/orderType description: Ordenação financialStatementDTO: description: Demonstrativo de pagamento type: object required: – id – wageType – wageTypeCode – wageTypeName – identificationType – reference – value properties: id: type: string description: Identificador do evento calculado no demonstrativo de pagamento wageType: type: string description: Identificador do evento wageTypeCode: type: integer format: int64 description: Código do evento wageTypeName: type: string description: Nome do evento identificationType: type: string allOf: – #/definitions/identificationType description: Tipo do evento reference: type: number format: double description: Referência value: type: string description: Valor financialStatementWageTypeDTO: description: Informações da ficha financeira com o evento type: object required: – wageTypeId – code – characteristicType – ruleType – reference – value – processId properties: wageTypeId: type: string maxLength: 36 description: Identificador do evento calculado no demonstrativo de pagamento 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 processId: type: string maxLength: 36 description: Id do processo payrollRegisterInformationDTO: description: Informações do demonstrativo de pagamento type: object required: – id – baseSalary – dependentsIRRF – dependentsSalaryFamily – basesINSS – basesIRRF – basesFGTS – monthFGTS – totalAdjustmentHours – totalIncome – totalDiscounts – netValue properties: id: type: string description: Identificador das informações do demonstrativo de pagamento baseSalary: type: string description: Salário base dependentsIRRF: type: integer format: int64 description: Dependentes IRRF dependentsSalaryFamily: type: integer format: int64 description: Dependentes salário família basesINSS: type: string description: Base INSS basesIRRF: type: string description: Base IRRF basesFGTS: type: string description: Base FGTS monthFGTS: type: string description: FGTS do mês totalAdjustmentHours: type: integer format: int64 description: Total de horas apuradas totalIncome: type: string description: Total de proventos totalDiscounts: type: string description: Total de descontos netValue: type: string description: Total a receber/pagar companyData: description: Dados da empresa type: object required: – id – code – description properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código description: type: string description: Nome calculationDefinitionData: description: Dados do código de cálculo type: object required: – id – code – competence – calculationType – paymentDate – startDatePayroll – endDatePayroll properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código competence: type: string format: date description: Competência calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo paymentDate: type: string format: date description: Data de pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final advanceThirteenthSalaryPercentage: type: number format: double description: % adiantamento 13º lookupItem: description: Resultado de consulta de lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro filterBatchDTO: description: Filtro de batch type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores advancedFilter: type: string maxLength: 36 description: Identificador do filtro avançado deletePayrollRegisterBatchDTO: description: DTO de exclusão coletiva do demonstrativo de pagamento type: object required: – calculationDefinitionId properties: calculationDefinitionId: type: string description: Identificador da definição de cálculo payrollRegisterBatchItem: description: Item da exclusão em lote de demonstrativo de pagamento type: object required: – payrollRegisterId – calculationDefinitionId – employeeId – processId properties: payrollRegisterId: type: string description: Identificador do demonstrativo de pagamento calculationDefinitionId: type: string description: Identificador da definição de cálculo employeeId: type: string description: Identificador do colaborador processId: type: string description: Identificador do processo employeeDependentCompanyTransferData: description: Dados dos dependentes do colaborador transferido type: object required: – previousEmployeeDependent – newEmployeeDependent properties: previousEmployeeDependent: type: string maxLength: 36 description: Depentente origem newEmployeeDependent: type: string maxLength: 36 description: Dependente destino thirdPartyJudicialAlimonyPaymentHistoryDTO: description: DTO de Histórico de pagamentos da pensão judicial de terceiros type: object required: – employeeDependent – alimonyValue properties: id: type: string maxLength: 36 description: Identificador único employeeDependent: type: string maxLength: 36 description: Dependente alimonyValue: type: string description: Valor da pensão minimum: 0.0 financialStatementThirdPartyDTO: description: DTO das fichas financeiras de terceiros type: object required: – wageType – reference – value – originType properties: id: type: string maxLength: 36 description: Identificador único wageType: type: string maxLength: 36 description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 99999.98 value: type: string description: Valor minimum: 0.0 maximum: 999999999.99 originType: type: string allOf: – #/definitions/originType description: Origem paymentInformationThirdPartyDTO: description: DTO das informações de pagamentos para terceiros type: object required: – employee – competence – paymentDate – calculationSequence – thirdPartyPaymentReceiptNumber – companyBranch – companyLinkedLocation properties: id: type: string maxLength: 36 description: Identificador único employee: type: string maxLength: 36 description: Colaborador competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data de pagamento calculationSequence: type: integer format: int64 description: Sequência para o cálculo minimum: 0 maximum: 999 calculated: type: boolean description: Calculado default: false thirdPartyPaymentReceiptNumber: type: integer format: int64 description: Número do recibo de pagamento minimum: 0 descriptionServiceProvided: type: string maxLength: 255 description: Descrição do serviço prestado companyBranch: type: string maxLength: 36 description: Filial companyLinkedLocation: type: string maxLength: 36 description: Localização vinculada 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 nextCalculationEntryDTO: description: Informações do laçamento da proxima definição do cálculo type: object required: – employee – calculationDefinitionOrigin – reference – value – valueType properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinitionOrigin: type: string maxLength: 36 description: Código de cálculo origem reference: type: number format: double description: Referência minimum: 0.0 value: type: string description: Valor minimum: 0.0 valueType: type: string allOf: – #/definitions/valueType description: Tipo do valor financialStatement: description: Ficha financeira type: object required: – payrollRegister – wageType – reference – value properties: id: type: string format: uuid description: Identificador único payrollRegister: type: object allOf: – #/definitions/payrollRegister description: Demonstrativo de pagamento wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 value: type: string description: Valor minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFinancialStatement: type: object required: – id allOf: – #/definitions/financialStatement payrollRegister: description: Demonstrativo de pagamento type: object required: – employee – calculationDefinition – processId – competence – paymentDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo processId: type: string maxLength: 36 description: Identificador do processo payrollRegisterData: type: object allOf: – #/definitions/payrollRegisterData description: Informações do demonstrativo de pagamento competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data de pagamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: payrollRegisterInformation: description: Informações do demonstrativo de pagamento type: object required: – payrollRegister – baseSalary – dependentsIRRF – dependentsSalaryFamily – basesINSS – basesIRRF – basesFGTS – totalAdjustmentHours – totalIncome – totalDiscounts – netValue properties: id: type: string format: uuid description: Identificador único payrollRegister: type: object allOf: – #/definitions/payrollRegister description: Demonstrativo de pagamento baseSalary: type: string description: Salário base dependentsIRRF: type: integer format: int64 description: Dependentes IRRF dependentsSalaryFamily: type: integer format: int64 description: Dependentes salário família basesINSS: type: string description: Base INSS basesIRRF: type: string description: Base IRRF basesFGTS: type: string description: Base FGTS totalAdjustmentHours: type: integer format: int64 description: Total de horas apuradas totalIncome: type: string description: Total de proventos totalDiscounts: type: string description: Total de descontos netValue: type: string description: Total a receber/pagar createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: totalizerMonthlyInformation: description: Informações mensais do totalizador type: object required: – employee – calculationDefinitionOrigin – totalizer – value – originType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinitionOrigin: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo de origem totalizer: type: object allOf: – #/definitions/totalizer description: Totalizador value: type: string description: Valor 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: editTotalizerMonthlyInformation: type: object required: – id allOf: – #/definitions/totalizerMonthlyInformation payrollRegisterData: description: Informações do demonstrativo de pagamento type: object required: – baseSalary – dependentsIRRF – dependentsSalaryFamily – totalAdjustmentHours – totalIncome – totalDiscounts – netValue – totalThirteenthSalaryValue properties: id: type: string format: uuid description: Identificador único payrollRegister: type: object allOf: – #/definitions/payrollRegister description: Demonstrativo de pagamento baseSalary: type: string description: Salário base dependentsIRRF: type: integer format: int64 description: Dependentes de IRRF dependentsSalaryFamily: type: integer format: int64 description: Dependentes de salário família totalAdjustmentHours: type: integer format: int64 description: Total de horas apuradas totalIncome: type: string description: Total de proventos totalDiscounts: type: string description: Total de descontos netValue: type: string description: Total a receber/pagar totalThirteenthSalaryValue: type: string description: Total de 13º pago createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPayrollRegisterData: type: object required: – id allOf: – #/definitions/payrollRegisterData employeeDependentAlimonyHistory: description: Histórico de pensão judicial type: object required: – employeeDependent – calculationDefinitionOrigin – alimonyBaseType properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente calculationDefinitionOrigin: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo de origem alimonyBaseType: type: string allOf: – #/definitions/calculateType description: Tipo do cálculo 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: payrollRegisterDataBasisAndValues: description: Informações de bases e valores do demonstrativo de pagamento type: object required: – payrollRegisterData – detailCalculationType – inssBasis – inssValue – irrfBasis – irrfValue – fgtsBasis – fgtsValue – totalAlimony – totalLegalDeductionsWithoutDependents properties: id: type: string format: uuid description: Identificador único payrollRegisterData: type: object allOf: – #/definitions/payrollRegisterData description: Informações do demonstrativo de pagamento detailCalculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo do detalhe inssBasis: type: string description: Base do INSS inssValue: type: string description: Valor do INSS irrfBasis: type: string description: Base do IRRF irrfValue: type: string description: Valor do IRRF irrfPercentage: type: number format: double description: Percentual do IRRF minimum: 0.0 maximum: 100.0 fgtsBasis: type: string description: Base do FGTS fgtsValue: type: string description: Valor do FGTS totalAlimony: type: string description: Total de pensão totalLegalDeductionsWithoutDependents: type: string description: Total de deduções legais sem dependentes createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: calculationMonthlyInformation: description: Informações mensais do cálculo type: object required: – employee – calculationDefinition properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Definição de cálculo hasLessThanFifteenWorkingDays: type: boolean description: Possui menos de 15 dias trabalhados default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: paymentInformationThirdParty: description: Informações de pagamentos para terceiros type: object required: – employee – competence – paymentDate – calculationSequence – thirdPartyPaymentReceiptNumber – companyBranch – companyLinkedLocation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data de pagamento calculationSequence: type: integer format: int64 description: Sequência para o cálculo minimum: 0 maximum: 999 calculated: type: boolean description: Calculado default: false thirdPartyPaymentReceiptNumber: type: integer format: int64 description: Número do recibo de pagamento minimum: 0 descriptionServiceProvided: type: string maxLength: 255 description: Descrição do serviço prestado companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyLinkedLocation: type: object allOf: – #/definitions/companyLinkedLocation description: Localização vinculada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPaymentInformationThirdParty: type: object required: – id allOf: – #/definitions/paymentInformationThirdParty financialStatementThirdParty: description: Ficha financeira de terceiros type: object required: – paymentInformationThirdParty – wageType – reference – value – originType properties: id: type: string format: uuid description: Identificador único paymentInformationThirdParty: type: object allOf: – #/definitions/paymentInformationThirdParty description: Informações de pagamentos para terceiros wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 99999.98 value: type: string 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: thirdPartyJudicialAlimonyPaymentHistory: description: Histórico de pagamentos da pensão judicial de terceiros type: object required: – paymentInformationThirdParty – employeeDependent – alimonyValue properties: id: type: string format: uuid description: Identificador único paymentInformationThirdParty: type: object allOf: – #/definitions/paymentInformationThirdParty description: Informações de pagamentos para terceiros employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente alimonyValue: type: string description: Valor da pensão minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: thirdPartyPaymentBasesAndValues: description: Bases e valores de pagamento para terceiros type: object required: – paymentInformationThirdParty – dependentsIRRF – basesInss – valueInss – basesIrrf – valueIrrf – totalAlimony – totalIncome – totalDiscounts – netValue – totalLegalDeductionsWithoutDependents properties: id: type: string format: uuid description: Identificador único paymentInformationThirdParty: type: object allOf: – #/definitions/paymentInformationThirdParty description: Informações de pagamentos para terceiros dependentsIRRF: type: integer format: int64 description: Dependentes IRRF basesInss: type: string description: Base INSS valueInss: type: string description: Valor do INSS basesIrrf: type: string description: Base IRRF valueIrrf: type: string description: Valor do IRRF totalAlimony: type: string description: Total de pensão judicial totalIncome: type: string description: Total de proventos totalDiscounts: type: string description: Total de descontos netValue: type: string description: Total líquido totalLegalDeductionsWithoutDependents: type: string description: Total de deduções legais sem dependentes 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: 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 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 contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato 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. 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 desligamento code: type: integer format: int64 description: Cadastro employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes 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 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: 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: object allOf: – #/definitions/e070emp 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: object allOf: – #/definitions/jobPosition 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: 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: jobPosition: description: Cargo type: object required: – code – shortName properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 100 description: Nome x-i18n: true shortName: type: string maxLength: 30 description: Nome reduzido x-i18n: true 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: name: type: string maxLength: 100 shortName: type: string maxLength: 30 example: pt-BR: name: Exemplo de texto usando locale pt-BR.shortName: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale.shortName: Text example using en-US locale. 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 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: 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 – shortName 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 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 calculatedValue: type: string description: Valor Cálculo 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 referenceInMinutes: type: boolean description: Referência em minutos default: false deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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. totalizer: description: Totalizadores type: object required: – code – description – totalizerType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string description: Descrição totalizerType: type: string allOf: – #/definitions/totalizerType description: Tipo do totalizador deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeDependent: description: Dependentes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dependent: type: object allOf: – #/definitions/e001pes description: Dependente deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeOtherContracts: description: Outros contratos type: object required: – employee – competenceInitial – sequenceCalculation – otherContractType – individualTaxPayer – inssBasisMonthly – inssValueMonthly – inssBasisThirteenthSalary – inssValueThirteenthSalary – irrfBasisMonthly – irrfValueMonthly – irrfBasisThirteenthSalary – irrfValueThirteenthSalary – irrfBasisVacation – irrfValueVacation – simplifiedIrrfDeductionMonthly – simplifiedIrrfDeductionThirteenthSalary – simplifiedIrrfDeductionVacation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final sequenceCalculation: type: integer format: int64 description: Sequencia para o cálculo otherContractType: type: string allOf: – #/definitions/otherContractType description: Tipo do outro contrato registrationType: type: string allOf: – #/definitions/registrationType description: Tipo de inscrição registrationNumber: type: string description: Número de inscrição otherCompanyName: type: string description: Nome da outra empresa eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do eSocial individualTaxPayer: type: boolean description: Contribuinte individual inssBasisMonthly: type: string description: Base de INSS mensal inssValueMonthly: type: string description: Valor de INSS mensal inssBasisThirteenthSalary: type: string description: Base de INSS 13º salário inssValueThirteenthSalary: type: string description: Valor de INSS 13º salário irrfBasisMonthly: type: string description: Base de IRRF mensal irrfValueMonthly: type: string description: Valor de IRRF mensal irrfBasisThirteenthSalary: type: string description: Base de IRRF 13º salário irrfValueThirteenthSalary: type: string description: Valor de IRRF 13º salário irrfBasisVacation: type: string description: Base de IRRF férias irrfValueVacation: type: string description: Valor de IRRF férias simplifiedIrrfDeductionMonthly: type: string description: Deduções de IRRF simplificado no mês simplifiedIrrfDeductionThirteenthSalary: type: string description: Deduções de IRRF simplificado no 13º salário simplifiedIrrfDeductionVacation: type: string description: Deduções de IRRF simplificado nas férias inssDiscountIndicatorMonthly: type: string allOf: – #/definitions/inssDiscountIndicatorType description: Indicador de desconto do INSS mensal inssDiscountIndicatorThirteenthSalary: type: string allOf: – #/definitions/inssDiscountIndicatorType description: Indicador de desconto do INSS 13º salário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeOtherContracts: type: object required: – id allOf: – #/definitions/employeeOtherContracts accumulatedIncomeReceived: description: Rendimentos recebidos acumuladamente type: object required: – employee – calculationDefinition – processType – numberOfMonths properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Definição de cálculo processType: type: string allOf: – #/definitions/processType description: Tipo de processo processNumber: type: string description: Número de processo natureOfIncome: type: string maxLength: 50 description: Natureza do rendimento numberOfMonths: type: integer format: int64 description: Quantidade de meses minimum: 1 maximum: 9999 valueLegalExpenses: type: string description: Valor das despesas judiciais valueLawyerExpenses: type: string description: Valor das despesas com advogados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAccumulatedIncomeReceived: type: object required: – id allOf: – #/definitions/accumulatedIncomeReceived accumulatedIncomeReceivedLawyers: description: Identificação dos advogados de rendimentos recebidos acumuladamente type: object required: – accumulatedIncomeReceived – registrationType properties: id: type: string format: uuid description: Identificador único accumulatedIncomeReceived: type: object allOf: – #/definitions/accumulatedIncomeReceived description: Rendimentos recebidos acumuladamente registrationType: type: string allOf: – #/definitions/registrationType description: Tipo de inscrição registrationNumber: type: string description: Número de inscrição lawyerName: type: string maxLength: 60 description: Nome ou razão do advogado amountLawyerExpenses: type: string description: Valor da despesa do advogado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAccumulatedIncomeReceivedLawyers: type: object required: – id allOf: – #/definitions/accumulatedIncomeReceivedLawyers companyIndications: description: Assinalamentos da empresa type: object properties: id: type: string format: uuid description: Identificador único wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos company: type: object allOf: – #/definitions/e070emp description: Empresa deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employmentRelationshipPayroll: description: Vínculo empregatício – Definições da Folha type: object required: – sefipCategoryType – activityNatureType – calculatePayroll – thirteenSalary – createVacationPeriod – abroadProvidence – calculationByInssTaxRange – welfarePolicyType properties: id: type: string format: uuid description: Identificador único employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo sefipCategoryType: type: string allOf: – #/definitions/sefipCategoryType description: Categoria SEFIP 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 abroadProvidence: type: boolean description: Previdência exterior 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 nextCalculationEntry: description: Lançamento da próxima definição de cálculo type: object required: – employee – calculationDefinitionOrigin – reference – value – valueType – settled properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinitionOrigin: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo origem reference: type: number format: double description: Referência minimum: 0.0 value: type: string description: Valor minimum: 0.0 valueType: type: string allOf: – #/definitions/valueType description: Tipo do valor calculationDefinitionSettlement: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo da quitação settled: type: boolean description: Quitado? settlementDate: type: string format: date description: Data de quitação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNextCalculationEntry: type: object required: – id allOf: – #/definitions/nextCalculationEntry e070fil: description: Filial type: object required: – codFil – nomFil properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome 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: companyLinkedLocation: description: Localização vinculada da empresa type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade code: type: integer format: int64 description: Código name: type: string description: Nome x-i18n: true e070emp: type: object allOf: – #/definitions/e070emp description: Empresa extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação 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: 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. 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: 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