Gestão de Pessoas (hcm)

esocial4integration

46 views 09/07/2019 11/11/2020 integrador 0

2.0info: 5.14.0 esocial4integration description: Serviço do e-Social para integrações de terceiros. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: esocial4integration contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /esocial4integration/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/enumInformation: post: description: Retorna os itens das enumerações traduzidos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nomes das enumerações. responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens das enumerações traduzidos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nomes das enumerações. in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/activeFeature: post: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – feature properties: feature: type: string description: Feature que será consultada responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: feature description: Feature que será consultada in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationQuery: post: description: Retorna a lista de pendências com os filtros indicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: string description: Filtro pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/branchQuery: post: description: Retorna a lista de filiais com os filtros indicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: string description: Filtro pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationBranch minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationToStringQuery: post: description: Retorna uma String com os principais dados de uma pendência concatenados para comparações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: string description: Filtro. pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Uma String contendo os dados da pendência de forma concatenada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationThirdSystemQuery: post: description: Retorna uma lista de pendências de integração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startScheduledDate – endScheduledDate – companyCode properties: startScheduledDate: type: string format: date description: Data inicial. endScheduledDate: type: string format: date description: Data final. companyCode: type: string description: Código da empresa. esocialRegistration: type: string description: Matricula do esocial. cpf: type: string maxLength: 11 description: Cpf. integrationReason: type: string allOf: – #/definitions/integrationType description: Motivo da integração. situation: type: string allOf: – #/definitions/statusType description: Situação. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de pendencia de integração. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationCountQuery: post: description: Retorna a quantidade total de registros que pertencem ao filtro informado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Filtro. responses: 200: description: Ok schema: type: object required: – result properties: result: type: integer format: int64 description: Número total de registros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade total de registros que pertencem ao filtro informado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: integer format: int64 description: Número total de registros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/retrieveSentIntegrationsQuery: post: description: Retorna uma lista de pendências de integração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Integrações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationEmployeeChanges: post: description: Busca as mudanças entre a pendencia informada e a última pendência válida desse colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationId properties: integrationId: type: string description: Id da pendência responses: 200: description: Ok schema: type: object required: – changes properties: changes: type: string description: JSON com as mudanças entre a pendencia informada e a última pendência válida desse colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as mudanças entre a pendencia informada e a última pendência válida desse colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: integrationId description: Id da pendência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – changes properties: changes: type: string description: JSON com as mudanças entre a pendencia informada e a última pendência válida desse colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/configurationProviderToShowListQuery: post: description: Busca as informações necessárias para a tela de prestadores poder listar elas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationCompanyId properties: configurationCompanyId: type: string description: Id da entidade de configuração de empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationProviderSummary minimum: 1 description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações necessárias para a tela de prestadores poder listar elas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: configurationCompanyId description: Id da entidade de configuração de empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationProviderSummary minimum: 1 description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/companyAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/companyBranchAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/employeeAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/subscriptionNumberAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de cpfs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de cpfs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/providerNameAutoCompleteQuery: post: description: Busca os dados necessários para montar a lista dos nomes dos prestadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessários para montar a lista dos nomes dos prestadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/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 /esocial4integration/queries/exportCompanySetting: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportConfigurationCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportIntegration: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportCompanyBranch: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportESocialCategory: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportWorkstation: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportShift: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportJobPosition: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportDepartment: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportCostCenter: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportReasonLeave: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportSalaryPremium: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/exportGeneralConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial4integration/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /esocial4integration/actions/integrationThirdSystem: post: description: Envia dados do colaborador recebido por sistemas de terceiros. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – integrationType – scheduledDate – operationType – externalSystem properties: employee: type: object allOf: – #/definitions/employee description: Entidade colaborador integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. scheduledDate: type: string format: date description: Data de agendamento. operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação. externalSystem: type: string description: Sistema terceiro responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultIntegrationThirdSystem description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/integrationThirdSystemCancel: post: description: Envia dados do colaborador recebido por sistemas de terceiros. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idIntegration properties: idIntegration: type: string maxLength: 36 description: Id da integração. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultIntegrationThirdSystem description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/retrieveDataFromField: post: description: Retorna os valores existentes na base em determinada tabela e campo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – table – field – searchQuery properties: table: type: string allOf: – #/definitions/filterTables description: Tabela para consulta. field: type: string description: Campo para consulta. searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/syncConfigurationBranchWithPayrollBranches: post: description: Sincroniza as filiais do prestado SST com as filiais do payroll tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyIdentification properties: companyIdentification: type: string description: Identificação da empresa. responses: 200: description: Ok schema: type: object required: – ok – hasRecords properties: ok: type: boolean description: Flag indicando o sucesso da sincronia hasRecords: type: boolean description: Flag indicando se existem registros configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de configuração por filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/persistConfigurationCompany: post: description: Realiza a consistencia de uma configuração de empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: configurationCompany: type: object allOf: – #/definitions/configurationCompany description: Configuração de empresa configurationCompanyDelete: type: string description: Id da configuração de empresa que será deletada configurationProviders: type: array items: type: object allOf: – #/definitions/configurationProviderOperation description: Configurações de prestadores configurationProviderSituation: type: array items: type: object allOf: – #/definitions/keyValuePairBoolean description: Uma lista de id/flag indicando as configurações de prestadores e os respectivos valores do campo situation configurationProviderDelete: type: array items: type: string description: Uma lista de ids de prestadores SST que serão deletados operationType: type: string allOf: – #/definitions/operationType description: Operação realizada em cima da entidade configurationCompany responses: 200: description: Ok schema: type: object required: – configurationCompany properties: configurationCompany: type: object allOf: – #/definitions/configurationCompany description: Entidade de configuração de empresa que foi afetada configurationProvider: type: array items: type: object allOf: – #/definitions/configurationProvider description: Lista de entidades de configuração de prestadores que foram afetados configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de entidades de configuração de filiais que foram afetados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/checkCompanyOnProvider: post: description: Verifica o status da empresa no prestador SST tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – providerType – companyProviderIdentification properties: providerType: type: string allOf: – #/definitions/providerType description: Tipo do prestador companyProviderIdentification: type: string description: Código da empresa no prestador SST responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Status da empresa no prestador SST 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/cancelPendencies: post: description: Cancela uma lista de pendências de integração. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciesToProcess properties: pendenciesToProcess: type: array items: type: object allOf: – #/definitions/integrationPendency minimum: 1 description: Lista de pendências para cancelar. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Possível aviso gerado durante o processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/resendPendencies: post: description: Regera e reenvia uma lista de pendências de integração. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciesToProcess properties: pendenciesToProcess: type: array items: type: object allOf: – #/definitions/integrationPendency minimum: 1 description: Lista de pendências para regerar e reenviar. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/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 /esocial4integration/actions/importCompanySetting: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importConfigurationCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importIntegration: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importCompanyBranch: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importESocialCategory: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importWorkstation: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importShift: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importJobPosition: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importDepartment: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importCostCenter: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importReasonLeave: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importSalaryPremium: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/actions/importGeneralConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial4integration/signals/integrationScheduled: post: description: Processa todas as pendências de integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationPublishPendencyEvent: post: description: Publica uma integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationId properties: integrationId: type: string description: Id da integração. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationPublishConsumeEmployeeIntegrationsByTenantEvent: post: description: Busca por pendências que não tiveram confirmação de recebimento pelo prestador SST. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationEmployeeWork: post: description: Processa uma admissão ou alteração da admissão de um colaborador. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: employeeId: type: string description: Id do colaborador no Payroll. integrationEmployeeType: type: string allOf: – #/definitions/integrationEmployeeType description: Tipo da integração. companyCode: type: integer format: int64 description: Código da empresa. cnpjCompanyBranch: type: string description: CNPJ da filial matriz. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationUpdateStatus: post: description: Atualiza o status da integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationId – statusType properties: integrationId: type: string description: Id da integração. statusType: type: string allOf: – #/definitions/providerStatusType description: Status da integração. errorMessage: type: string description: Mensagem de erro. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/retryScheduler: post: description: Tenta regerar pendências falhadas tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/generatePendencies: post: description: Gera pendências das empresas ativas tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/employeeInitialLoad: post: description: Geração de carga inicial dos colaboradores tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companies properties: companies: type: array items: type: string minimum: 1 description: Lista de códigos de empresas que terão os employees integrados – essas integrações seguirão a regra da tela de configuração de empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/evaluateEmployeeChangePendencies: post: description: Processa as pendências de alteração de dados do colaborador que estão aguardando avaliação. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companySetting responses: 200: description: The created resource schema: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companySetting responses: 200: description: The created resource schema: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companySetting responses: 200: description: Ok schema: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companySetting responses: 200: description: Ok schema: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/companySetting/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companySetting responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationCompany responses: 200: description: The created resource schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationCompany responses: 200: description: The created resource schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationCompany responses: 200: description: Ok schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationCompany responses: 200: description: Ok schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/configurationCompany/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationCompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationProvider responses: 200: description: The created resource schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationProvider responses: 200: description: The created resource schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/configurationCompany/{parentId}/configurationProvider: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationProvider responses: 200: description: The created resources schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationProvider responses: 200: description: The created resources schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany/{parentId}/configurationProvider/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationProvider responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationBranch: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationBranch responses: 200: description: The created resource schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationBranch responses: 200: description: The created resource schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationBranch/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/configurationProvider/{parentId}/configurationBranch: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationBranch responses: 200: description: The created resources schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationBranch responses: 200: description: The created resources schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{parentId}/configurationBranch/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationBranch/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationUserNotification: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationUserNotification responses: 200: description: The created resource schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationUserNotification responses: 200: description: The created resource schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationUserNotification/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/configurationProvider/{parentId}/configurationUserNotification: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationUserNotification responses: 200: description: The created resources schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/configurationUserNotification responses: 200: description: The created resources schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{parentId}/configurationUserNotification/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationUserNotification/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationUserNotification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/branchIntegration: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchIntegration responses: 200: description: The created resource schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchIntegration responses: 200: description: The created resource schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/branchIntegration/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/companySetting/{parentId}/branchIntegrations: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/branchIntegration responses: 200: description: The created resources schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/branchIntegration responses: 200: description: The created resources schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting/{parentId}/branchIntegrations/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/branchIntegration/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/branchIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/integration: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integration responses: 200: description: The created resource schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integration responses: 200: description: The created resource schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/integration/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/integration responses: 200: description: Ok schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/integration responses: 200: description: Ok schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/integration/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/employee/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/company/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companyBranch: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companyBranch/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/companyBranch/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/deficiency: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deficiency responses: 200: description: The created resource schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deficiency responses: 200: description: The created resource schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/deficiency/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/employee/{parentId}/deficiencies: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/deficiency responses: 200: description: The created resources schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/deficiency responses: 200: description: The created resources schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/deficiencies/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/deficiency/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deficiency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/eSocialCategory: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/eSocialCategory/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eSocialCategory responses: 200: description: Ok schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eSocialCategory responses: 200: description: Ok schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/eSocialCategory/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialCategory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workstation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstation responses: 200: description: The created resource schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstation responses: 200: description: The created resource schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workstation/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstation responses: 200: description: Ok schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstation responses: 200: description: Ok schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/workstation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workstation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/shift: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shift responses: 200: description: The created resource schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shift responses: 200: description: The created resource schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/shift/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shift responses: 200: description: Ok schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shift responses: 200: description: Ok schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/shift/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shift responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/jobPosition: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/jobPosition/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/jobPosition/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobPosition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/department: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/department responses: 200: description: The created resource schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/department responses: 200: description: The created resource schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/department/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/department/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/department responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/costCenter: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/costCenter/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/costCenter/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/costCenter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/reasonLeave: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/reasonLeave/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reasonLeave responses: 200: description: Ok schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reasonLeave responses: 200: description: Ok schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/reasonLeave/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/reasonLeave responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/salaryPremium: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/salaryPremium/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salaryPremium responses: 200: description: Ok schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salaryPremium responses: 200: description: Ok schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/salaryPremium/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salaryPremium responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/generalConfiguration: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/generalConfiguration/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalConfiguration responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalConfiguration responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /esocial4integration/entities/generalConfiguration/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generalConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN configurationMode: description: Status do healthcheck type: string enum: – SINGLEPROVIDER – MULTIPLEPROVIDERS integrationEmployeeType: description: Tipo de alteração do colaborador. type: string enum: – NEW_EMPLOYEE – EMPLOYEE_CHANGE – DISMISSAL – EMPLOYEE_ESOCIAL_REGISTRATION integrationHistoricOfEmployeeType: description: Tipo de alteração do histórico do colaborador. type: string enum: – HISTORICAL_COST_CENTER – HISTORICAL_DEPARTMENT – HISTORICAL_ESOCIAL_CATEGORY – HISTORICAL_JOB_POSITION – HISTORICAL_LEAVE – HISTORICAL_WORKSTATION – HISTORICAL_COMPANY_BRANCH – HISTORICAL_WORKSHIFT statusType: description: Tipo do status de integração. type: string enum: – SCHEDULED – INTEGRATING – PROCESSING_RESEND – SENT_TO_PROVIDER – ON_PROVIDER – INTEGRATION_ERROR – INTEGRATION_ERROR_PROVIDER – CANCELED – IN_ANALYSIS – ANALYSIS_ERROR – IRRELEVANT – CANCEL_REGENERATED – WAITING_RETRY_SCHEDULER – WAITING_PENDENCY_EVALUATION – REFERENCE_PENDENCY providerStatusType: description: Tipo so status da integração para o provedor SST. type: string enum: – ON_PROVIDER – INTEGRATION_ERROR integrationType: description: Tipo da integração. type: string enum: – INITIAL_LOAD – NEW_EMPLOYEE – EMPLOYEE_CHANGE – EMPLOYEE_ESOCIAL_REGISTRATION – HISTORICAL_COMPANY – HISTORICAL_COMPANY_BRANCH – HISTORICAL_COST_CENTER – HISTORICAL_WORKSTATION – HISTORICAL_DEPARTMENT – HISTORICAL_JOB_POSITION – HISTORICAL_WORKSHIFT – HISTORICAL_LEAVE – HISTORICAL_ESOCIAL_CATEGORY – HISTORICAL_SALARY_PREMIUM – DISMISSAL subscriptionType: description: Tipo de inscrição. type: string enum: – CNPJ – CPF – CAEPF – CNO – CEI – NOT_FOUND employeeType: description: Tipo do colaborador. type: string enum: – EMPLOYEE – THIRD – PARTNER – NOT_FOUND maritalStatusType: description: Estado civil. type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – SEPARATED – STABLE_UNION – OTHER – CONCUBINAGE – NOT_FOUND genderType: description: Gênero do colaborador. type: string enum: – MALE – FEMALE situationType: description: Situação do colaborador. type: string enum: – WORKING – VACATION – FIRED – AWAY – LICENSE contractType: description: Tipo do contrato. type: string enum: – EMPLOYEE – MANAGER – FARMWORKER – RETIRED – TRAINEE – APPRENTICE – FIXEDDUEDATE – RETIREDMANAGER – PUBLICAGENT – TEACHER – COOPERATIVEWORKER – DOMESTICWORKER – TEACHERFIXEDDUEDATE – NOT_FOUND deficiencyType: description: Tipo da deficiência no e-Social. type: string enum: – PHYSICAL – AUDITORY – VISUAL – MENTAL – INTELLECTUAL – OTHER – NOT_FOUND eSocialCategoryType: description: Tipo de categoria do e-Social. type: string enum: – Category_101 – Category_102 – Category_103 – Category_104 – Category_105 – Category_106 – Category_111 – Category_201 – Category_202 – Category_301 – Category_302 – Category_303 – Category_305 – Category_306 – Category_307 – Category_308 – Category_309 – Category_401 – Category_410 – Category_701 – Category_711 – Category_712 – Category_721 – Category_722 – Category_723 – Category_731 – Category_734 – Category_738 – Category_741 – Category_751 – Category_761 – Category_771 – Category_781 – Category_901 – Category_902 – Category_903 – Category_904 – Category_905 – Category_997 – Category_998 – Category_999 directionType: description: Tipo de ordenação. type: string enum: – ASC – DESC operationType: description: Tipo de operação. type: string enum: – INSERT – UPDATE – DELETE filterTables: description: Tables disponíveis para filtro nas telas de cadastro. type: string enum: – INTEGRATION state: description: Estados brasileiros type: string enum: – AC – AL – AP – AM – BA – CE – DF – ES – GO – MA – MT – MS – MG – PA – PB – PR – PE – PI – RJ – RN – RS – RO – RR – SC – SP – SE – TO providerType: description: Lista de prestadores SST homologados pelo sistema Integrador SST type: string enum: – CUSTOM – GSO – MED_NET – NEXO_CS – RS_DATA – SOC specialRetirementType: description: Tipo de aposentadoria especial type: string enum: – DOES_NOT_HAVE_SPECIAL_RETIREMENT – NO_EXPOSURE_TO_HARMFUL_AGENTS_EMPLOYEE_ALREADY_EXPOSED – SPECIAL_RETIREMENT_AT_FIFTEEN_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_FIVE_YEARS_OF_SERVICE workshiftScaleType: description: Turnos da Escala type: string enum: – FIRST_SHIFT – SECOND_SHIFT – THIRD_SHIFT – FOURTH_SHIFT – MIXED – GENERAL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status resultBaseData: description: Retorno base para os endpoints. discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. default: _discriminator: type: string description: resultIntegrationThirdSystem: description: Retorno para integração com sistemas de terceiros. allOf: – #/definitions/resultBaseData – type: object required: – integrationId properties: integrationId: type: string description: Id da pendencia de integração. enumInformationData: description: DTO de lista com as enumerações traduzidas. type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração. items: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Lista com os items das enumerações. enumInformationItemData: description: DTO de lista com os items das enumerações. type: object required: – key – value properties: key: type: string description: Chave do item da enumeração. value: type: string description: Valor traduzido do item da enumeração. pagination: description: Dados da paginação. type: object required: – current – size properties: current: type: integer format: int64 description: Página de início. size: type: integer format: int64 description: Quantidade de registros por página. orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenar por. ordination: description: Dados da ordenação. type: object required: – field properties: field: type: string description: Campo que será ordenado. direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação. integrationPendency: description: Dados da pendência de integração. type: object required: – id – integrationType properties: id: type: string description: Id da pendência. integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. statusType: type: string allOf: – #/definitions/statusType description: Status da pendência. fieldData: description: Dados do campo consultado. type: object required: – key – value properties: key: type: string description: Chave do campo. value: type: string description: Valor do campo. secondaryValue: type: string description: Valor secundário configurationProviderSummary: description: Resumo da configuração de prestador type: object required: – id – situation – providerName – providerType – configurationBranchSummary – configurationBranchNames – sendDeficiencies – sendAdditionalInformation – sendHistoricalCostCenter – sendHistoricalWorkstation – sendHistoricalDepartment – sendHistoricalJobposition – sendHistoricalWorkshift – sendHistoricalLeave properties: id: type: string description: Id do prestador situation: type: boolean description: Situação do prestador providerName: type: string description: Nome do prestador providerType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do prestador configurationBranchSummary: type: string description: Resumo das filiais configurationBranchNames: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Chave/Valor dos ids das filiais junto com o nome traduzido delas companyProviderIdentification: type: string maxLength: 255 description: Código da identificação da empresa no prestador SST sendDeficiencies: type: boolean description: Envia deficiências sendAdditionalInformation: type: boolean description: Envia informações adicionais sendHistoricalCostCenter: type: boolean description: Envia Histórico de centro de custo sendHistoricalWorkstation: type: boolean description: Envia Histórico de posto de trabalho sendHistoricalDepartment: type: boolean description: Envia Histórico de Setor sendHistoricalJobposition: type: boolean description: Envia Histórico de Cargo sendHistoricalWorkshift: type: boolean description: Envia Histórico de Turno sendHistoricalLeave: type: boolean description: Envia Histórico de afastamento employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. configurationProviderOperation: description: Operação que será feita na tabela de prestadores type: object required: – configurationProvider – operationType properties: configurationProvider: type: object allOf: – #/definitions/configurationProvider description: Entidade de prestador com as alterações operationType: type: string allOf: – #/definitions/operationType description: Operação que será realizada configurationBranches: type: array items: type: object allOf: – #/definitions/configurationBranchOperation description: Lista de operações sobre as filiais desse prestador configurationBranchOperation: description: Operação que será feita na tabela de filiais type: object required: – configurationBranch – operationType properties: configurationBranch: type: object allOf: – #/definitions/configurationBranch description: Entidade de filial com as alterações operationType: type: string allOf: – #/definitions/operationType description: Operação que será realizada keyValuePairBoolean: description: Chave/Valor com o valor sendo booleano type: object required: – key – value properties: key: type: string description: Chave value: type: boolean description: Valor companySetting: description: Configuração da integração por empresa. type: object required: – companyIdentification – companyName – situation properties: id: type: string format: uuid description: Id da entidade. companyIdentification: type: string description: Identificação da empresa. companyName: type: string description: Nome da empresa. providerCompanyIdentification: type: string description: Identificação da empresa no prestador SST. situation: type: boolean description: Situação da configuração (Ligada ou companySettingDesligada). branchIntegrations: type: array items: type: object allOf: – #/definitions/branchIntegration description: Filiais permitidas para a integração. employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. configurationCompany: description: Configuração de empresa type: object required: – companyIdentification – companyName properties: id: type: string format: uuid description: Id da entidade companyIdentification: type: string maxLength: 255 description: Código da empresa companyName: type: string maxLength: 255 description: Nome da empresa configurationProvider: type: array items: type: object allOf: – #/definitions/configurationProvider description: Prestadores SST configurationProvider: description: Configuração do Prestador SST por empresa type: object required: – providerName – providerType – situation – sendDeficiencies – sendAdditionalInformation – sendHistoricalCostCenter – sendHistoricalWorkstation – sendHistoricalDepartment – sendHistoricalJobposition – sendHistoricalWorkshift – sendHistoricalLeave properties: id: type: string format: uuid description: Id da entidade providerName: type: string maxLength: 255 description: Nome prestador SST providerType: type: string allOf: – #/definitions/providerType description: Sistema prestador SST situation: type: boolean description: Situação companyProviderIdentification: type: string maxLength: 255 description: Código da identificação da empresa no prestador SST configurationCompanyId: type: object allOf: – #/definitions/configurationCompany description: Relacionamento com a empresa sendDeficiencies: type: boolean description: Envia deficiências sendAdditionalInformation: type: boolean description: Envia informações adicionais sendHistoricalCostCenter: type: boolean description: Envia Histórico de centro de custo sendHistoricalWorkstation: type: boolean description: Envia Histórico de posto de trabalho sendHistoricalDepartment: type: boolean description: Envia Histórico de Setor sendHistoricalJobposition: type: boolean description: Envia Histórico de Cargo sendHistoricalWorkshift: type: boolean description: Envia Histórico de Turno sendHistoricalLeave: type: boolean description: Envia Histórico de afastamento configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de configuração por filial configurationUserNotification: type: array items: type: object allOf: – #/definitions/configurationUserNotification description: Lista de usuários que serão notificados em caso de falha employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. configurationBranch: description: Configuração do prestador SST por filial type: object required: – branchCode – branchName – situation properties: id: type: string format: uuid description: Id da entidade subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição subscriptionNumber: type: string description: Número de inscrição branchCode: type: string description: Código da filial branchName: type: string description: Nome da filial configurationProviderId: type: object allOf: – #/definitions/configurationProvider description: Relacionamento com a configuração do prestador branchProviderIdentification: type: string description: Código de identificação da empresa no Prestador SST situation: type: boolean description: Situação shortBranchName: type: string maxLength: 255 description: Apelido da filial configurationUserNotification: description: Configuração de usuários para recebimento de notificação em caso de falha na integração type: object required: – notificationUser properties: id: type: string format: uuid description: Id da entidade notificationUser: type: string description: Usuário a ser notificado configurationProviderId: type: object allOf: – #/definitions/configurationProvider description: Relacionamento com a configuração do prestador branchIntegration: description: Filiais da integração type: object required: – subscriptionType – subscriptionNumber properties: id: type: string format: uuid description: Id da entidade. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo da inscrição. subscriptionNumber: type: string description: Numero da inscrição. companySetting: type: object allOf: – #/definitions/companySetting description: Id da configuração da integração da empresa. integration: description: Controle de integrações. type: object required: – externalId – operationType – statusType – integrationType – receiptDate – lotWorkstation properties: id: type: string format: uuid description: Id da entidade. externalId: type: string maxLength: 36 description: Id do colaborador no Payroll. externalHistoricId: type: string maxLength: 36 description: Id de histórico do colaborador no Payroll. operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação employee: type: object allOf: – #/definitions/employee description: Colaborador da integração. statusType: type: string allOf: – #/definitions/statusType description: Tipo do status de integração. integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. receiptDate: type: string format: date-time description: Data e hora do recebimento do colaborador. sendDate: type: string format: date-time description: Data e hora do envio para o provedor SST. scheduledDate: type: string format: date description: Data de agendamento para envio da pendencia. dateWhen: type: string format: date description: Data do histórico gerado. integrationMessage: type: string description: Mensagem da integração. stackTrace: type: string description: StackTrace do erro. companyCode: type: integer format: int64 description: Código da empresa companyName: type: string description: Nome da empresa. companyBranchCode: type: integer format: int64 description: Código da filial. companyBranchName: type: string description: Razão social. branchName: type: string description: Nome da filial. employeeCode: type: integer format: int64 description: Código do colaborador. eSocialRegistration: type: string maxLength: 30 description: Matrícula do e-Social. cpfNumber: type: string description: Número do CPF. employeeName: type: string description: Nome do colaborador. providerCompanyIdentification: type: string description: Identificação da empresa no prestador SST. integrationSequence: type: integer format: int64 description: Identificação da empresa no prestador SST. cancelationReason: type: string description: Motivo cancelamento. previewSendDate: type: string format: date-time description: Data prevista para envio lotWorkstation: type: string description: Lote do histórico de posto de trabalho changes: type: string maxLength: 4000 description: Mudanças em relação a última integração externalSystem: type: string description: Sistema terceiro integrationOrigin: type: string maxLength: 36 description: Pendência de integração de origem providerType: type: string allOf: – #/definitions/providerType description: Prestador para o qual a pendencia foi enviada providerName: type: string description: Nome do prestador SST regenerateAttempts: type: integer format: int64 description: Número de tentativas de regerar a pendência referenceDate: type: string format: date description: Data de referência das informações básicas do colaborador. providerPreviousCompanyIdentification: type: string description: Identificação da empresa anterior do colaborador no prestador SST. employee: description: Colaborador. type: object required: – externalId – name – situationType – company – companyBranch properties: id: type: string format: uuid description: Id interno do colaborador. externalId: type: string maxLength: 36 description: Id externo do colaborador (no Payroll). employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. code: type: integer format: int64 description: Código do colaborador. eSocialRegistration: type: string maxLength: 30 description: Matrícula do e-Social. name: type: string description: Nome do colaborador. cpfNumber: type: string description: Número do CPF. nisNumber: type: string maxLength: 11 description: Número do NIS. birthday: type: string format: date description: Data de nascimento. hireDate: type: string format: date description: Data de admissão. maritalStatusType: type: string allOf: – #/definitions/maritalStatusType description: Estado civil. genderType: type: string allOf: – #/definitions/genderType description: Gênero do colaborador. situationType: type: string allOf: – #/definitions/situationType description: Situação do colaborador. contractType: type: string allOf: – #/definitions/contractType description: Tipo do contrato. eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do colaborador no e-Social. isDeficient: type: boolean description: Colaborador é deficiente? company: type: object allOf: – #/definitions/company description: Empresa do colaborador. companyBranch: type: object allOf: – #/definitions/companyBranch description: Filial do colaborador. costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo. department: type: object allOf: – #/definitions/department description: Local / Setor do colaborador. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo do colaborador. shift: type: object allOf: – #/definitions/shift description: Turno do colaborador. workstation: type: object allOf: – #/definitions/workstation description: Posto de trabalho. reasonLeave: type: object allOf: – #/definitions/reasonLeave description: Motivo do afastamento. deficiencies: type: array items: type: object allOf: – #/definitions/deficiency description: Deficiência do colaborador. dismissalDate: type: string format: date description: Data de demissão. ctpsNumber: type: string description: Número da carteira de trabalho ctpsSerie: type: string maxLength: 5 description: Série da carteira de trabalho ctpsIssuanceDate: type: string format: date description: Data de emissão da carteira de trabalho ctpsSerieDigit: type: string maxLength: 5 description: Digito da carteira de trabalho ctpsState: type: string allOf: – #/definitions/state description: Estado da carteira de trabalho rgNumber: type: string description: Carteira de identidade rgIssuer: type: string description: Orgão emissor da carteira de identidade rgState: type: string allOf: – #/definitions/state description: Estado da carteira de identidade rgIssuanceDate: type: string format: date description: Data de emissão da carteira de identidade numberContractSameHireDate: type: integer format: int64 description: Número de contratos do colaborador previousCompany: type: object allOf: – #/definitions/company description: Empresa anterior do colaborador. previousCompanyBranch: type: object allOf: – #/definitions/companyBranch description: Filial anterior do colaborador. salaryPremium: type: object allOf: – #/definitions/salaryPremium description: Adicionais no salário do colaborador company: description: Empresa. type: object required: – code – name properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da empresa. name: type: string description: Nome da empresa. companyBranch: description: Filial da empresa. type: object required: – code – name – subscriptionType – subscriptionNumber – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da filial. name: type: string description: Razão social da filial. companyBranchName: type: string description: Nome da filial. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Inscrição da filial. subscriptionNumber: type: string maxLength: 14 description: Número da inscrição. dateWhen: type: string format: date description: Data do histórico da filial (A partir de). deficiency: description: Deficiência do colaborador. type: object required: – code – name – isMainDeficiency – deficiencyType – dateWhen – isRehabilitated properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da deficiência. name: type: string description: Nome da deficiência. isMainDeficiency: type: boolean description: É a deficiência principal? deficiencyType: type: string allOf: – #/definitions/deficiencyType description: Tipo da deficiência no e-Social. dateWhen: type: string format: date description: Data de início da deficiência. isRehabilitated: type: boolean description: Reabilitado. employee: type: object allOf: – #/definitions/employee description: Colaborador. eSocialCategory: description: Categoria eSocial. type: object required: – code – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string allOf: – #/definitions/eSocialCategoryType description: Chave da categoria eSocial. dateWhen: type: string format: date description: Data do histórico da categoria eSocial (A partir de). workstation: description: Posto de trabalho. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do posto de trabalho. structureCode: type: integer format: int64 description: Estrutura do posto de trabalho. name: type: string description: Nome do posto de trabalho. dateWhen: type: string format: date description: Data do histórico do posto de trabalho (A partir de). shift: description: Turno do colaborador. type: object required: – code – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código do turno. name: type: string description: Nome do turno. dateWhen: type: string format: date description: Data do histórico da Turno (A partir de). workshiftScaleType: type: string allOf: – #/definitions/workshiftScaleType description: Turno da escala jobPosition: description: Cargo do colaborador. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do cargo. structureCode: type: string description: Código da estrutura do cargo cboCode: type: string description: Código do CBO do cargo. name: type: string description: Nome do cargo. dateWhen: type: string format: date description: Data do histórico de Cargo (A partir de). department: description: Local do colaborador. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do local. structureCode: type: integer format: int64 description: Código de organograma do local. name: type: string description: Nome do local. dateWhen: type: string format: date description: Data do histórico do Setor (A partir de). costCenter: description: Centro de custo do colaborador. type: object required: – code – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do centro de custo. name: type: string description: Nome do centro de custo. dateWhen: type: string format: date description: Data do histórico do centro de custo (A partir de). reasonLeave: description: Motivo do afastamento. type: object required: – code – name – startDate properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código do motivo. name: type: string description: Nome do motivo. startDate: type: string format: date-time description: Data de início do afastamento. estimatedEndDate: type: string format: date description: Data de previsão de término do afastamento. endDate: type: string format: date-time description: Data de término do afastamento. salaryPremium: description: Adicionais no salário do colaborador type: object required: – dateWhen – specialRetirementType properties: id: type: string format: uuid description: Id interno da entidade. dateWhen: type: string format: date description: Data de inicio endDate: type: string format: date description: Data fim insalubrity: type: number format: double description: Insalubridade hazard: type: number format: double description: Periculosidade lengthOfService: type: number format: double description: Fator tempo de serviço specialRetirementType: type: string allOf: – #/definitions/specialRetirementType description: Aposentadoria especial generalConfiguration: description: Configurações gerais type: object properties: id: type: string format: uuid description: Id interno da entidade. generatePendencies: type: boolean description: Geração de pendência de integração processingInitialLoad: type: boolean description: Processando carga inicial configurationMode: type: string allOf: – #/definitions/configurationMode description: Modo de cofiguração 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment