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

HCM – Payroll Financial Statement General Processor (general_processor)

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

2.0info: 8.16.0 HCM – Payroll Financial Statement General Processor description: HCM – Payroll Financial Statement General Processor x-senior-domain: HCM – Payroll Financial Statement General Processor x-senior-domain-path: hcm_payroll_financial_statement 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_financial_statementsecurityDefinitions: 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/validateEmployeeReintegrationDelete: post: description: Busca e valida a deleção da reintegração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – effectiveDate properties: employeeId: type: string description: Identificador único do colaborador effectiveDate: type: string format: date description: Data do retorno efetivo da reintegração responses: 200: description: Ok schema: type: object required: – valid – messages properties: valid: type: boolean description: Se é valida a deleção da reintegração messages: type: array items: type: string minimum: 1 description: Lista de mensagens dos históricos com data maior ou igual a data de retorno efetivo da reintegração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca e valida a deleção da reintegração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador único do colaborador in: query required: true type: string – name: effectiveDate description: Data do retorno efetivo da reintegração in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – valid – messages properties: valid: type: boolean description: Se é valida a deleção da reintegração messages: type: array items: type: string minimum: 1 description: Lista de mensagens dos históricos com data maior ou igual a data de retorno efetivo da reintegração 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/actions/calculateThirdParty: post: description: Inicia o processo de cálculo de RPA tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – filters properties: competence: type: string format: date description: Compentência paymentDate: type: string format: date description: Data de pagamento calculationSequence: type: integer format: int64 description: Sequencia de cálculo minimum: 0 maximum: 999 filters: type: object allOf: – #/definitions/filtersDTO description: Filtros responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/actions/generateMonthlyCalculationData: post: description: Geração de dados de cálculo mensal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – startCompetence – endCompetence properties: company: type: string maxLength: 36 description: Empresa employees: type: array items: type: string description: Colaboradores (vazio = todos) startCompetence: type: string format: date description: Competência inicial endCompetence: type: string format: date description: Competência final responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/actions/calculateThirteenthProvision: post: description: Inicia o cálculo (provisão) do 13º salário. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – filters properties: competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/filtersDTO description: Filtros de seleção responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/actions/generateThirdPartyCalculationData: post: description: Geração de dados de cálculo de pagamentos de terceiros (RPA) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – startCompetence – endCompetence properties: company: type: string maxLength: 36 description: Empresa employees: type: array items: type: string description: Colaboradores (vazio = todos) startCompetence: type: string format: date description: Competência inicial endCompetence: type: string format: date description: Competência final responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/actions/processAccounting: post: description: Inicia o Processamento Contabil tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – competence – postingDate properties: companyId: type: string description: Identificador da empresa calculationDefinitionId: type: string description: Identificador da definição de cálculo competence: type: string format: date description: Competência postingDate: type: string format: date description: Data de lançamento responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificar do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/actions/processAccountingBatch: post: description: Inicia o Fechamento Contábil tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – postingDate properties: companyId: type: string description: Identificador da empresa postingDate: type: string format: date description: Data de lançamento responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificar do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general_processor/signals/consolidateLayout: post: description: Consolida informações de ficha financeira dos colaboradores para geração dos leiautes do eSocial tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – batchSequence – filters properties: processId: type: string description: Identificador único do processo batchId: type: string description: Identificador único do lote layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequência do lote filters: type: array items: type: object allOf: – #/definitions/filterConsolidateLayout minimum: 1 description: Filtros responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/signals/finishedProcess: 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 – processType – processTypeDescription – startDate – startedBy – unit properties: processId: type: string description: Identificador único do processo processType: type: string description: Tipo de processo processTypeDescription: type: string description: Descrição do tipo do Processo. startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados default: 0 processed: type: integer format: int64 description: Quantidade total de registros processados processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro default: 0 successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso default: 0 unprocessed: type: integer format: int64 description: Quantidade de registros não processados default: 0 startedBy: type: string description: Usuário que iniciou o processo unit: type: string description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) cancelledBy: type: string description: Usuário que cancelou o processo cancellationDate: type: string format: date-time description: Data de cancelamento do processo 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 – companyInformation – totalCompanies 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 companyInformation: type: object allOf: – #/definitions/companyInformationDTO description: Informações da empresa totalCompanies: type: integer format: int64 description: Empresas processadas minimum: 0 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/signals/consolidateThirteenthProvisionTaxCalculation: post: description: Consolida informações das fichas financeiras para a conferência de impostos da provisão do 13º salário (INSS/PIS) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchSequence – competence – companyInformation – totalCompanies 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 consolidação por exercício (ano civil) default: false companyInformation: type: object allOf: – #/definitions/companyInformationDTO description: Informações da empresa totalCompanies: type: integer format: int64 description: Empresas processadas minimum: 0 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/signals/generateCalculationDataByCompetence: post: description: Inicia o processamento dos dados de cálculo por competência tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – companyId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo employees: type: array items: type: string description: Colaboradores excludedEmployees: type: array items: type: string description: Colaboradores excluídos do processo companyId: type: string maxLength: 36 description: Identificador da empresa processType: type: string description: Tipo de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/events/previousCalculationsAccumulationFinished: post: description: Notifica a conclusão da acumulação de bases anteriores. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/consolidateTotalizersFinished: post: description: Notifica a conclusão da consolidação dos totalizadores. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/dismissalSupplementaryLaborAgreementIntegrationFinished: post: description: Notifica o fim da integração dos cálculo de origem para rescisão complementar de dissídio. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/layoutConsolidationFinished: post: description: Evento que comunica a finalização da consolidação do leiaute do eSocial x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – batchSequence properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores errorMessage: type: string description: Mensagem de erro urlData: type: string description: Link dos dados layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequencial do lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/selectEmployeePaymentInformationThirdPartyFinished: post: description: Evento que notifica a finalização da seleção dos colaboradores com informações de pagamento para terceiros. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/thirteenthProvisionPreviousBalanceFinished: post: description: Evento que notifica a conclusão do preparo do lote da provisão do 13º salário — as DUAS cargas do preparo em uma única confirmação: a do saldo anterior (hash do colaborador, campo THIRTEENTH_PROVISION_PREVIOUS_BALANCE) e a da baixa do adiantamento da 1ª parcela e da quitação da 2ª parcela/13º integral (campo THIRTEENTH_PROVISION_WRITE_OFF). Quando o evento é publicado as duas já estão gravadas no cache. Etapa própria do pipeline do lote: confirma no portão do orquestrador junto das demais consolidações. É publicado SEMPRE que o lote é da provisão do 13º — inclusive quando não há saldo anterior (primeira competência do exercício), quando nenhum colaborador tem recibo de adiantamento ou de quitação, e quando a leitura ou a gravação no cache falham —, do contrário o lote nunca fecharia o portão. A recíproca também vale: nunca é publicado com uma das duas cargas não executada. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON cachedEmployees: type: integer format: int64 description: Quantidade de colaboradores com saldo anterior gravado no cache writeOffCachedEmployees: type: integer format: int64 description: Quantidade de colaboradores com baixa (adiantamento e/ou quitação) gravada no cache. Contagem independente de cachedEmployees — os dois conjuntos de colaboradores são distintos e não devem ser somados. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/supplementaryLaborAgreementAccumulationFinished: post: description: Notifica a conclusão da acumulação de bases anteriores para cálculo de dissídio. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/supplementaryPayrollCalculatedDefinitionsSelectionFinished: post: description: Notifica que as definições de cálculo com recibo de cada colaborador do lote da folha complementar foram gravadas no cache. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/paymentInformationThirdPartySelectionFinished: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/accountingProcessingStarted: post: description: Notifica o início do processamento contábil x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – companyId – competence – postingDate properties: processId: type: string maxLength: 36 description: Identificador do processo companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo postingDate: type: string format: date description: Data de lançamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/accountingClosingStarted: post: description: Notifica o início do fechamento contábil x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – companyId – postingDate properties: processId: type: string description: Identificador do processo companyId: type: string description: Identificador da empresa postingDate: type: string format: date description: Data de lançamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/accountingPayrollEmployeeSelectionFinished: post: description: Notifica a conclusão da seleção de colaboradores do payrollRegister (S-3.4). x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – companyId – competence – postingDate properties: processId: type: string maxLength: 36 description: Identificador do processo companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo (opcional) postingDate: type: string format: date description: Data de lançamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/accountingPayrollRegisterBatchFinished: post: description: Notifica a conclusão da coleta de demonstrativos de pagamento por lote. Dispara a S-3.16 (coleta dismissal). x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – companyId – competence – postingDate – batchDescription properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo (opcional) postingDate: type: string format: date description: Data de lançamento batchDescription: type: string description: Descrição do lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/accountingBatchFinished: post: description: Notifica o orchestrator que o pipeline de um lote foi concluído. Incrementa o progresso e, ao atingir o total, auto-finaliza o processo. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – companyId – competence – postingDate properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo (opcional) postingDate: type: string format: date description: Data de lançamento 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 – companyInformation – totalCompanies 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 companyInformation: type: object allOf: – #/definitions/companyInformationDTO description: Informações da empresa totalCompanies: type: integer format: int64 description: Empresas processadas minimum: 0 responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/thirteenthProvisionTaxCalculationConsolidationFinished: post: description: Evento de comunicação que a consolidação da conferência de impostos da provisão do 13º salário foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchSequence – competence – companyInformation – totalCompanies 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 consolidação por exercício (ano civil) default: false errorMessage: type: string description: Mensagem de erro companyInformation: type: object allOf: – #/definitions/companyInformationDTO description: Informações da empresa totalCompanies: type: integer format: int64 description: Empresas processadas minimum: 0 responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/generateCalculationDataByCompetenceStarted: post: description: Dispara os carregamentos por competência (wage-type) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – companyId – competence – processType properties: processId: type: string maxLength: 36 description: Identificador do processo companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência processType: type: string description: Tipo de processo employees: type: array items: type: string description: Colaboradores responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/loadCalculationBatchData: post: description: Evento interno — dispara a seleção pesada de payrollRegisters para um lote (autoconsumo no financial-statement-processor) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence – processType properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote competence: type: string format: date description: Competência employees: type: array items: type: string description: Colaboradores processType: type: string description: Tipo de processo excludedEmployees: type: array items: type: string description: Colaboradores excluídos do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/generateMonthlyCalculationDataBatchStarted: post: description: Dispara os carregamentos por lote de colaboradores (additional-info, employee, contract) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence – processType properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote competence: type: string format: date description: Competência processType: type: string description: Tipo de processo employees: type: array items: type: string description: Colaboradores excludedEmployees: type: array items: type: string description: Colaboradores excluídos do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/generateThirdPartyDataBatchStarted: post: description: Dispara os carregamentos por lote de colaboradores para cálculo de terceiros x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – competence – processType properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote competence: type: string format: date description: Competência processType: type: string description: Tipo de processo employees: type: array items: type: string description: Colaboradores excludedEmployees: type: array items: type: string description: Colaboradores excluídos do processo 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 – VACATION_PROVISION – THIRTEENTH_PROVISION description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `INDIVIDUAL_VACATION` – Férias individuais * `COLLECTIVE_VACATION` – Férias coletivas * `DISMISSAL` – Rescisão individual * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio * `THIRD_PARTY_PAYMENT` – Cálculo de RPA * `VACATION_PROVISION` – Provisão de férias * `THIRTEENTH_PROVISION` – Provisão de décimo terceiro 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 filterConsolidateLayout: description: Filtros para consolidação dos leiautes do eSocial type: object required: – referenceDate properties: referenceDate: type: string format: date description: Data de referência annualCalculationIndicator: type: boolean description: Indicativo de cálculo anual/13º salário default: false employees: type: array items: type: string description: Identificadores únicos dos colaboradores calculationDefinitions: type: array items: type: string description: Identificadores únicos das definições de cálculo calculationDefinitionsTypePaymentDate: type: array items: type: string description: Identificadores únicos das definições de cálculo filtradas por data de pagamento dependentIds: type: array items: type: string description: Identificadores únicos dos dependentes filtersDTO: description: Filtros type: object properties: companies: type: array items: type: string description: Identificadores únicos das empresas employees: type: array items: type: string description: Identificadores únicos dos colaboradores advancedFilter: type: string maxLength: 36 description: Filtros avançados companyInformationDTO: description: Informações da empresa para conferência de impostos type: object required: – id – totalCompanyBatches properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome totalCompanyBatches: type: integer format: int64 description: Quantidade de lotes da empresa 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

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

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

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