2.0info: 2.5.1 HCM – Payroll Foundation General Processor description: HCM – Payroll Foundation General Processor x-senior-domain: HCM – Payroll Foundation General Processor x-senior-domain-path: hcm_payroll_foundation x-senior-service-path: general_processor 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_foundationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general_processor/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_processor/queries/findAllSituationPayrollThatInfluenceVacation: post: description: Busca todas as definições de folha das situações que influenciam as férias separadas por competência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object properties: situationPayrollsThatInfluenceVacation: type: array items: type: object allOf: – #/definitions/situationPayrollThatInfluenceVacation description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as definições de folha das situações que influenciam as férias separadas por competência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object properties: situationPayrollsThatInfluenceVacation: type: array items: type: object allOf: – #/definitions/situationPayrollThatInfluenceVacation description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/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_processor/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_processor/signals/selectGeneralInformation: post: description: Carrega as informações do vínculo empregatício da empresa e da estrutura de situações (para férias) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Id do processo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo calculationDefinitionId: type: string description: Id das definições do código de cálculo. logDebugEnabled: type: boolean description: Log de depuração habilitado default: false employees: type: array items: type: string description: Lista de colaboradores monitorEnabled: type: boolean description: Monitor habilitado default: false startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias filters: type: object allOf: – #/definitions/filtersDTO description: Filtros advancedFilter: type: string maxLength: 36 description: Identificador do filtro avançado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/signals/consolidateLayout: post: description: Busca as informações gerais da folha para a consolidação de leaiutes do eSocial. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – layoutReference properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequência do lote layoutReference: type: array items: type: object allOf: – #/definitions/layoutReference minimum: 1 description: Referência para o leiaute responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/signals/consolidateTaxCalculation: post: description: Solicitar informações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote batchSequence: type: integer format: int64 description: Sequência do lote competence: type: string format: date description: Competência annualCalculationIndicator: type: boolean description: Indicativo de cálculo anual/13º salário default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/events/foundationPayrollAdditionalInfoFinished: post: description: Notifica a finalização da consolidação de informações adicionais do lote de colaboradores. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string description: Id do processo. batchId: type: string 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 calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/foundationPayrollFinished: post: description: Notifica a finalização da consolidação de informações do lote dos colaboradores. 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 logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/layoutConsolidationFinished: post: description: Evento de comunicação que a consolidação do leiaute foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequência do lote errorMessage: type: string description: Mensagem de erro urlData: type: string description: Link dos dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/taxCalculationConsolidationFinished: post: description: Evento de comunicação que a consolidação da conferência de impostos foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote batchSequence: type: integer format: int64 description: Sequência do lote competence: type: string format: date description: Competência annualCalculationIndicator: type: boolean description: Indicativo de cálculo anual/13º salário default: false errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/dismissalSupplementaryCalculationDefinitionOriginSelectionFinished: post: description: Notifica o fim da seleção de cálculo origem para rescisão complementar – Dissídio. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription – dismissalSchedule – filters properties: processId: type: string maxLength: 36 description: Id do processo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. batchDescription: type: string description: Descrição dismissalSchedule: type: string maxLength: 36 description: Identificador da programação de rescisão logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final filters: type: object allOf: – #/definitions/filtersDTO description: Filtros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/companyLocationTaxSelectionFinished: post: description: Notifica o fim da seleção das informações de impostos da localização vínculada a empresa. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – calculationType – competence properties: processId: type: string description: Id do processo 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 de pagamento 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/genericErrordefinitions: 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 – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL – THIRD_PARTY_PAYMENT description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `INDIVIDUAL_VACATION` – Férias individuais * `COLLECTIVE_VACATION` – Férias coletivas * `DISMISSAL` – Rescisão individual * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – dissídio * `THIRD_PARTY_PAYMENT` – Cálculo de RPA calculationDefinitionCalculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL description: Tipo de cálculo da definição de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `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 generateNegativeType: type: string enum: – YES – NO – VACATION_PREMIUM description: Tipo de geração negativa: * `YES` – Sim * `NO` – Não * `VACATION_PREMIUM` – Abonado hiredInTheYearType: type: string enum: – NEGATIVE_BALANCE_PERIOD – PAID_LEAVE – PAY_ENTITLEMENT_VACATION_DAYS – ENDS_PERIOD_REGARDLESS_BALANCE description: Tipo de admitidos no ano: * `NEGATIVE_BALANCE_PERIOD` – Período com saldo negativo * `PAID_LEAVE` – Licença remunerada folha * `PAY_ENTITLEMENT_VACATION_DAYS` – Quita para direito = dias de férias * `ENDS_PERIOD_REGARDLESS_BALANCE` – Encerra período independente de saldo hiredInCurrentYearType: type: string enum: – CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN – OPEN_NEW_ACQUISITIVE_PERIOD description: Admitidos no ano: * `CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN` – Período aquisitivo permanece aberto. Apenas fecha o período aquisitivo se os dias de direito forem totalmente consumidos. * `OPEN_NEW_ACQUISITIVE_PERIOD` – Abre novo período aquisitivo. 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 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 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/calculationDefinitionCalculationType 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º filtersDTO: description: Filtros type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores layoutReference: description: Referência do leiaute type: object required: – dateReference properties: dateReference: type: string format: date description: Data de referência collectiveNegotiation: type: array items: type: string description: Negociação coletiva employmentRelationship: type: array items: type: string description: Vínculo companies: type: array items: type: string description: Empresas annualCalculationIndicator: type: boolean description: Indicativo de cálculo anual default: false companyBranches: type: array items: type: string description: Filiais workshifts: type: array items: type: string description: Escalas companyLinkedLocations: type: array items: type: string description: Localizações vinculadas da empresa situationPayrollThatInfluenceVacation: description: Definições de folha das situações que influênciam as férias separados por competência type: object required: – competenceDate properties: competenceDate: type: string format: date description: Data da competência situationPayrollsThatInfluenceVacationDetails: type: array items: type: object allOf: – #/definitions/situationPayrollThatInfluenceVacationDetail description: Definições de folha das situações que influênciam as férias situationPayrollThatInfluenceVacationDetail: description: Definição de folha que influência as férias type: object required: – situationId – situationType – vacationInfluenceType properties: situationId: type: string description: Identificador único da situação situationType: type: string description: Tipo da situação vacationInfluenceType: type: string description: Tipo de influência de férias 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. 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