HCM – Esocial Generator Processor (processor)

2.0info: 1.4.0 HCM – Esocial Generator Processor description: HCM – Esocial Generator Processor x-senior-domain: HCM – Esocial Generator Pendency x-senior-domain-path: hcm_esocial_generator x-senior-service-path: 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_esocial_generatorsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /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 /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 /processor/queries/exportPendencyGeneratorControl: 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 /processor/queries/exportPendencyGeneratorControlData: 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 /processor/queries/exportNonPeriodicPendency: 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 /processor/queries/exportPeriodicPendency: 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 /processor/queries/exportTablePendency: 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 /processor/queries/exportHashSyndicateHistory: 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 /processor/queries/exportPendencyGenerateBatch: 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 /processor/queries/exportHashEmploymentRelationshipHistory: 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 /processor/queries/exportESocialCompanyInscription: 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 /processor/queries/exportESocialAdmissionInformation: 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 /processor/queries/exportESocialDefinitionPayroll: 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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/queries/exportSituation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/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 /processor/queries/exportESocialDefinition: 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 /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 /processor/actions/requestGenerateNonPeriodic: post: description: Solicita geração de leiautes não periódicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendency properties: pendency: type: array items: type: string minimum: 1 description: Pendencias a processar responses: 200: description: Ok schema: type: object required: – processId – refusedPendency properties: processId: type: string description: Identificador da geração refusedPendency: type: array items: type: string minimum: 1 description: Pendências recusadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/generatePendency: post: description: Gera pendências de qualquer leiaute tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layout – company – startDate – reference properties: layout: type: integer format: int64 description: Código do leiaute company: type: string description: Código da empresa annualCalculationIndicator: type: boolean description: Indicativo de apuração anual default: false startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de fim reference: type: string description: Referência para o leiute responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador de pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/requestGenerateTable: post: description: Solicita geração de leiautes de tabelas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendency properties: pendency: type: array items: type: string minimum: 1 description: Pendências a processar responses: 200: description: Ok schema: type: object required: – processId – refusedPendency properties: processId: type: string description: Identificador da geração refusedPendency: type: array items: type: string minimum: 1 description: Pendências recusadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/requestGeneratePeriodic: post: description: Solicita geração de leiautes periódicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendency properties: pendency: type: array items: type: string minimum: 1 description: Pendências a processar responses: 200: description: Ok schema: type: object required: – processId – refusedPendency properties: processId: type: string description: Identificador da geração refusedPendency: type: array items: type: string minimum: 1 description: Pendências recusadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/requestGenerateTableSynthetic: post: description: Solicita geração sintética de leiautes de tabelas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pendency: type: array items: type: object allOf: – #/definitions/pendencyTableSynthetic description: Pendência filter: type: object allOf: – #/definitions/filterTable description: Filtro para geração responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador da geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/requestGenerateNonPeriodicSynthetic: post: description: Solicita a geração sintética de leiautes não periódicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pendency: type: array items: type: object allOf: – #/definitions/pendencyNonPeriodicSynthetic description: Pendência filter: type: object allOf: – #/definitions/filterNonPeriodic description: Filtro para geração responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador da geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/requestGeneratePeriodicSynthetic: post: description: Solicita a geração sintética de leiautes periódicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pendency: type: array items: type: object allOf: – #/definitions/periodicPendencySynthetic description: Dados da pendência filter: type: object allOf: – #/definitions/filterPeriodic description: Filtros para geração responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador único da geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/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 /processor/actions/importPendencyGeneratorControl: 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 /processor/actions/importPendencyGeneratorControlData: 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 /processor/actions/importNonPeriodicPendency: 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 /processor/actions/importPeriodicPendency: 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 /processor/actions/importTablePendency: 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 /processor/actions/importHashSyndicateHistory: 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 /processor/actions/importPendencyGenerateBatch: 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 /processor/actions/importHashEmploymentRelationshipHistory: 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 /processor/actions/importESocialCompanyInscription: 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 /processor/actions/importESocialAdmissionInformation: 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 /processor/actions/importESocialDefinitionPayroll: 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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/actions/importSituation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/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 /processor/actions/importESocialDefinition: 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 /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 /processor/signals/generateNonPeriodic: post: description: Processa a geração não periódica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – batchSequence properties: processId: type: string description: Identificador da geração batchId: type: string description: Identificador do lote da geração layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/generateTable: post: description: Processa a geração de tabelas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – batchSequence properties: processId: type: string description: Identificador da geração batchId: type: string description: Identificador do lote da geração layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/generatePeriodic: post: description: Processa a geração periódica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – batchSequence properties: processId: type: string description: Identificador da geração batchId: type: string description: Identificador do lote da geração layout: type: integer format: int64 description: Leiaute batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/createNonPeriodicPendency: post: description: Cria pendência não periódica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – createNonPeriodicPendencyDTO properties: createNonPeriodicPendencyDTO: type: array items: type: object allOf: – #/definitions/createNonPeriodicPendencyDTO minimum: 1 description: Pendências não periódicas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/createPeriodicPendency: post: description: Cria pendência periódica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – periodicPendency properties: periodicPendency: type: array items: type: object allOf: – #/definitions/createPeriodicPendencyDTO minimum: 1 description: Pendências periódicas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/createTablePendency: post: description: Cria pendência de tabelas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tablePendency properties: tablePendency: type: array items: type: object allOf: – #/definitions/createTablePendencyDTO minimum: 1 description: Pendências de tabelas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/requestGenerateBatchTable: post: description: Solicita a geração de leiautes de tabelas por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layout – processId – batchSequence properties: layout: type: integer format: int64 description: Leiaute processId: type: string description: Identificador da geração batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/requestGenerateBatchNonPeriodic: post: description: Solicita a geração de leiautes não periódicos por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layout – processId – batchSequence properties: layout: type: integer format: int64 description: Leiaute processId: type: string description: Identificador da geração batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/requestGenerateBatchPeriodic: post: description: Solicita a geração de leiautes periódicos por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layout – processId – batchSequence properties: layout: type: integer format: int64 description: Leiaute processId: type: string description: Identificador da geração batchSequence: type: integer format: int64 description: Sequencial do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/events/importPendencyGeneratorControlEvent: post: description: 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 /processor/events/exportPendencyGeneratorControlEvent: post: description: 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 /processor/events/importPendencyGeneratorControlDataEvent: post: description: 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 /processor/events/exportPendencyGeneratorControlDataEvent: post: description: 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 /processor/events/importNonPeriodicPendencyEvent: post: description: 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 /processor/events/exportNonPeriodicPendencyEvent: post: description: 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 /processor/events/importPeriodicPendencyEvent: post: description: 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 /processor/events/exportPeriodicPendencyEvent: post: description: 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 /processor/events/importTablePendencyEvent: post: description: 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 /processor/events/exportTablePendencyEvent: post: description: 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 /processor/events/importHashSyndicateHistoryEvent: post: description: 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 /processor/events/exportHashSyndicateHistoryEvent: post: description: 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 /processor/events/importPendencyGenerateBatchEvent: post: description: 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 /processor/events/exportPendencyGenerateBatchEvent: post: description: 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 /processor/events/importHashEmploymentRelationshipHistoryEvent: post: description: 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 /processor/events/exportHashEmploymentRelationshipHistoryEvent: post: description: 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 /processor/events/importESocialCompanyInscriptionEvent: post: description: 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 /processor/events/exportESocialCompanyInscriptionEvent: post: description: 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 /processor/events/importESocialAdmissionInformationEvent: post: description: 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 /processor/events/exportESocialAdmissionInformationEvent: post: description: 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 /processor/events/importESocialDefinitionPayrollEvent: post: description: 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 /processor/events/exportESocialDefinitionPayrollEvent: post: description: 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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/events/importSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /processor/events/exportSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /processor/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 /processor/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 /processor/events/importESocialDefinitionEvent: post: description: 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 /processor/events/exportESocialDefinitionEvent: post: description: 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 /processor/entities/pendencyGeneratorControl: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pendencyGeneratorControl responses: 200: description: The created resource schema: #/definitions/pendencyGeneratorControl 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/pendencyGeneratorControl responses: 200: description: The created resource schema: #/definitions/pendencyGeneratorControl 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/pendencyGeneratorControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/pendencyGeneratorControl/{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/editPendencyGeneratorControl responses: 200: description: Ok schema: #/definitions/editPendencyGeneratorControl 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/pendencyGeneratorControl responses: 200: description: Ok schema: #/definitions/pendencyGeneratorControl 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/pendencyGeneratorControl 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 /processor/entities/pendencyGeneratorControl/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pendencyGeneratorControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/pendencyGeneratorControlData: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pendencyGeneratorControlData responses: 200: description: The created resource schema: #/definitions/pendencyGeneratorControlData 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/pendencyGeneratorControlData responses: 200: description: The created resource schema: #/definitions/pendencyGeneratorControlData 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/pendencyGeneratorControlData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/pendencyGeneratorControlData/{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/editPendencyGeneratorControlData responses: 200: description: Ok schema: #/definitions/editPendencyGeneratorControlData 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/pendencyGeneratorControlData responses: 200: description: Ok schema: #/definitions/pendencyGeneratorControlData 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/pendencyGeneratorControlData 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 /processor/entities/pendencyGeneratorControlData/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pendencyGeneratorControlData responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialCompanyInscription: 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/eSocialCompanyInscription responses: 200: description: The created resource schema: #/definitions/eSocialCompanyInscription 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/eSocialCompanyInscription responses: 200: description: The created resource schema: #/definitions/eSocialCompanyInscription 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/eSocialCompanyInscription 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialCompanyInscription/{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/editESocialCompanyInscription responses: 200: description: Ok schema: #/definitions/editESocialCompanyInscription 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/eSocialCompanyInscription responses: 200: description: Ok schema: #/definitions/eSocialCompanyInscription 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/eSocialCompanyInscription 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 /processor/entities/eSocialCompanyInscription/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialCompanyInscription responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialAdmissionInformation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialAdmissionInformation responses: 200: description: The created resource schema: #/definitions/eSocialAdmissionInformation 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/eSocialAdmissionInformation responses: 200: description: The created resource schema: #/definitions/eSocialAdmissionInformation 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/eSocialAdmissionInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialAdmissionInformation/{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/editESocialAdmissionInformation responses: 200: description: Ok schema: #/definitions/editESocialAdmissionInformation 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/eSocialAdmissionInformation responses: 200: description: Ok schema: #/definitions/eSocialAdmissionInformation 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/eSocialAdmissionInformation 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 /processor/entities/eSocialAdmissionInformation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialAdmissionInformation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialDefinitionPayroll: 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/eSocialDefinitionPayroll responses: 200: description: The created resource schema: #/definitions/eSocialDefinitionPayroll 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/eSocialDefinitionPayroll responses: 200: description: The created resource schema: #/definitions/eSocialDefinitionPayroll 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/eSocialDefinitionPayroll 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/eSocialDefinitionPayroll/{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/editESocialDefinitionPayroll responses: 200: description: Ok schema: #/definitions/editESocialDefinitionPayroll 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/eSocialDefinitionPayroll responses: 200: description: Ok schema: #/definitions/eSocialDefinitionPayroll 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/eSocialDefinitionPayroll 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 /processor/entities/eSocialDefinitionPayroll/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialDefinitionPayroll responses: 200: description: The bulk creation has created resources 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 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 nonPeriodicType: type: string enum: – CONTRACTUAL_CHANGE – PERSONAL_CHANGE – LEAVE_HISTORY – DISMISSAL description: Tipo de pendência não periódica: * `CONTRACTUAL_CHANGE` – Alteração contratual * `PERSONAL_CHANGE` – Alteração cadastral * `LEAVE_HISTORY` – Afastamento * `DISMISSAL` – Rescisão filterStatusPendencyType: type: string enum: – WAITING – ERROR – PROCESSING – DEPENDENCY description: Tipo de status da pendência para filtro: * `WAITING` – Aguardando processamento * `ERROR` – Com erro * `PROCESSING` – Processando * `DEPENDENCY` – Dependência environmentType: type: string enum: – PRODUCTION – RESTRICTED_PRODUCTION description: Tipo de ambiente (Criado na lib hcm-esocialcommons): * `PRODUCTION` – Produção * `RESTRICTED_PRODUCTION` – Produção restrita eSocialGroup: type: string enum: – G1 – G2 – G3 – G4 description: Grupo de Entrada: * `G1` – Grandes Empresas * `G2` – Empresas Não Optantes Simples Nacional * `G3` – Empresas Sem Fins Lucrativos ou Optantes Simples Nacional * `G4` – Orgãos Públicos Federal Organizações Internacionais inscriptionType: type: string enum: – V01 – V02 description: Tipo de inscrição: * `V01` – CNPJ * `V02` – CPF userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: Check executado type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status createNonPeriodicPendencyDTO: description: Dados para criação de pendência não periódica type: object required: – employeeId – nonPeriodicType – startDate – reason properties: employeeId: type: string description: Identificador do colaborador nonPeriodicType: type: string allOf: – #/definitions/nonPeriodicType description: Tipo de pendência não periódica startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final reason: type: string description: Razão effectDate: type: string format: date description: Data de efeito isEmployeeExclusion: type: boolean description: Indicativo de exclusão do colaborador default: false createPeriodicPendencyDTO: description: Dados para criação de pendência periódica type: object required: – company – reference – competenceCalculation – layout – reason properties: company: type: string description: Identificador do empresa reference: type: string description: Identificador de referência annualCalculationIndicator: type: boolean description: Indicativo de apuração anual default: false competenceCalculation: type: string format: date description: Competência de apuração layout: type: integer format: int64 description: Leiaute reason: type: string description: Razão createTablePendencyDTO: description: Dados para criação da pendência de tabela type: object required: – company – reference – layout – reason properties: company: type: string description: Identificador do empresa reference: type: string description: Identificador de referência layout: type: integer format: int64 description: Tipo de pendência não periódica startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final reason: type: string description: Razão pendencyTableSynthetic: description: Dados para geração de leiaute de tabela de forma sintética type: object required: – layout – company properties: layout: type: integer format: int64 description: Leiaute company: type: string description: Empresa filterTable: description: Filtro para geração leiaute de tabela de forma sintética type: object properties: layout: type: array items: type: integer format: int64 description: Leiaute status: type: string allOf: – #/definitions/filterStatusPendencyType description: Tipo de status da pendência startDate: type: string format: date description: Início da pendência endDate: type: string format: date description: Fim da pendência startCreateDate: type: string format: date description: Data início de criação endCreateDate: type: string format: date description: Data fim de criação company: type: string description: Empresa companyBranch: type: string description: Filial da empresa wageType: type: string description: Evento process: type: string description: Processo pendencyNonPeriodicSynthetic: description: Dados para geração de leiaute não periódico de forma sintética type: object required: – layout – company properties: layout: type: integer format: int64 description: Leiaute company: type: string description: Empresa filterNonPeriodic: description: Filtro para geração de leiaute não periódico de forma sintética type: object properties: layout: type: array items: type: integer format: int64 description: Leiaute status: type: string allOf: – #/definitions/filterStatusPendencyType description: Tipo de status da pendência startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final startCreateDate: type: string format: date description: Data início da criação endCreateDate: type: string format: date description: Data fim da criação company: type: string description: Empresa employee: type: string description: Colaborador periodicPendencySynthetic: description: Dados para geração de leiaute periódico de forma sintética type: object required: – layout – company – annualCalculationIndicator – competence properties: layout: type: integer format: int64 description: Leiaute company: type: string description: Empresa annualCalculationIndicator: type: boolean description: Indicativo de apuração anual competence: type: string format: date description: Competência filterPeriodic: description: Filtros para geração leiaute periódico de forma sintética type: object properties: layout: type: array items: type: integer format: int64 description: Leiaute startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final status: type: string allOf: – #/definitions/filterStatusPendencyType description: Tipo de status da pendência annualCalculationIndicator: type: boolean description: Indicativo de apuração anual company: type: array items: type: string description: Empresa employeeRegistration: type: string description: CPF do colaborador startCreateDate: type: string format: date description: Data inicial de criação endCreateDate: type: string format: date description: Data final de criação discardedPendencyDTO: description: Dados necessários para descartar uma pendência type: object required: – discardedMessage – company – layout – referenceDate – reference properties: discardedMessage: type: string description: Mensagem de descarte company: type: string description: Identificador da empresa layout: type: integer format: int64 description: Leiaute referenceDate: type: string format: date description: Data de referência do leiaute reference: type: string description: Informação de referência do layout annualCalculationIndicator: type: boolean description: Indicativo de apuração anual default: false supplementaryLaborAgreementIndicator: type: boolean description: Indicativo de dissídio default: false pendencyGeneratorControl: description: Controle de geração type: object required: – processId – layout – pendencies – qtdExpected – qtdReceived – hasError properties: id: type: string format: uuid description: Identificador único processId: type: string description: Identificador geral do processo layout: type: integer format: int64 description: Leiaute pendencies: type: string description: Identificadores das pendências qtdExpected: type: integer format: int64 description: Quantidade de dados esperado qtdReceived: type: integer format: int64 description: Quantidade de dados recebido hasError: type: boolean description: Indicador se houver erro na recuperação de dados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPendencyGeneratorControl: type: object required: – id allOf: – #/definitions/pendencyGeneratorControl pendencyGeneratorControlData: description: Dados de controle de geração type: object required: – pendencyGeneratorControl – origin properties: id: type: string format: uuid description: Identificador único pendencyGeneratorControl: type: object allOf: – #/definitions/pendencyGeneratorControl description: Controle de geração origin: type: string description: Origem do dado data: type: string description: Dados coletados para geração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPendencyGeneratorControlData: type: object required: – id allOf: – #/definitions/pendencyGeneratorControlData nonPeriodicPendency: description: Pendência não periódica type: object required: – company – employee – startDate – layout – status – validations properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa employee: type: object allOf: – #/definitions/employee description: Colaborador startDate: type: string format: date description: Início da pendência endDate: type: string format: date description: Fim da pendência effectDate: type: string format: date description: Data de efeito layout: type: integer format: int64 description: Leiaute status: type: integer format: int64 description: Situação da pendência processId: type: string description: Identificador do processo de geração information: type: string description: Informações da pendência validations: type: string description: Validações createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: periodicPendency: description: Pendência periódica type: object required: – company – reference – competenceCalculation – layout – status properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa reference: type: string description: Referência da pendência annualCalculationIndicator: type: boolean description: Indicativo de apuração anual default: false competenceCalculation: type: string format: date description: Competência de apuração layout: type: integer format: int64 description: Leiaute status: type: integer format: int64 description: Sutuação da pendência processId: type: string description: Identificador do processo de geração information: type: string description: Informações da pendência validations: type: string description: Validações createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tablePendency: description: Pendência de tabelas type: object required: – company – reference – startDate – layout – status properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa reference: type: string description: Referência da pendência startDate: type: string format: date description: Início da pendência endDate: type: string format: date description: Fim da pendência layout: type: integer format: int64 description: Leiaute status: type: integer format: int64 description: Situação da pendência processId: type: string description: Identificador do processo de geração information: type: string description: Informações da pendência validations: type: string description: Validações createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hashSyndicateHistory: description: Hash do histórico de sindicato type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador syndicate: type: string description: Sindicato collectiveNegotiation: type: string description: Negociação coletiva startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final lastUpdatedDate: type: string format: date-time description: Data da última atualização excluded: type: boolean description: Verificador de exclusão default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pendencyGenerateBatch: description: Lote de geração de leiaute type: object required: – layout – batchSequence – processId – createdBy – createdDate properties: id: type: string format: uuid description: Identificador único da pendência layout: type: integer format: int64 description: Leiaute do eSocial batchSequence: type: integer format: int64 description: Sequência do lote por leiaute processId: type: string format: uuid description: Identificador uníco do processo de geração createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação hashEmploymentRelationshipHistory: description: Hash do histórico de vínculo empregatício type: object required: – employee – employmentRelationship – startDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador employmentRelationship: type: string description: Vínculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eSocialCompanyInscription: description: eSocial – Inscrição da empresa type: object required: – company – inscriptionType – inscriptionNumber properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa inscriptionType: type: string allOf: – #/definitions/inscriptionType description: Tipo de inscrição inscriptionNumber: type: string description: Número de inscrição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialCompanyInscription: type: object required: – id allOf: – #/definitions/eSocialCompanyInscription eSocialAdmissionInformation: description: eSocial – Informações da admissão type: object required: – employee – employeeRegistration – eSocialRegistration – eSocialCategoryCode properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador employeeRegistration: type: string maxLength: 11 description: CPF do colaborador eSocialRegistration: type: string maxLength: 255 description: Matrícula do eSocial eSocialCategoryCode: type: integer format: int64 description: Código da categoria do eSocial hasReceipt: type: boolean description: Indicativo se possui recibo default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialAdmissionInformation: type: object required: – id allOf: – #/definitions/eSocialAdmissionInformation eSocialDefinitionPayroll: description: Definições do eSocial – Folha type: object required: – eSocialDefinition – identification properties: id: type: string format: uuid description: Identificador único eSocialDefinition: type: object allOf: – #/definitions/eSocialDefinition description: Definições do eSocial identification: type: string maxLength: 8 description: Identificador da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialDefinitionPayroll: type: object required: – id allOf: – #/definitions/eSocialDefinitionPayroll 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 excluido: 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: 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 excluido: 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: 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 eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do eSocial 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 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. 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 datNas: type: string format: date description: Data nascimento cnpCpf: type: string maxLength: 14 description: CNPJ/CPF excluido: 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: 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 eSocialRegistration: type: string description: Matrícula do eSocial companyTransferDate: type: string format: date description: Data de transferência deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situation: description: Situação type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código 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: wageTypeTable: description: Tabela de eventos type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código 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: eSocialDefinition: description: Definições do eSocial type: object properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente eSocialGroup: type: string allOf: – #/definitions/eSocialGroup description: Grupo de entrada 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