Gestão de Pessoas (hcm)

esocial

86 views 09/07/2019 29/10/2020 integrador 0

2.0info: 6.3.1 esocial description: Serviço de eSocial na Nuvem. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: esocial 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: /esocial/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 /esocial/queries/backendInformation: post: description: Retorna a versão do backend. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Versão do backend. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a versão do backend. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Versão do backend. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/dtoInformation: post: description: Retorna um JSON do DTO. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtoName properties: dtoName: type: string description: Nome do DTO. dtoInformationLevel: type: integer format: int64 description: Nível de busca do DTO. default: 100 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dtoInformationData description: JSON do DTO solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna um JSON do DTO. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtoName description: Nome do DTO. in: query required: true type: string – name: dtoInformationLevel description: Nível de busca do DTO. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dtoInformationData description: JSON do DTO solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/queries/layoutSituationDataQuery: post: description: Retorna os dados do layout. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutSituationId properties: layoutSituationId: type: string description: Id da situação do layout. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/layoutSituationDataQueryData description: Dados do layout em formato JSON. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados do layout. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: layoutSituationId description: Id da situação do layout. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/layoutSituationDataQueryData description: Dados do layout em formato JSON. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/layoutSituationCountQuery: 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 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 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 /esocial/queries/layoutSituationToStringQuery: 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: – 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 /esocial/queries/consultReturnGovernmentQuery: post: description: Consulta o retorno do governo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date-time description: Data início evento (2019-01-31T12:10:22+00:00) endDate: type: string format: date-time description: Data fim evento (2019-01-31T12:10:22+00:00) layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do layout eventId: type: string maxLength: 36 description: ID employerDocumentNumber: type: string maxLength: 15 description: CNPJ CPF empregador employeeDocumentNumber: type: string maxLength: 11 description: CPF Trabalhador statusType: type: string allOf: – #/definitions/statusType description: Status responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/returnGovernmentListData description: Lista de dados da consulta do retorno do governo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/listLayoutWaitingReturn: post: description: Atualiza o status da integração com o retorno do governo. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/layoutSituation minimum: 1 description: Lista de layouts com aguardando retorno do governo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Atualiza o status da integração com o retorno do governo. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/layoutSituation minimum: 1 description: Lista de layouts com aguardando retorno do governo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/companySettingBySubscriptionNumber: post: description: Busca uma configuração de empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – subscriptionNumber – subscriptionType properties: subscriptionNumber: type: string description: Número de inscrição subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/companySetting description: Lista de layouts com aguardando retorno do governo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/layoutsWithMessedUpDataQuery: post: description: Retorna layouts com informações erradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – flag properties: flag: type: boolean description: flag pedindo layouts com informações erradas responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/layoutJsonText minimum: 1 description: Lista de layouts com problema identificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna layouts com informações erradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: flag description: flag pedindo layouts com informações erradas in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/layoutJsonText minimum: 1 description: Lista de layouts com problema identificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/allESocialPendencyIds: post: description: Retorna uma lista de eSocialPendency montados a partir da tabela layoutSituation tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – layoutSituationIds properties: layoutSituationIds: type: array items: type: string minimum: 1 description: Lista com os ids das pendências de envio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de eSocialPendency montados a partir da tabela layoutSituation tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – layoutSituationIds properties: layoutSituationIds: type: array items: type: string minimum: 1 description: Lista com os ids das pendências de envio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/queries/providerIdentificationFromProviderXmlAutoCompleteQuery: post: description: Busca os dados necessários para montar a lista com as identificações dos layouts no prestador 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 com as identificações dos layouts no prestador 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 /esocial/queries/subscriptionNumberFromProviderXmlAutoCompleteQuery: post: description: Busca os dados necessários para montar a lista com os números de inscrição dos layouts do prestador 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 com os números de inscrição dos layouts do prestador 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 /esocial/queries/importationLogList: post: description: Faz uma consulta nos logs de importação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: filter: type: object allOf: – #/definitions/importationLogFilter description: Filtro que será usado na consulta page: type: integer format: int64 description: Página que será retornada size: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas encontradas totalElements: type: integer format: int64 description: Total de elementos encontrados contents: type: array items: type: object allOf: – #/definitions/importationLogItem minimum: 1 description: Itens encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/importationLogDetail: post: description: Busca os detalhes da importação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – importationId properties: importationId: type: string description: Id da importação responses: 200: description: Ok schema: type: object required: – importationInformation properties: importationInformation: type: object allOf: – #/definitions/importationInformation description: Informações da importação eSocialEvents: type: array items: type: object allOf: – #/definitions/importationESocialEventItem description: Registros de eventos do eSocial relacionado com essa importação importationFiles: type: array items: type: object allOf: – #/definitions/importationFileItem description: Registros de arquivos importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os detalhes da importação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: importationId description: Id da importação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – importationInformation properties: importationInformation: type: object allOf: – #/definitions/importationInformation description: Informações da importação eSocialEvents: type: array items: type: object allOf: – #/definitions/importationESocialEventItem description: Registros de eventos do eSocial relacionado com essa importação importationFiles: type: array items: type: object allOf: – #/definitions/importationFileItem description: Registros de arquivos importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/queries/retrievePendencySummaryCsv: post: description: Gera o csv do resumo de uma ou mais pendências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutSituationIds properties: layoutSituationIds: type: array items: type: string minimum: 1 description: Ids das pendências responses: 200: description: Ok schema: type: object required: – csvContent properties: csvContent: type: string description: Conteúdo do csv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera o csv do resumo de uma ou mais pendências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: layoutSituationIds description: Ids das pendências in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – csvContent properties: csvContent: type: string description: Conteúdo do csv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/queries/statusEsocialXml: post: description: Retorna o status de um XML do eSocial. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: providerXmlId: type: string description: Identificador do XML no prestador SST id: type: string description: Identificador do registro na plataforma senior X. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/statusEsocialXmlDTO minimum: 1 description: Retorno referente ao envio do evento do eSocial. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o status de um XML do eSocial. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: providerXmlId description: Identificador do XML no prestador SST in: query type: string – name: id description: Identificador do registro na plataforma senior X. in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/statusEsocialXmlDTO minimum: 1 description: Retorno referente ao envio do evento do eSocial. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/queries/exportTenantConfiguration: 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 /esocial/queries/exportTable01CategoryOfWorker: 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 /esocial/queries/exportTable06InternationalCountryCode: 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 /esocial/queries/exportTable13BodyPartDamage: 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 /esocial/queries/exportTable14And15CauserAgent: 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 /esocial/queries/exportTable15And16CauserSituation: 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 /esocial/queries/exportTable17InjuryNature: 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 /esocial/queries/exportTable20PublicPlaceType: 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 /esocial/queries/exportTable24RiskFactor: 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 /esocial/queries/exportTable27DiagnosticAndProcedure: 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 /esocial/queries/exportTable28ActivityOfWorker: 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 /esocial/queries/exportTable29TrainingCode: 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 /esocial/queries/exportCboCode: 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 /esocial/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 /esocial/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 /esocial/queries/exportIbgeCity: 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 /esocial/queries/exportImportation: 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 /esocial/queries/exportLayoutSituation: 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 /esocial/queries/exportLayoutSituationDependency: 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 /esocial/queries/exportLayoutS2210: 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 /esocial/queries/exportLayoutS2220: 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 /esocial/queries/exportLayoutS2240: 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 /esocial/queries/exportLayoutS3000: 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 /esocial/queries/exportProviderXml: 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 /esocial/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 /esocial/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 /esocial/actions/esocialEventXml: post: description: Recebimento do XML. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – xml properties: providerXmlId: type: string description: Id do xml no prestador xml: type: string description: Xml. providerCompanyId: type: string description: Id da empresa no prestador SST. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição. subscriptionNumber: type: string description: Numero de incrição. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/providerXml description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/blobServiceRequestUploads: post: description: Solicitação para realizar o upload de um ou mais arquivos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – requestUploads properties: requestUploads: type: array items: type: object allOf: – #/definitions/blobServiceRequestUploadRequest minimum: 1 description: Lista contendo os dados necessários para requisitar o upload de uma lista de arquivos responses: 200: description: Ok schema: type: object required: – result – blobServiceResponseBatch properties: result: type: object allOf: – #/definitions/resultBaseData description: O resultado base da ação, indicando se ocorreu com sucesso e se tem alguma mensagem blobServiceResponseBatch: type: array items: type: object allOf: – #/definitions/blobServiceRequestUploadResponse minimum: 1 description: Lista contendo dados referentes ao uploads requisitados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/layoutSituationProcess: post: description: Atualiza a situação do layout e define o reenvio ou o cancelamento desse layout. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutSituationIds – actionType properties: layoutSituationIds: type: array items: type: string minimum: 1 description: Lista de pendências de envio. actionType: type: string allOf: – #/definitions/actionType description: Tipo da ação. 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 /esocial/actions/layoutFromEntityConverter: post: description: Retorna o XML das pendências dos layouts pela entidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 36 description: Id do registro da pendencia responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: XML do layout da pendencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/companySettingNrInscLayoutValidator: post: description: Valida se um número de inscrição possui layouts relacionados a ele tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrInsc properties: nrInsc: type: string maxLength: 15 description: Número de inscrição da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: True se a empresa tem layouts cadastrado no seu número de inscrição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/companySettingValidateEdocs: post: description: Retorna o XML das pendências dos layouts pela entidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – result properties: result: type: string description: XML da consulta de ambiente responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: XML do layout da pendencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/correctLayoutsData: post: description: Corrige dados inconsistentes nos registro das tabelas dos layouts tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layouts properties: layouts: type: array items: type: object allOf: – #/definitions/layoutIdentifier minimum: 1 description: Lista de identificadores de layout responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Flag indicando erro ou sucesso do processamento message: type: string description: Possível mensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/validateMessengerConnection: post: description: Verifica se as informações usadas para a configuração do mensageiro eDocs estão corretas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – url – user – pass – environmentIdType properties: url: type: string description: URL do mensageiro para o ambiente de homologação. user: type: string description: Usuário do mensageiro para o ambiente de homologação. pass: type: string description: Senha do mensageiro para o ambiente de homologação. environmentIdType: type: string allOf: – #/definitions/environmentIdType description: Tipo do ambiente (PRODUCTION | RESTRICT_PRODUCTION) responses: 200: description: Ok schema: type: object required: – result – message properties: result: type: boolean description: Retorna se os dados estão corretos. message: type: string description: Mensagem de retorno das validações. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/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 – companyName properties: providerType: type: string allOf: – #/definitions/providerType description: Tipo do prestador companyProviderIdentification: type: string description: Código da empresa no prestador SST companyName: type: string description: Nome da empresa responses: 200: description: Ok schema: type: object required: – isActive – message properties: isActive: type: boolean description: Status da empresa no prestador SST message: type: string description: Mensagem com resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/actions/eSocialEventXmlImportationProcess: post: description: Inicia o processo de importação de uma lista de arquivos. Esse processo é feito de maneira assíncrona. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/blobServiceTempFile minimum: 1 description: Lista contendo os arquivos que serão processados responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação batch: type: string description: Número do lote gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/sendEsocialXml: post: description: Envia um evento do eSocial para a plataforma senior X. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – providerXmlId – providerCompanyId – subscriptionType – subscriptionNumber – xml properties: providerXmlId: type: string description: Identificador do XML no prestador SST providerCompanyId: type: string description: Identificador da empresa no prestador SST. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição da empresa. subscriptionNumber: type: string description: Numero de inscrição da empresa. xml: type: string description: XML do evento do eSocial. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/statusEsocialXmlDTO description: Retorno referente ao envio do evento do eSocial. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/retrieveEsocialEvents: post: description: Retorna os eventos do eSocial que ainda não foram enviados ao governo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companySubscriptionType – companySubscriptionNumber – environmentType properties: companySubscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição da empresa companySubscriptionNumber: type: string maxLength: 15 description: Número de inscrição da empresa environmentType: type: string allOf: – #/definitions/environmentIdType description: Tipo de ambiente do eSocial layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de evento do eSocial eventStatus: type: string allOf: – #/definitions/eventStatus description: Status do evento do eSocial responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da ação, indicando se ocorreu sucesso ou erro esocialEvent: type: array items: type: object allOf: – #/definitions/esocialEventDTO description: Eventos do eSocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/actions/updateStatusEsocialEvents: post: description: Atualiza o status dos eventos do eSocial que estão sendo enviados ao governo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – statusEsocialEvent properties: statusEsocialEvent: type: array items: type: object allOf: – #/definitions/statusEsocialEventDTO minimum: 1 description: Status do evento do eSocial responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno da atualização dos status dos eventos do eSocial. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/actions/importTenantConfiguration: 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 /esocial/actions/importTable01CategoryOfWorker: 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 /esocial/actions/importTable06InternationalCountryCode: 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 /esocial/actions/importTable13BodyPartDamage: 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 /esocial/actions/importTable14And15CauserAgent: 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 /esocial/actions/importTable15And16CauserSituation: 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 /esocial/actions/importTable17InjuryNature: 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 /esocial/actions/importTable20PublicPlaceType: 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 /esocial/actions/importTable24RiskFactor: 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 /esocial/actions/importTable27DiagnosticAndProcedure: 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 /esocial/actions/importTable28ActivityOfWorker: 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 /esocial/actions/importTable29TrainingCode: 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 /esocial/actions/importCboCode: 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 /esocial/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 /esocial/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 /esocial/actions/importIbgeCity: 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 /esocial/actions/importImportation: 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 /esocial/actions/importLayoutSituation: 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 /esocial/actions/importLayoutSituationDependency: 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 /esocial/actions/importLayoutS2210: 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 /esocial/actions/importLayoutS2220: 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 /esocial/actions/importLayoutS2240: 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 /esocial/actions/importLayoutS3000: 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 /esocial/actions/importProviderXml: 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 /esocial/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 /esocial/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 /esocial/signals/layoutSituationUpdateStatus: post: description: Atualiza a situação do layout. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layoutUpdateBatch properties: layoutUpdateBatch: type: array items: type: object allOf: – #/definitions/layoutUpdate minimum: 1 description: Batch de alterações que devem ser feitas em entidades de LayoutSituation responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial/signals/xmlUpdateStatus: post: description: Atualiza o status do xml. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – providerStatusType properties: xmlId: type: string description: Id do ProviderXml. providerStatusType: type: string allOf: – #/definitions/providerStatusType description: Status do provedor. providerErrorMessage: type: string description: Mensagem de erro retornada pelo provedor SST. providerXmlId: type: string description: Id do xml dno prestador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial/signals/statusEsocialXmlReceived: post: description: Indicação de que os status dos eventos do eSocial (XML) foram recebidos com sucesso ou com erros pelo sistema do prestador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – providerStatusType properties: xmlId: type: string description: Id do ProviderXml. providerXmlId: type: string description: Id do xml do prestador providerStatusType: type: string allOf: – #/definitions/providerStatusType description: Status do provedor. providerErrorMessage: type: string description: Mensagem de erro retornada pelo provedor SST. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial/signals/migrationStructure: post: description: Processa migração das permissões para a estrutura de múltiplos prestadores. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial/entities/tenantConfiguration: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantConfiguration responses: 200: description: The created resource schema: #/definitions/tenantConfiguration 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/tenantConfiguration responses: 200: description: The created resource schema: #/definitions/tenantConfiguration 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/tenantConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/tenantConfiguration/{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/tenantConfiguration responses: 200: description: Ok schema: #/definitions/tenantConfiguration 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/tenantConfiguration responses: 200: description: Ok schema: #/definitions/tenantConfiguration 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/tenantConfiguration 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 /esocial/entities/tenantConfiguration/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table01CategoryOfWorker: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table01CategoryOfWorker responses: 200: description: The created resource schema: #/definitions/table01CategoryOfWorker 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/table01CategoryOfWorker responses: 200: description: The created resource schema: #/definitions/table01CategoryOfWorker 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/table01CategoryOfWorker 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table01CategoryOfWorker/{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/table01CategoryOfWorker responses: 200: description: Ok schema: #/definitions/table01CategoryOfWorker 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/table01CategoryOfWorker responses: 200: description: Ok schema: #/definitions/table01CategoryOfWorker 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/table01CategoryOfWorker 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 /esocial/entities/table01CategoryOfWorker/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table01CategoryOfWorker responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table06InternationalCountryCode: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table06InternationalCountryCode responses: 200: description: The created resource schema: #/definitions/table06InternationalCountryCode 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/table06InternationalCountryCode responses: 200: description: The created resource schema: #/definitions/table06InternationalCountryCode 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/table06InternationalCountryCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table06InternationalCountryCode/{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/table06InternationalCountryCode responses: 200: description: Ok schema: #/definitions/table06InternationalCountryCode 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/table06InternationalCountryCode responses: 200: description: Ok schema: #/definitions/table06InternationalCountryCode 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/table06InternationalCountryCode 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 /esocial/entities/table06InternationalCountryCode/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table06InternationalCountryCode responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table13BodyPartDamage: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table13BodyPartDamage responses: 200: description: The created resource schema: #/definitions/table13BodyPartDamage 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/table13BodyPartDamage responses: 200: description: The created resource schema: #/definitions/table13BodyPartDamage 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/table13BodyPartDamage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table13BodyPartDamage/{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/table13BodyPartDamage responses: 200: description: Ok schema: #/definitions/table13BodyPartDamage 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/table13BodyPartDamage responses: 200: description: Ok schema: #/definitions/table13BodyPartDamage 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/table13BodyPartDamage 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 /esocial/entities/table13BodyPartDamage/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table13BodyPartDamage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table14And15CauserAgent: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table14And15CauserAgent responses: 200: description: The created resource schema: #/definitions/table14And15CauserAgent 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/table14And15CauserAgent responses: 200: description: The created resource schema: #/definitions/table14And15CauserAgent 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/table14And15CauserAgent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table14And15CauserAgent/{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/table14And15CauserAgent responses: 200: description: Ok schema: #/definitions/table14And15CauserAgent 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/table14And15CauserAgent responses: 200: description: Ok schema: #/definitions/table14And15CauserAgent 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/table14And15CauserAgent 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 /esocial/entities/table14And15CauserAgent/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table14And15CauserAgent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table15And16CauserSituation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table15And16CauserSituation responses: 200: description: The created resource schema: #/definitions/table15And16CauserSituation 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/table15And16CauserSituation responses: 200: description: The created resource schema: #/definitions/table15And16CauserSituation 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/table15And16CauserSituation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table15And16CauserSituation/{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/table15And16CauserSituation responses: 200: description: Ok schema: #/definitions/table15And16CauserSituation 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/table15And16CauserSituation responses: 200: description: Ok schema: #/definitions/table15And16CauserSituation 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/table15And16CauserSituation 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 /esocial/entities/table15And16CauserSituation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table15And16CauserSituation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table17InjuryNature: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table17InjuryNature responses: 200: description: The created resource schema: #/definitions/table17InjuryNature 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/table17InjuryNature responses: 200: description: The created resource schema: #/definitions/table17InjuryNature 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/table17InjuryNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table17InjuryNature/{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/table17InjuryNature responses: 200: description: Ok schema: #/definitions/table17InjuryNature 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/table17InjuryNature responses: 200: description: Ok schema: #/definitions/table17InjuryNature 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/table17InjuryNature 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 /esocial/entities/table17InjuryNature/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table17InjuryNature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table20PublicPlaceType: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table20PublicPlaceType responses: 200: description: The created resource schema: #/definitions/table20PublicPlaceType 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/table20PublicPlaceType responses: 200: description: The created resource schema: #/definitions/table20PublicPlaceType 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/table20PublicPlaceType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table20PublicPlaceType/{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/table20PublicPlaceType responses: 200: description: Ok schema: #/definitions/table20PublicPlaceType 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/table20PublicPlaceType responses: 200: description: Ok schema: #/definitions/table20PublicPlaceType 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/table20PublicPlaceType 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 /esocial/entities/table20PublicPlaceType/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table20PublicPlaceType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table24RiskFactor: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table24RiskFactor responses: 200: description: The created resource schema: #/definitions/table24RiskFactor 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/table24RiskFactor responses: 200: description: The created resource schema: #/definitions/table24RiskFactor 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/table24RiskFactor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table24RiskFactor/{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/table24RiskFactor responses: 200: description: Ok schema: #/definitions/table24RiskFactor 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/table24RiskFactor responses: 200: description: Ok schema: #/definitions/table24RiskFactor 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/table24RiskFactor 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 /esocial/entities/table24RiskFactor/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table24RiskFactor responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table27DiagnosticAndProcedure: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table27DiagnosticAndProcedure responses: 200: description: The created resource schema: #/definitions/table27DiagnosticAndProcedure 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/table27DiagnosticAndProcedure responses: 200: description: The created resource schema: #/definitions/table27DiagnosticAndProcedure 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/table27DiagnosticAndProcedure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table27DiagnosticAndProcedure/{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/table27DiagnosticAndProcedure responses: 200: description: Ok schema: #/definitions/table27DiagnosticAndProcedure 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/table27DiagnosticAndProcedure responses: 200: description: Ok schema: #/definitions/table27DiagnosticAndProcedure 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/table27DiagnosticAndProcedure 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 /esocial/entities/table27DiagnosticAndProcedure/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table27DiagnosticAndProcedure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table28ActivityOfWorker: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table28ActivityOfWorker responses: 200: description: The created resource schema: #/definitions/table28ActivityOfWorker 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/table28ActivityOfWorker responses: 200: description: The created resource schema: #/definitions/table28ActivityOfWorker 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/table28ActivityOfWorker 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table28ActivityOfWorker/{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/table28ActivityOfWorker responses: 200: description: Ok schema: #/definitions/table28ActivityOfWorker 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/table28ActivityOfWorker responses: 200: description: Ok schema: #/definitions/table28ActivityOfWorker 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/table28ActivityOfWorker 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 /esocial/entities/table28ActivityOfWorker/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table28ActivityOfWorker responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table29TrainingCode: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/table29TrainingCode responses: 200: description: The created resource schema: #/definitions/table29TrainingCode 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/table29TrainingCode responses: 200: description: The created resource schema: #/definitions/table29TrainingCode 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/table29TrainingCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/table29TrainingCode/{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/table29TrainingCode responses: 200: description: Ok schema: #/definitions/table29TrainingCode 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/table29TrainingCode responses: 200: description: Ok schema: #/definitions/table29TrainingCode 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/table29TrainingCode 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 /esocial/entities/table29TrainingCode/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/table29TrainingCode responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/cboCode: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cboCode responses: 200: description: The created resource schema: #/definitions/cboCode 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/cboCode responses: 200: description: The created resource schema: #/definitions/cboCode 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/cboCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/cboCode/{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/cboCode responses: 200: description: Ok schema: #/definitions/cboCode 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/cboCode responses: 200: description: Ok schema: #/definitions/cboCode 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/cboCode 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 /esocial/entities/cboCode/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cboCode responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/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 /esocial/entities/ibgeCity: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ibgeCity responses: 200: description: The created resource schema: #/definitions/ibgeCity 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/ibgeCity responses: 200: description: The created resource schema: #/definitions/ibgeCity 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/ibgeCity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/ibgeCity/{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/ibgeCity responses: 200: description: Ok schema: #/definitions/ibgeCity 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/ibgeCity responses: 200: description: Ok schema: #/definitions/ibgeCity 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/ibgeCity 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 /esocial/entities/ibgeCity/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ibgeCity responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/importation responses: 200: description: The created resource schema: #/definitions/importation 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/importation responses: 200: description: The created resource schema: #/definitions/importation 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/importation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importation/{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/importation responses: 200: description: Ok schema: #/definitions/importation 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/importation responses: 200: description: Ok schema: #/definitions/importation 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/importation 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 /esocial/entities/importation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/importation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importationEventFile: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/importationEventFile responses: 200: description: The created resource schema: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: The created resource schema: #/definitions/importationEventFile 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/importationEventFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importationEventFile/{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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile 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 /esocial/entities/importation/{parentId}/importationEventFiles: 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/importationEventFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationEventFile 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/importationEventFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importationZipFile/{parentId}/importationEventFiles: 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/importationEventFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationEventFile 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/importationEventFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importation/{parentId}/importationEventFiles/{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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile 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 /esocial/entities/importationZipFile/{parentId}/importationEventFiles/{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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile responses: 200: description: Ok schema: #/definitions/importationEventFile 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/importationEventFile 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 /esocial/entities/importationEventFile/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/importationEventFile responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importationZipFile: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/importationZipFile responses: 200: description: The created resource schema: #/definitions/importationZipFile 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/importationZipFile responses: 200: description: The created resource schema: #/definitions/importationZipFile 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/importationZipFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importationZipFile/{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/importationZipFile responses: 200: description: Ok schema: #/definitions/importationZipFile 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/importationZipFile responses: 200: description: Ok schema: #/definitions/importationZipFile 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/importationZipFile 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 /esocial/entities/importation/{parentId}/importationZipFiles: 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/importationZipFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationZipFile 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/importationZipFile responses: 200: description: The created resources schema: type: array items: #/definitions/importationZipFile 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/importationZipFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/importation/{parentId}/importationZipFiles/{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/importationZipFile responses: 200: description: Ok schema: #/definitions/importationZipFile 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/importationZipFile responses: 200: description: Ok schema: #/definitions/importationZipFile 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/importationZipFile 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 /esocial/entities/importationZipFile/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/importationZipFile responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutSituation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutSituation responses: 200: description: The created resource schema: #/definitions/layoutSituation 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/layoutSituation responses: 200: description: The created resource schema: #/definitions/layoutSituation 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/layoutSituation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutSituation/{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/layoutSituation responses: 200: description: Ok schema: #/definitions/layoutSituation 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/layoutSituation responses: 200: description: Ok schema: #/definitions/layoutSituation 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/layoutSituation 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 /esocial/entities/layoutSituation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutSituation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutSituationDependency: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutSituationDependency responses: 200: description: The created resource schema: #/definitions/layoutSituationDependency 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/layoutSituationDependency responses: 200: description: The created resource schema: #/definitions/layoutSituationDependency 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/layoutSituationDependency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutSituationDependency/{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/layoutSituationDependency responses: 200: description: Ok schema: #/definitions/layoutSituationDependency 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/layoutSituationDependency responses: 200: description: Ok schema: #/definitions/layoutSituationDependency 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/layoutSituationDependency 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 /esocial/entities/layoutSituationDependency/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutSituationDependency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2210: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutS2210 responses: 200: description: The created resource schema: #/definitions/layoutS2210 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/layoutS2210 responses: 200: description: The created resource schema: #/definitions/layoutS2210 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/layoutS2210 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2210/{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/layoutS2210 responses: 200: description: Ok schema: #/definitions/layoutS2210 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/layoutS2210 responses: 200: description: Ok schema: #/definitions/layoutS2210 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/layoutS2210 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 /esocial/entities/layoutS2210/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutS2210 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2220: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutS2220 responses: 200: description: The created resource schema: #/definitions/layoutS2220 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/layoutS2220 responses: 200: description: The created resource schema: #/definitions/layoutS2220 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/layoutS2220 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2220/{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/layoutS2220 responses: 200: description: Ok schema: #/definitions/layoutS2220 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/layoutS2220 responses: 200: description: Ok schema: #/definitions/layoutS2220 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/layoutS2220 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 /esocial/entities/layoutS2220/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutS2220 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2240: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutS2240 responses: 200: description: The created resource schema: #/definitions/layoutS2240 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/layoutS2240 responses: 200: description: The created resource schema: #/definitions/layoutS2240 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/layoutS2240 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS2240/{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/layoutS2240 responses: 200: description: Ok schema: #/definitions/layoutS2240 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/layoutS2240 responses: 200: description: Ok schema: #/definitions/layoutS2240 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/layoutS2240 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 /esocial/entities/layoutS2240/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutS2240 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS3000: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutS3000 responses: 200: description: The created resource schema: #/definitions/layoutS3000 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/layoutS3000 responses: 200: description: The created resource schema: #/definitions/layoutS3000 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/layoutS3000 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/layoutS3000/{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/layoutS3000 responses: 200: description: Ok schema: #/definitions/layoutS3000 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/layoutS3000 responses: 200: description: Ok schema: #/definitions/layoutS3000 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/layoutS3000 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 /esocial/entities/layoutS3000/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutS3000 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/providerXml: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/providerXml responses: 200: description: The created resource schema: #/definitions/providerXml 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/providerXml responses: 200: description: The created resource schema: #/definitions/providerXml 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/providerXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/entities/providerXml/{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/providerXml responses: 200: description: Ok schema: #/definitions/providerXml 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/providerXml responses: 200: description: Ok schema: #/definitions/providerXml 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/providerXml 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 /esocial/entities/providerXml/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/providerXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial/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 /esocial/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 /esocial/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 layoutSituationEventType: description: Tipo da publicação do evento. type: string enum: – RECEIVED – RECEIPT_NUMBER – LAYOUT_ERROR nominalDecisionType: description: Tipo de decisão nominal. type: string enum: – YES – NO eventS3000Type: description: Tipo de evento s-3000. type: string enum: – S2210 – S2220 – S2240 occupationalMedicalExaminationType: description: Tipo do exame médico ocupacional. type: string enum: – ADMINSIONAL_MEDICAL_EXAMINATION – PERIODIC_MEDICAL_EXAMINATION – MEDICAL_EXAMINATION_RETURN_WORK – MEDICAL_EXAMINATION_FUNCTION_CHANGE – MEDICAL_EXAMINATION_MONITORING_POINT – DEMANDAL_MEDICAL_EXAMINATION asoResultType: description: Resultado do ASO type: string enum: – APTO – INAPTO resultExamIndicationType: description: Indicação dos Resultados type: string enum: – DEFAULT – CHANGED – STABLE – AGGREGATION examOrderType: description: Ordem do Exame type: string enum: – INITIAL – SEQUENTIAL classOrganType: description: Tipo do órgão de classe. type: string enum: – CRM – CREA – OTHER specialDecisionType: description: Tipo de decisão especial. type: string enum: – NOT_APPLICABLE – NOT_USED – USED implementDecisionType: description: type: string enum: – NOT_APPLICABLE – NOT_IMPLEMENT – IMPLEMENT decisionType: description: Tipo da decisão. type: string enum: – YES – NO unityOfMeasurementType: description: Unidade de medida da intensidade ou concentração. type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_09 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_26 – TYPE_27 – TYPE_28 – TYPE_29 – TYPE_30 – TYPE_31 – TYPE_32 – TYPE_35 – TYPE_36 – TYPE_37 – TYPE_39 – TYPE_43 evaluationType: description: Tipo de avaliação do fator de risco. type: string enum: – QUANTITATIVE – QUALITATIVE directionType: description: Tipo de ordenação. type: string enum: – ASC – DESC resultStatus: description: Status do retorno de uma primitiva. type: string enum: – SUCCESS – WARNING – ERROR layoutSummaryType: description: Tipo de resumo eSocial. type: string enum: – NON_PERIODICAL – PERIODICAL – TABLE layoutType: description: Tipo do layout do eSocial. type: string enum: – S2210 – S2220 – S2240 – S3000 operationCategoryType: description: Tipo da categoria de operação do layout. type: string enum: – ORIGINAL – RECTIFICATION operationType: description: Tipo de operação do layout. type: string enum: – INSERT – UPDATE – DELETE statusType: description: Status do layout. type: string enum: – WAITING_MANUAL_SUBMISSION – WAITING_AUTOMATIC_SUBMISSION – EDOC_ERROR – SENDING_TO_GOVERNMENT – WAITING_GOVERNMENT_RETURN – MESSAGE_RETURNED – RECEIPT_RETURNED – RECEIPT_MANUAL – EVENT_DELETED – EVENT_CANCELED – INTEGRATING – CANCEL_REGENERATED – EDOC_SUBMISSION_ERROR – EDOC_RETURN_FETCHING_ERROR statusEventType: description: Status do evento do eSocial type: string enum: – PROCESSING – WAITING_GOVERNMENT_RETURN – GOVERNMENT_RETURN – ERROR asoType: description: Tipo da ASO. type: string enum: – ADMISSION – DISMISSAL – BACK_TO_WORK – CHANGE_OF_FUNCTION environmentIdType: description: Tipo de identificação do ambiente. type: string enum: – PRODUCTION – RESTRICT_PRODUCTION environmentModeType: description: Tipo de local do ambiente. type: string enum: – EMPLOYER – THIRD eventEmissionType: description: Tipo do processo de emissão do evento. type: string enum: – EMPLOYER – GOVERNMENT_EMPLOYER – GOVERNMENT_WEB – GOVERNMENT_SIMPLE – GOVERNMENT_SPECIAL eventEmissionS3000Type: description: Tipo do processo de emissão do evento. type: string enum: – EMPLOYER – GOVERNMENT subscriptionType: description: Tipo de inscrição. type: string enum: – CNPJ – CPF – CAEPF – CNO certSubscriptionType: description: type: string enum: – CNPJ – CPF – EMPTY_STATE equipmentType: description: Tipo do equipamento. type: string enum: – EPI – EPC environmentSettingsType: description: Tipo de ambiente e-Social. type: string enum: – RESTRICT_PRODUCTION shippingMethodType: description: Tipo do envio. type: string enum: – AUTO – MANUAL catType: description: Tipo de CAT. type: string enum: – INITIAL – REOPENING – DEATH_COMMUNICATION accidentType: description: Tipo de Acidente de Trabalho. type: string enum: – TYPICAL – DISEASE catIssueType: description: A CAT foi emitida por. type: string enum: – EMPLOYER_INITIATIVE – COURT_ORDER – DETERMINATION_OF_SUPERVISORY_BODY accidentLocalType: description: Local do Acidente. type: string enum: – BRAZILIAN_EMPLOYER_ESTABLISHMENT – FOREIGN_EMPLOYER_ESTABLISHMENT – THIRD_PARTY_EMPLOYER_ESTABLISHMENT – PUBLIC_THOROUGHFARE – RURAL_AREA – VESSEL – OTHER bodySideType: description: Lateralidade. type: string enum: – NOT_APPLICABLE – LEFT – RIGHT – BOTH regionalCouncilType: description: Órgão de classe. type: string enum: – CRM – CRO – RMS modTreicapType: description: Modalidade do treinamento/capacitação. type: string enum: – PRESENTIAL – DISTANCE_EDUCATION – MIXED tpTreicapType: description: Tipo de treinamento/capacitação. type: string enum: – INITIAL – PERIODIC – RECYCLING – EVENTUAL – OTHER professionalType: description: O treinamento/capacitação foi ministrado por. type: string enum: – EMPLOYEE – THIRD nationalityType: description: O treinamento/capacitação foi ministrado por. type: string enum: – BRAZILIAN – FOREIGN stateAbbreviationType: description: Abreviação de estados. type: string enum: – AC – AL – AM – AP – BA – CE – DF – ES – GO – MA – MT – MS – MG – PA – PB – PR – PE – PI – RJ – RN – RS – RO – RR – SC – SP – SE – TO layoutSourceType: description: Origem do layout. type: string enum: – TYPED – IMPORTED – SENIOR_G6 – SENIOR_4W – THIRD_PARTY_INTEGRATION actionType: description: Tipo da ação. type: string enum: – SEND – CANCEL xmlStatusType: description: Status do xml. type: string enum: – IN_ANALYSIS – VALIDATION_ERROR – VALIDATION_SUCCESS – SENDING_TO_GOVERNMENT – WAITING_GOVERNMENT_RETURN – GOVERNMENT_RETURN – CANCELED_BY_USER providerStatusType: description: Situação do consumo do status do XML pelo prestador SST. type: string enum: – ON_PROVIDER – SENT_TO_PROVIDER – PROVIDER_ERROR – PROVIDER_PUBLISHING_ERROR providerType: description: Lista de prestadores SST homologados pelo sistema Integrador SST type: string enum: – CUSTOM – GSO – MED_NET – RS_DATA – SOC configurationMode: description: Modo de configuração por empresa type: string enum: – SINGLEPROVIDER – MULTIPLEPROVIDERS edocsConfigurationModeType: description: Modo de configuração do envio de informações ao eDocs type: string enum: – EDOCS_CONSUMES_PLATFORM_EVENTS – PLATFORM_SEND_EVENTS_TO_EDOCS importationSituationType: description: Situação da importação de eventos do eSocial type: string enum: – IN_PROGRESS – COMPLETED_WITH_ERRORS – COMPLETED_SUCCESSFULLY importationFileSituationType: description: Situação do arquivo de importação de evento eSocial type: string enum: – IMPORTED – NOT_IMPORTED governmentReturnType: description: Tipo de retorno do governo type: string enum: – RECEIPT_RETURNED – MESSAGE_RETURNED eventStatus: description: Status do evento do eSocial type: string enum: – SENDING_TO_GOVERNMENT – WAITING_GOVERNMENT_RETURN 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. type: object required: – ok properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. default: blobServiceRequestUploadResponse: description: Dados de retorno do upload de um arquivo. type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. blobServiceRequestUploadRequest: description: Dados necessários para o carregamento de um arquivo type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. thumbnail: type: boolean description: Condicional se será salvo um thumbnail. default: false blobServiceTempFile: description: Arquivo no blobService type: object required: – fileId – version properties: fileId: type: string description: Identificador do arquivo type: string description: Versão do arquivo layoutSituationDataQueryData: description: Dados de retorno da situação do layout do e-Social. type: object required: – eventId – jsonText – layoutType – receiptNumber – companySetting – environmentIdType properties: eventId: type: string maxLength: 36 description: Identificador do evento. jsonText: type: string description: Layout do e-Social em formato JSON. layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do layout do e-Social. receiptNumber: type: string description: Número do recibo. companySetting: type: object allOf: – #/definitions/companySettingData description: Configurações da empresa. environmentIdType: type: string allOf: – #/definitions/environmentIdType description: Tipo de ambiente. companySettingData: description: Configurações da empresa. type: object required: – subscriptionNumber properties: urlEDoc: type: string maxLength: 500 description: URL eDocs. userEDoc: type: string maxLength: 100 description: Usuário eDocs. passEDoc: type: string maxLength: 100 description: Senha eDocs. subscriptionNumber: type: string maxLength: 15 description: Número de inscrição da empresa. urlEDocHomologation: type: string maxLength: 500 description: URL eDocs Homologação. userEDocHomologation: type: string maxLength: 100 description: Usuário eDocs Homologação. passEDocHomologation: type: string maxLength: 100 description: Senha eDocs Homologação. subscriptionNumberCert: type: string maxLength: 15 description: Número de inscrição do certificado digital. subscriptionTypeCert: type: string allOf: – #/definitions/subscriptionType description: Tipo inscrição do certificado digital.\n 1 – CNPJ\n 2 – CPF subscriptionNumberCertHomolog: type: string maxLength: 15 description: Número de inscrição do certificado digital Homologação. subscriptionTypeCertHomolog: type: string allOf: – #/definitions/subscriptionType description: Tipo inscrição do certificado digital Homologação.\n 1 – CNPJ\n 2 – CPF dtoInformationData: description: DTO com informações sobre os DTO. type: object required: – json properties: json: type: string description: JSON representando o DTO. 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. governmentTable: description: Tabela de consulta do governo. type: object required: – code – name properties: code: type: string description: Código da tabela. name: type: string description: Descrição da tabela. baseLayout: description: Record base para todos os Layouts. discriminator: _discriminator type: object required: – _discriminator properties: xmlns: type: string description: Atributo necessário para geração do xml no padrão do governo. _discriminator: type: string description: returnGovernmentListData: description: Lista retorno do governo. type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/returnGovernmentData minimum: 1 description: Lista com os retornos do governo. returnGovernmentData: description: Retorno do governo. type: object properties: eventId: type: string maxLength: 36 description: ID do evento layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de layout statusType: type: string allOf: – #/definitions/statusType description: Status receiptNumber: type: string description: Número do recibo layoutMessage: type: string description: Mensagens ou críticas retornadas pelo governo layoutJsonText: description: Registro de json text de layout especifico type: object required: – id – layoutType – jsonText properties: id: type: string description: Id do layout layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do layout jsonText: type: string description: Json text salvo na base layoutIdentifier: description: Registro que identifica um layout, usando as chaves de id e tipo do layout type: object required: – layoutId – layoutType properties: layoutId: type: string description: Id do layout layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do layout configurationProviderSummary: description: Resumo da configuração de prestador type: object required: – id – situation – providerName – providerType – configurationBranchSummary – configurationBranchNames – s2210Type – s2220Type – s2240Type – s3000Type 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 s2210Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2210. s2220Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2220. s2240Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2240. s3000Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S3000. urlEDoc: type: string maxLength: 500 description: URL eDocs. userEDoc: type: string maxLength: 100 description: Usuário eDocs. passEDoc: type: string maxLength: 100 description: Senha eDocs. urlEDocHomologation: type: string maxLength: 500 description: URL eDocs Homologação. userEDocHomologation: type: string maxLength: 100 description: Usuário eDocs Homologação. passEDocHomologation: type: string maxLength: 100 description: Senha eDocs Homologação. subscriptionNumberCert: type: string maxLength: 15 description: Número de inscrição do certificado digital. subscriptionTypeCert: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital.\n 1 – CNPJ\n 2 – CPF subscriptionNumberCertHomolog: type: string maxLength: 15 description: Número de inscrição do certificado digital Homologação. subscriptionTypeCertHomolog: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital Homologação.\n 1 – CNPJ\n 2 – CPF 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 importationLogFilter: description: Dados referentes ao filtro que pode ser feito na tela de listagem de importações type: object properties: fromStartDate: type: string format: date-time description: Limite inferior do filtro pro início do processo de importação untilStartDate: type: string format: date-time description: Limite superior do filtro pro início do processo de importação fileName: type: string description: Nome do arquivo situationType: type: array items: type: string allOf: – #/definitions/importationSituationType description: Situação da importação batch: type: integer format: int64 description: Número do lote importationLogItem: description: Item representando um item de log que será mostrado na tela type: object required: – importationId – startDate – batch – situationType properties: importationId: type: string description: Id da importação startDate: type: string format: date-time description: Data de início da importação batch: type: integer format: int64 description: Número do lote da importação fileSummary: type: string description: Resumo dos nomes do arquivos importados situationType: type: string allOf: – #/definitions/importationSituationType description: Situação atual da importação statusEsocialXmlDTO: description: Retorno referente ao envio do evento do eSocial. type: object required: – id – providerXmlId – xmlStatus properties: id: type: string description: Identificador do registro na plataforma senior X. providerXmlId: type: string description: Identificador do XML no prestador SST xmlStatus: type: string allOf: – #/definitions/xmlStatusType description: Status do evento do eSocial validationMessage: type: string description: Mensagem referente a validação do evento. eventId: type: string maxLength: 36 description: ID do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceiptNumber: type: string description: Número do recibo retornado do governo. governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo esocialEventDTO: description: Evento do eSocial type: object required: – eventId – layoutType – xml properties: eventId: type: string maxLength: 36 description: ID do evento do eSocial layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de leiaute do eSocial xml: type: string description: XML do evento do eSocial. statusEsocialEventDTO: description: Informações do layout no governo type: object required: – eventId – statusEvent properties: eventId: type: string maxLength: 36 description: ID do evento do eSocial statusEvent: type: string allOf: – #/definitions/statusEventType description: Status do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceipt: type: string description: Número do recibo retornado do governo. governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo errorMessage: type: string description: Mensagem de erro no processamento ou envio do evento ao governo eSocialS2210: description: DTO com dados do layout S-2210. allOf: – #/definitions/baseLayout – type: object required: – evtCAT properties: evtCAT: type: object allOf: – #/definitions/evtCATS2210 description: Evento Comunicação de Acidente de Trabalho. evtCATS2210: description: Evento Comunicação de Acidente de Trabalho. type: object required: – id – ideEvento – ideEmpregador – ideVinculo – cat properties: id: type: string maxLength: 36 description: Identificação única do evento ideEvento: type: object allOf: – #/definitions/ideEventoS2210 description: Informações de Identificação do Evento. ideEmpregador: type: object allOf: – #/definitions/ideEmpregadorS2210 description: Informações de identificação do empregador. ideVinculo: type: object allOf: – #/definitions/ideVinculoS2210 description: Informações de Identificação do Trabalhador e do Vínculo. cat: type: object allOf: – #/definitions/catS2210 description: Informações da Comunicação de Acidente de Trabalho ideEventoS2210: description: Informações de Identificação do Evento. type: object required: – indRetif – tpAmb – procEmi – verProc properties: indRetif: type: string allOf: – #/definitions/operationCategoryType description: Informe [1] para arquivo original ou [2] para arquivo de retificação. nrRecibo: type: string maxLength: 40 description: Preencher com o número do recibo do arquivo a ser retificado. tpAmb: type: string allOf: – #/definitions/environmentIdType description: Identificação do ambiente:\n 1 – Produção;\n 2 – Produção restrita. procEmi: type: string allOf: – #/definitions/eventEmissionType description: Processo de emissão do evento:\n 1- Aplicativo do empregador;\n 2 – Aplicativo governamental – Empregador Doméstico;\n 3 – Aplicativo governamental – Web Geral;\n 4 – Aplicativo governamental – Microempreendedor Individual (MEI);\n 5 – Aplicativo governamental – Segurado Especial. verProc: type: string maxLength: 20 description: Versão do processo de emissão do evento. ideEmpregadorS2210: description: Informações de identificação do empregador. type: object required: – tpInsc – nrInsc properties: tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. nrInsc: type: string maxLength: 15 description: Informar o número de inscrição do contribuinte. ideVinculoS2210: description: Informações de Identificação do Trabalhador e do Vínculo. type: object required: – cpfTrab properties: cpfTrab: type: string maxLength: 11 description: Preencher com o número do CPF do trabalhador. matricula: type: string maxLength: 30 description: Matrícula atribuída ao trabalhador pela empresa ou, no caso de servidor\n público, a matrícula constante no Sistema de Administração de Recursos\n Humanos do órgão. codCateg: type: object allOf: – #/definitions/governmentTable description: Preencher com o código da categoria do trabalhador, conforme Tabela 01. catS2210: description: Informações da Comunicação de Acidente de Trabalho. type: object required: – dtAcid – tpAcid – tpCat – indCatObito – indComunPolicia – codSitGeradora – iniciatCAT – localAcidente – parteAtingida – agenteCausador properties: dtAcid: type: string format: date description: Data do Acidente. tpAcid: type: string allOf: – #/definitions/accidentType description: Tipo de Acidente de Trabalho, conforme Tabela 24. hrAcid: type: string maxLength: 4 description: Hora do Acidente. hrsTrabAntesAcid: type: string description: Horas trabalhadas antes da ocorrência do acidente. tpCat: type: string allOf: – #/definitions/catType description: Tipo de CAT. indCatObito: type: string allOf: – #/definitions/nominalDecisionType description: Houve Óbito? dtObito: type: string format: date description: Data do óbito. indComunPolicia: type: string allOf: – #/definitions/nominalDecisionType description: Houve comunicação à autoridade policial? codSitGeradora: type: object allOf: – #/definitions/governmentTable description: Preencher com o código da situação geradora do acidente, conforme Tabela 16. iniciatCAT: type: string allOf: – #/definitions/catIssueType description: A CAT foi emitida por. obsCAT: type: string maxLength: 999 description: Observação. localAcidente: type: object allOf: – #/definitions/localAcidenteS2210 description: Local do Acidente. parteAtingida: type: array items: type: object allOf: – #/definitions/parteAtingidaS2210 minimum: 1 description: Detalhamento da(s) parte(s) atingida(s) pelo acidente de trabalho. agenteCausador: type: array items: type: object allOf: – #/definitions/agenteCausadorS2210 minimum: 1 description: Detalhamento do(s) agente(s) causador(es) do acidente de trabalho. atestado: type: object allOf: – #/definitions/atestadoS2210 description: Atestado Médico. catOrigem: type: object allOf: – #/definitions/catOrigemS2210 description: Registro obrigatório que indica a CAT de origem, preenchido quando se tratar de CAT de reabertura ou de comunicação de óbito. localAcidenteS2210: description: Local do Acidente. type: object required: – tpLocal – tpLograd – dscLograd – nrLograd properties: tpLocal: type: string allOf: – #/definitions/accidentLocalType description: Tipo de local do acidente. dscLocal: type: string maxLength: 255 description: Especificação do local do acidente (pátio, rampa de acesso, posto de trabalho, etc.). tpLograd: type: object allOf: – #/definitions/governmentTable description: Tipo de Logradouro, conforme tabela 20. dscLograd: type: string maxLength: 100 description: Descrição do logradouro. nrLograd: type: string maxLength: 10 description: Número do logradouro. complemento: type: string maxLength: 30 description: Complemento do logradouro. bairro: type: string maxLength: 90 description: Nome do bairro/distrito. cep: type: string maxLength: 8 description: Código de Endereçamento Postal – CEP. codMunic: type: object allOf: – #/definitions/governmentTable description: Preencher com o código do município, conforme tabela do IBGE. uf: type: string allOf: – #/definitions/stateAbbreviationType description: Preencher com a sigla da Unidade da Federação. pais: type: object allOf: – #/definitions/table06InternationalCountryCode description: Preencher com o código do país, conforme Tabela 06. codPostal: type: string maxLength: 12 description: Código de Endereçamento Postal. ideLocalAcid: type: object allOf: – #/definitions/ideLocalAcidS2210 description: Identificação do local onde ocorreu o acidente. ideLocalAcidS2210: description: Identificação do local onde ocorreu o acidente. type: object required: – tpInsc – nrInsc properties: tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. nrInsc: type: string maxLength: 15 description: Informar o número de inscrição do contribuinte. parteAtingidaS2210: description: Detalhamento da(s) parte(s) atingida(s) pelo acidente de trabalho. type: object required: – codParteAting – lateralidade properties: codParteAting: type: object allOf: – #/definitions/governmentTable description: Preencher com o código correspondente a parte atingida, conforme Tabela 13. lateralidade: type: string allOf: – #/definitions/bodySideType description: Lateralidade. agenteCausadorS2210: description: Detalhamento do(s) agente(s) causador(es) do acidente de trabalho. type: object required: – codAgntCausador properties: codAgntCausador: type: object allOf: – #/definitions/governmentTable description: Preencher com o código correspondente ao agente causador do acidente, conforme Tabelas 14 ou 15. atestadoS2210: description: Atestado Médico. type: object required: – dtAtendimento – hrAtendimento – indInternacao – durTrat – indAfast – dscLesao – codCID – emitente properties: dtAtendimento: type: string format: date description: Data do atendimento. hrAtendimento: type: string maxLength: 4 description: Hora do atendimento. indInternacao: type: string allOf: – #/definitions/nominalDecisionType description: Indicativo de Internação. durTrat: type: integer format: int64 description: Duração estimada do tratamento, em dias. minimum: 0 maximum: 9999 indAfast: type: string allOf: – #/definitions/nominalDecisionType description: Indicativo do afastamento do trabalho durante o tratamento. dscLesao: type: object allOf: – #/definitions/governmentTable description: Preencher com a descrição da natureza da lesão, conforme Tabela 17. dscCompLesao: type: string maxLength: 200 description: Descrição complementar da lesão. diagProvavel: type: string maxLength: 100 description: Diagnóstico Provável. codCID: type: string maxLength: 4 description: Informar o código na tabela de Classificação Internacional de Doenças – CID. observacao: type: string maxLength: 255 description: Observação. emitente: type: object allOf: – #/definitions/emitenteS2210 description: Médico/Dentista que emitiu o atestado. emitenteS2210: description: Médico/Dentista que emitiu o atestado. type: object required: – nmEmit – ideOC – nrOC – ufOC properties: nmEmit: type: string maxLength: 70 description: Nome do médico/dentista que emitiu o atestado. ideOC: type: string allOf: – #/definitions/regionalCouncilType description: Órgão de classe. nrOC: type: string maxLength: 14 description: Número de Inscrição no órgão de classe. ufOC: type: string allOf: – #/definitions/stateAbbreviationType description: Sigla da UF do órgão de classe. catOrigemS2210: description: Registro obrigatório que indica a CAT de origem, preenchido quando se tratar de CAT de reabertura ou de comunicação de óbito. type: object properties: nrRecCatOrig: type: string maxLength: 40 description: Informar o número do recibo da CAT de origem. 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 eSocialS2220: description: DTO com dados do layout S-2220. allOf: – #/definitions/baseLayout – type: object required: – evtMonit properties: evtMonit: type: object allOf: – #/definitions/evtMonitS2220 description: Evento Monitoramento da Saúde do Trabalhador. evtMonitS2220: description: Evento Monitoramento da Saúde do Trabalhador. type: object required: – id – ideEvento – ideEmpregador – ideVinculo – exMedOcup properties: id: type: string maxLength: 36 description: Identificação única do evento. ideEvento: type: object allOf: – #/definitions/ideEventoS2220 description: Informações de Identificação do Evento. ideEmpregador: type: object allOf: – #/definitions/ideEmpregadorS2220 description: Informações de identificação do empregador. ideVinculo: type: object allOf: – #/definitions/ideVinculoS2220 description: Informações de Identificação do Trabalhador e do Vínculo. exMedOcup: type: object allOf: – #/definitions/exMedOcupS2220 description: Detalhamento das informações do exame médico ocupacional. ideEventoS2220: description: Informações de Identificação do Evento. type: object required: – indRetif – tpAmb – procEmi – verProc properties: indRetif: type: string allOf: – #/definitions/operationCategoryType description: Informe [1] para arquivo original ou [2] para arquivo de retificação. nrRecibo: type: string maxLength: 40 description: Preencher com o número do recibo do arquivo a ser retificado. tpAmb: type: string allOf: – #/definitions/environmentIdType description: Identificação do ambiente:\n 1 – Produção;\n 2 – Produção restrita. procEmi: type: string allOf: – #/definitions/eventEmissionType description: Processo de emissão do evento:\n 1- Aplicativo do empregador;\n 2 – Aplicativo governamental – Empregador Doméstico;\n 3 – Aplicativo governamental – Web Geral;\n 4 – Aplicativo governamental – Microempreendedor Individual (MEI);\n 5 – Aplicativo governamental – Segurado Especial. verProc: type: string maxLength: 20 description: Versão do processo de emissão do evento. ideEmpregadorS2220: description: Informações de identificação do empregador. type: object required: – tpInsc – nrInsc properties: tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. nrInsc: type: string maxLength: 15 description: Informar o número de inscrição do contribuinte. ideVinculoS2220: description: Informações de Identificação do Trabalhador e do Vínculo. type: object required: – cpfTrab properties: cpfTrab: type: string maxLength: 11 description: Preencher com o número do CPF do trabalhador. matricula: type: string maxLength: 30 description: Matrícula atribuída ao trabalhador pela empresa ou, no caso de servidor\n público, a matrícula constante no Sistema de Administração de Recursos\n Humanos do órgão. codCateg: type: object allOf: – #/definitions/governmentTable description: Preencher com o código da categoria do trabalhador, conforme Tabela 01. exMedOcupS2220: description: Detalhamento das informações do exame médico ocupacional. type: object required: – tpExameOcup – aso properties: tpExameOcup: type: string allOf: – #/definitions/occupationalMedicalExaminationType description: Tipo do exame médico ocupacional, conforme opções abaixo:\n 0 – Exame médico admissional;\n 1 – Exame médico periódico, conforme NR7 do MTb e/ou planejamento do PCMSO;\n 2 – Exame médico de retorno ao trabalho;\n 3 – Exame médico de mudança de função;\n 4 – Exame médico de monitoração pontual, não enquadrado nos demais casos;\n 9 – Exame médico demissional. aso: type: object allOf: – #/definitions/asoS2220 description: Detalhamento das informações do Atestado de Saúde Ocupacional (ASO). respMonit: type: object allOf: – #/definitions/respMonitS2220 description: Informações sobre o médico responsável/coordenador do PCMSO. asoS2220: description: Detalhamento das informações do Atestado de Saúde Ocupacional (ASO). type: object required: – dtAso – resAso – exame – medico properties: dtAso: type: string format: date description: Data de emissão do ASO. resAso: type: string allOf: – #/definitions/asoResultType description: Resultado do ASO, conforme opções abaixo:\n 1 – Apto;\n 2 – Inapto. exame: type: array items: type: object allOf: – #/definitions/exameS2220 minimum: 1 description: Registro que detalha as avaliações clínicas e os exames complementares. medico: type: object allOf: – #/definitions/medicoS2220 description: Informações sobre o médico emitente do ASO. exameS2220: description: Registro que detalha as avaliações clínicas e os exames complementares. type: object required: – dtExm – procRealizado – ordExame properties: dtExm: type: string format: date description: Data do exame realizado. procRealizado: type: object allOf: – #/definitions/governmentTable description: Código do procedimento diagnóstico constante da Tabela 27. obsProc: type: string maxLength: 999 description: Observação sobre o procedimento diagnóstico realizado. ordExame: type: string allOf: – #/definitions/examOrderType description: Ordem do Exame.\n 1 – Inicial.\n 2 – Sequencial. indResult: type: string allOf: – #/definitions/resultExamIndicationType description: Indicação dos Resultados.\n 1 – Normal\n 2 – Alterado\n 3 – Estável\n 4 – Agravamento. medicoS2220: description: Informações sobre o médico emitente do ASO. type: object required: – nmMed – nrCRM – ufCRM properties: nmMed: type: string maxLength: 70 description: Preencher com o nome do médico emitente do ASO. nrCRM: type: string maxLength: 8 description: Número de inscrição do médico emitente do ASO no Conselho Regional de Medicina (CRM). ufCRM: type: string allOf: – #/definitions/stateAbbreviationType description: Preencher com a sigla da UF de expedição do CRM. respMonitS2220: description: Informações sobre o médico responsável/coordenador do PCMSO. type: object required: – nmResp – nrCRM – ufCRM properties: cpfResp: type: string maxLength: 11 description: Preencher com o CPF do médico responsável/coordenador do PCMSO. nmResp: type: string maxLength: 70 description: Preencher com o nome do médico responsável/coordenador do PCMSO. nrCRM: type: string maxLength: 8 description: Número de inscrição do médico responsável/coordenador do PCMSO no CRM. ufCRM: type: string allOf: – #/definitions/stateAbbreviationType description: Preencher com a sigla da UF de expedição do CRM. eSocialS2240: description: DTO com dados do layout S-2240. allOf: – #/definitions/baseLayout – type: object required: – evtExpRisco properties: evtExpRisco: type: object allOf: – #/definitions/evtExpRiscoS2240 description: Evento Condições Ambientais do Trabalho – Fatores de Risco. evtExpRiscoS2240: description: Evento Condições Ambientais do Trabalho – Fatores de Risco. type: object required: – id – ideEvento – ideEmpregador – ideVinculo – infoExpRisco properties: id: type: string maxLength: 36 description: Identificação única do evento. ideEvento: type: object allOf: – #/definitions/ideEventoS2240 description: Informações de Identificação do Evento. ideEmpregador: type: object allOf: – #/definitions/ideEmpregadorS2240 description: Informações de identificação do empregador. ideVinculo: type: object allOf: – #/definitions/ideVinculoS2240 description: Informações de Identificação do Trabalhador e do Vínculo. infoExpRisco: type: object allOf: – #/definitions/infoExpRiscoS2240 description: Informações sobre o ambiente de trabalho, atividades desempenhadas e\n exposição a fatores de risco. ideEventoS2240: description: Informações de Identificação do Evento. type: object required: – indRetif – tpAmb – procEmi – verProc properties: indRetif: type: string allOf: – #/definitions/operationCategoryType description: Informe [1] para arquivo original ou [2] para arquivo de retificação. nrRecibo: type: string maxLength: 40 description: Preencher com o número do recibo do arquivo a ser retificado. tpAmb: type: string allOf: – #/definitions/environmentIdType description: Identificação do ambiente:\n 1 – Produção;\n 2 – Produção restrita. procEmi: type: string allOf: – #/definitions/eventEmissionType description: Processo de emissão do evento:\n 1- Aplicativo do empregador;\n 2 – Aplicativo governamental – Empregador Doméstico;\n 3 – Aplicativo governamental – Web Geral;\n 4 – Aplicativo governamental – Microempreendedor Individual (MEI);\n 5 – Aplicativo governamental – Segurado Especial. verProc: type: string maxLength: 20 description: Versão do processo de emissão do evento. ideEmpregadorS2240: description: Informações de identificação do empregador. type: object required: – tpInsc – nrInsc properties: tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. nrInsc: type: string maxLength: 15 description: Informar o número de inscrição do contribuinte. ideVinculoS2240: description: Informações de Identificação do Trabalhador e do Vínculo. type: object required: – cpfTrab properties: cpfTrab: type: string maxLength: 11 description: Preencher com o número do CPF do trabalhador. nisTrab: type: string maxLength: 11 description: Preencher com o Número de Identificação Social – NIS, o qual pode ser o PIS, PASEP ou NIT. matricula: type: string maxLength: 30 description: Matrícula atribuída ao trabalhador pela empresa ou, no caso de servidor\n público, a matrícula constante no Sistema de Administração de Recursos\n Humanos do órgão. codCateg: type: object allOf: – #/definitions/governmentTable description: Preencher com o código da categoria do trabalhador, conforme Tabela 01. infoExpRiscoS2240: description: Informações sobre o ambiente de trabalho, atividades desempenhadas e\n exposição a fatores de risco. type: object required: – dtIniCondicao – infoAmb – infoAtiv – fatRisco – respReg properties: dtIniCondicao: type: string format: date description: Informar a data em que o trabalhador iniciou as atividades no ambiente de\n trabalho ou a data de início da obrigatoriedade deste evento para o\n empregador no eSocial, a que for mais recente. infoAmb: type: object allOf: – #/definitions/infoAmbS2240 description: Informações relativas ao ambiente de trabalho. infoAtiv: type: object allOf: – #/definitions/infoAtivS2240 description: Descrição das Atividades Desempenhadas fatRisco: type: array items: type: object allOf: – #/definitions/fatRiscoS2240 minimum: 1 description: Fator(es) de risco ao qual o trabalhador está exposto. respReg: type: array items: type: object allOf: – #/definitions/respRegS2240 minimum: 1 description: Informações relativas ao responsável pelos registros ambientais. obs: type: object allOf: – #/definitions/obsS2240 description: Observações relativas a registros ambientais. infoAmbS2240: description: Informações relativas ao ambiente de trabalho. type: object required: – localAmb – dscSetor – tpInsc – nrInsc properties: localAmb: type: string allOf: – #/definitions/environmentModeType description: Tipo do local do ambiente dscSetor: type: string maxLength: 99 description: Descrição do lugar administrativo tpInsc: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição do local nrInsc: type: string maxLength: 14 description: Número de inscrição do local infoAtivS2240: description: Descrição das Atividades Desempenhadas. type: object required: – dscAtivDes properties: dscAtivDes: type: string maxLength: 999 description: Descrição das atividades, físicas ou mentais, realizadas pelo trabalhador, por\n força do poder de comando a que se submete. fatRiscoS2240: description: Fator(es) de risco ao qual o trabalhador está exposto. type: object required: – codFatRis – tpAval – epcEpi properties: codFatRis: type: object allOf: – #/definitions/governmentTable description: Informar o código do fator de risco ao qual o trabalhador está exposto,\n conforme Tabela 24. dscFatRisc: type: string maxLength: 999 description: Código do fator de risco tpAval: type: string allOf: – #/definitions/evaluationType description: Tipo de avaliação do fator de risco:\n 1 – Critério quantitativo;\n 2 – Critério qualitativo. intConc: type: number format: double description: Intensidade ou concentração da exposição do trabalhador ao fator de risco\n cujo critério de avaliação seja quantitativo. minimum: 0.00 maximum: 99999999.99 limTol: type: number format: double description: Limite de Tolerância calculado para agentes específicos, conforme técnica\n de medição exigida na legislação minimum: 0.00 maximum: 99999999.99 unMed: type: string allOf: – #/definitions/unityOfMeasurementType description: Unidade de medida da intensidade ou concentração. tecMedicao: type: string maxLength: 40 description: Técnica utilizada para medição da intensidade ou concentração. epcEpi: type: object allOf: – #/definitions/epcEpiS2240 description: Informações relativas a Equipamentos de Proteção Coletiva – EPC e\n Equipamentos de Proteção Individual – EPI. epcEpiS2240: description: Informações relativas a Equipamentos de Proteção Coletiva – EPC e\n Equipamentos de Proteção Individual – EPI. type: object required: – utilizEPC – utilizEPI properties: utilizEPC: type: string allOf: – #/definitions/implementDecisionType description: Utilização de EPC? eficEpc: type: string allOf: – #/definitions/nominalDecisionType description: OS EPCs são eficazes na neutralização dos riscos ao trabalhador? utilizEPI: type: string allOf: – #/definitions/specialDecisionType description: Utilização de EPI? epi: type: array items: type: object allOf: – #/definitions/epiS2240 description: Equipamentos de Proteção Individual – EPI. epiCompl: type: object allOf: – #/definitions/epiComplS2240 description: Requisitos das NR-06 e NR-09 pelos EPIs informados epiS2240: description: Equipamentos de Proteção Individual – EPI. type: object required: – eficEpi properties: docAval: type: string maxLength: 255 description: Certificado de Aprovação do EPI. dscEPI: type: string maxLength: 999 description: Descrição do equipamento de proteção. eficEpi: type: string allOf: – #/definitions/nominalDecisionType description: O EPI é eficaz na neutralização dos riscos ao trabalhador? epiComplS2240: description: type: object required: – medProtecao – condFuncto – usoInint – przValid – periodicTroca – higienizacao properties: medProtecao: type: string allOf: – #/definitions/nominalDecisionType description: Foi tentada a implementação de medidas de proteção coletiva, de caráter\n administrativo ou de organização, optando-se pelo EPI por inviabilidade\n técnica, insuficiência ou interinidade, ou ainda em caráter complementar ou\n emergencial? condFuncto: type: string allOf: – #/definitions/nominalDecisionType description: Foram observadas as condições de funcionamento e do uso ininterrupto do\n EPI ao logo do tempo, conforme especificação técnica do fabricante nacional\n ou importador, ajustadas às condições de campo? usoInint: type: string allOf: – #/definitions/nominalDecisionType description: Foi observado o uso ininterrupto do EPI ao longo do tempo, conforme especificação\n técnica do fabricante nacional ou importador, ajustadas às condições de campo? przValid: type: string allOf: – #/definitions/nominalDecisionType description: Foi observado o prazo de validade do Certificado de Aprovação – CA do\n MTb no momento da compra do EPI? periodicTroca: type: string allOf: – #/definitions/nominalDecisionType description: É observada a periodicidade de troca definida pelo fabricante nacional ou\n importador e/ou programas ambientais, comprovada mediante recibo\n assinado pelo usuário em época própria? higienizacao: type: string allOf: – #/definitions/nominalDecisionType description: É observada a higienização conforme orientação do fabricante nacional ou\n importador? respRegS2240: description: Informações relativas ao responsável pelos registros ambientais. type: object required: – cpfResp – nisResp – nmResp – ideOC – nrOC – ufOC properties: cpfResp: type: string maxLength: 11 description: Preencher com o CPF do responsável pelos registros ambientais.\n Validação: Deve ser um CPF válido. nisResp: type: string maxLength: 11 description: Preencher com o Número de Identificação Social – NIS do responsável pelos registros ambientais, o qual pode ser o PIS, PASEP ou NIT. nmResp: type: string maxLength: 70 description: Preencher com o nome do responsável pelos registros ambientais. ideOC: type: string allOf: – #/definitions/classOrganType description: Órgão de classe ao qual o responsável pelos registros ambientais está\n vinculado:\n 1 – Conselho Regional de Medicina (CRM);\n 4 – Conselho Regional de Engenharia e Agronomia (CREA);\n 9 – Outros. dscOC: type: string maxLength: 20 description: Descrição (sigla) do órgão de classe ao qual o responsável pelos registros\n ambientais está vinculado. nrOC: type: string maxLength: 14 description: Número de Inscrição no órgão de classe. ufOC: type: string allOf: – #/definitions/stateAbbreviationType description: Sigla da UF do órgão de classe. obsS2240: description: Observações relativas a registros ambientais. type: object required: – obsCompl properties: obsCompl: type: string maxLength: 999 description: Observação(ões) complementar(es) referente(s) a registros ambientais. eSocialS3000: description: DTO com dados do layout S-3000. allOf: – #/definitions/baseLayout – type: object required: – evtExclusao properties: evtExclusao: type: object allOf: – #/definitions/evtExclusaoS3000 description: Evento de Exclusão. evtExclusaoS3000: description: Evento de Exclusão. type: object required: – id – ideEvento – ideEmpregador – infoExclusao properties: id: type: string maxLength: 36 description: Identificação única do evento. ideEvento: type: object allOf: – #/definitions/ideEventoS3000 description: Informações de identificação do evento. ideEmpregador: type: object allOf: – #/definitions/ideEmpregadorS3000 description: Informações de identificação do empregador. infoExclusao: type: object allOf: – #/definitions/infoExclusaoS3000 description: Registro que identifica o evento objeto da exclusão. ideEventoS3000: description: Informações de identificação do evento. type: object required: – tpAmb – procEmi – verProc properties: tpAmb: type: string allOf: – #/definitions/environmentIdType description: Identificação do ambiente:\n 1 – Produção;\n 2 – Produção restrita. procEmi: type: string allOf: – #/definitions/eventEmissionType description: Processo de emissão do evento:\n 1- Aplicativo do empregador;\n 2 – Aplicativo governamental. verProc: type: string maxLength: 20 description: Versão do processo de emissão do evento\n Informar a versão do aplicativo emissor do evento. ideEmpregadorS3000: description: Informações de identificação do empregador. type: object required: – tpInsc – nrInsc properties: tpInsc: type: string allOf: – #/definitions/subscriptionType description: Preencher com o código correspondente ao tipo de inscrição. nrInsc: type: string maxLength: 15 description: Informar o número de inscrição do contribuinte de acordo com o tipo de inscrição indicado. infoExclusaoS3000: description: Registro que identifica o evento objeto da exclusão. type: object required: – tpEvento – nrRecEvt properties: tpEvento: type: string allOf: – #/definitions/eventS3000Type description: Preencher com o tipo de evento, conforme tabela 9. nrRecEvt: type: string maxLength: 40 description: Preencher com o número do recibo do evento que será excluído. ideTrabalhador: type: object allOf: – #/definitions/ideTrabalhadorS3000 description: Registro que identifica a qual trabalhador refere-se o evento a ser excluído. ideTrabalhadorS3000: description: Registro que identifica a qual trabalhador refere-se o evento a ser excluído. type: object required: – cpfTrab properties: cpfTrab: type: string maxLength: 11 description: Preencher com o número do CPF do trabalhador. 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. layoutUpdate: description: Informações necessárias para fazer um update parcial em uma entidade de LayoutSituation type: object required: – layoutSituationId – statusType properties: layoutSituationId: type: string description: Id da situação do layout. statusType: type: string allOf: – #/definitions/statusType description: Tipo do status para o layout. receiptNumber: type: string description: Número do recibo. layoutMessage: type: string description: Mensagem de erro ou retorno do governo (caso houver). processError: type: string description: Mensagem de erro no processamento stackTrace: type: string description: StackTrace erro de processamento importationInformation: description: Informações da importação type: object required: – startDate – situationType – successCount – errorCount – batch properties: startDate: type: string format: date-time description: Data de início da importação endDate: type: string format: date-time description: Data do fim da importação situationType: type: string allOf: – #/definitions/importationSituationType description: Situação da importação successCount: type: integer format: int64 description: Número de arquivos importados com sucesso errorCount: type: integer format: int64 description: Número de arquivos importados com erros batch: type: integer format: int64 description: Número do lote importationESocialEventItem: description: Registro de evento do eSocial gerado a partir de uma importação type: object required: – situationType – fileOrigin properties: situationType: type: string allOf: – #/definitions/importationFileSituationType description: Situação da importação layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do evento eventId: type: string description: Id do evento fileOrigin: type: string description: Origem do arquivo observations: type: string description: Observações layoutSituationId: type: string description: Id da pendência de envio importationFileItem: description: Registro de arquivo de importação de eventos do eSocial type: object required: – fileName – eSocialEventCount – eSocialEventSuccessCount – eSocialEventErrorCount properties: fileName: type: string description: Nome do arquivo eSocialEventCount: type: integer format: int64 description: Número de eventos dos eSocial eSocialEventSuccessCount: type: integer format: int64 description: Número de eventos do eSocial importados com sucesso eSocialEventErrorCount: type: integer format: int64 description: Número de eventos do eSocial importados com erros observations: type: string description: Observações tenantConfiguration: description: Configurações do Tenant. type: object required: – id – blobServiceSecret properties: id: type: string format: uuid description: Id da entidade. blobServiceSecret: type: string maxLength: 36 description: Chave de segredo do BlobService. table01CategoryOfWorker: description: Tabela 01 – Categorias de Trabalhadores. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 3 description: Código da categoria do trabalhador. name: type: string description: Descrição da categoria do trabalhador. expirationDate: type: string format: date description: Data de expiração do registro. table06InternationalCountryCode: description: Tabela 06 – Países. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 3 description: Código do país. name: type: string description: Nome do país. creationDate: type: string format: date description: Data de criação do registro. expirationDate: type: string format: date description: Data de expiração do registro. table13BodyPartDamage: description: Tabela 13 – Parte do corpo atingida. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código da Parte do corpo atingida. name: type: string description: Descrição da Parte do corpo atingida. expirationDate: type: string format: date description: Data de expiração do registro. table14And15CauserAgent: description: Tabela 14 e 15 – Agente Causador do Acidente de Trabalho e Agente Causador / Situação Geradora de Doença Profissional. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código do Agente Causador / Situação Geradora de Doença Profissional. name: type: string description: Descrição do Agente Causador / Situação Geradora de Doença Profissional. expirationDate: type: string format: date description: Data de expiração do registro. table15And16CauserSituation: description: Tabela 16 – Situação Geradora do Acidente de Trabalho. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código da Situação Geradora do Acidente de Trabalho. name: type: string description: Descrição da Situação Geradora do Acidente de Trabalho. expirationDate: type: string format: date description: Data de expiração do registro. table17InjuryNature: description: Tabela 17 – Descrição da Natureza da Lesão. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código da Natureza da Lesão. name: type: string description: Descrição da Natureza da Lesão. expirationDate: type: string format: date description: Data de expiração do registro. table20PublicPlaceType: description: Tabela 20 – Tipos de Logradouro. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código do logradouro. name: type: string description: Descrição do logradouro. expirationDate: type: string format: date description: Data de expiração do registro. table24RiskFactor: description: Tabela 24 – Fatores de Riscos do Meio Ambiente do Trabalho. type: object required: – code – name – groupRisk – subgroupRisk – observations properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 9 description: Código do fator de risco. name: type: string maxLength: 255 description: Descrição do fator de risco. groupRisk: type: string maxLength: 255 description: Grupo do fator de risco subgroupRisk: type: string maxLength: 255 description: Subgrupo do fator de risco expirationDate: type: string format: date description: Data de expiração do registro. observations: type: string maxLength: 255 description: Observações table27DiagnosticAndProcedure: description: Tabela 27 – Procedimentos Diagnósticos. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 4 description: Código procedimento. name: type: string description: Descrição procedimento expirationDate: type: string format: date description: data de expiração do registro table28ActivityOfWorker: description: Tabela 28 – Atividades Periculosas, Insalubres e/ou Especiais. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 6 description: Código da atividade do trabalhador. name: type: string description: Descrição da atividade do trabalhador. expirationDate: type: string format: date description: Data de expiração do registro. table29TrainingCode: description: Tabela 29 – Treinamentos, Capacitações e Exercícios Simulados. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 4 description: Código treinamento/capacitação. name: type: string description: Descrição treinamento/capacitação. expirationDate: type: string format: date description: data de expiração do registro cboCode: description: Tabela CBO – Classificação Brasileira de Ocupação. type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 4 description: Código da ocupação. name: type: string description: Descrição da ocupação. expirationDate: type: string format: date description: data de expiração do registro companySetting: description: Definições da empresa. type: object required: – companyName – subscriptionNumber – subscriptionType – s2210Type – s2220Type – s2240Type – s3000Type properties: id: type: string format: uuid description: Id da entidade. companyName: type: string description: Nome da empresa. subscriptionNumber: type: string maxLength: 15 description: Número de inscrição da empresa. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição.\n 1 – CNPJ\n 2 – CPF\n 3 – CAEPF (Cadastro de Atividade Econômica de Pessoa Física)\n 4 – CNO (Cadastro Nacional de Obra) s2210Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2210. s2220Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2220. s2240Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2240. s3000Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S3000. urlEDoc: type: string maxLength: 500 description: URL eDocs. userEDoc: type: string maxLength: 100 description: Usuário eDocs. passEDoc: type: string maxLength: 100 description: Senha eDocs. urlEDocHomologation: type: string maxLength: 500 description: URL eDocs Homologação. userEDocHomologation: type: string maxLength: 100 description: Usuário eDocs Homologação. passEDocHomologation: type: string maxLength: 100 description: Senha eDocs Homologação. subscriptionNumberCert: type: string maxLength: 15 description: Número de inscrição do certificado digital. subscriptionTypeCert: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital.\n 1 – CNPJ\n 2 – CPF subscriptionNumberCertHomolog: type: string maxLength: 15 description: Número de inscrição do certificado digital Homologação. subscriptionTypeCertHomolog: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital Homologação.\n 1 – CNPJ\n 2 – CPF 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 no sistema de folha de pagamento 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: – situation – providerName – providerType – s2210Type – s2220Type – s2240Type – s3000Type properties: id: type: string format: uuid description: Id da entidade situation: type: boolean description: Situação providerName: type: string maxLength: 255 description: Nome prestador SST providerType: type: string allOf: – #/definitions/providerType description: Sistema prestador SST companyProviderIdentification: type: string maxLength: 255 description: Código de identificação da empresa no prestador SST configurationCompany: type: object allOf: – #/definitions/configurationCompany description: Relacionamento com a empresa s2210Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2210. s2220Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2220. s2240Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S2240. s3000Type: type: string allOf: – #/definitions/shippingMethodType description: Configuração do envio do layout S3000. urlEDoc: type: string maxLength: 500 description: URL eDocs. userEDoc: type: string maxLength: 100 description: Usuário eDocs. passEDoc: type: string maxLength: 100 description: Senha eDocs. urlEDocHomologation: type: string maxLength: 500 description: URL eDocs Homologação. userEDocHomologation: type: string maxLength: 100 description: Usuário eDocs Homologação. passEDocHomologation: type: string maxLength: 100 description: Senha eDocs Homologação. subscriptionNumberCert: type: string maxLength: 15 description: Número de inscrição do certificado digital. subscriptionTypeCert: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital.\n 1 – CNPJ\n 2 – CPF subscriptionNumberCertHomolog: type: string maxLength: 15 description: Número de inscrição do certificado digital Homologação. subscriptionTypeCertHomolog: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital Homologação.\n 1 – CNPJ\n 2 – CPF configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de configuração por filial configurationBranch: description: Configuração do prestador SST por filial type: object required: – situation – shortBranchName – subscriptionType – subscriptionNumber – s2210 – s2220 – s2240 – s3000 properties: id: type: string format: uuid description: Id da entidade situation: type: boolean description: Situação shortBranchName: type: string maxLength: 255 description: Apelido da filial subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição subscriptionNumber: type: string maxLength: 15 description: Número de inscrição branchProviderIdentification: type: string description: Código de identificação da empresa no Prestador SST s2210: type: boolean description: Integração ativa para o evento S-2210 s2220: type: boolean description: Integração ativa para o evento S-2220 s2240: type: boolean description: Integração ativa para o evento S-2240 s3000: type: boolean description: Integração ativa para o evento S-3000 configurationProvider: type: object allOf: – #/definitions/configurationProvider description: Relacionamento com a configuração do prestador ibgeCity: description: Cidades do IBGE. type: object required: – code – name – stateAbbreviationType properties: id: type: string format: uuid description: Id da entidade. code: type: string maxLength: 7 description: Código da cidade do IBGE. name: type: string description: Nome da cidade. stateAbbreviationType: type: string allOf: – #/definitions/stateAbbreviationType description: Abreviação do estado. importation: description: Entidade referente ao processo de importação type: object properties: id: type: string format: uuid description: Id da entidade. startDate: type: string format: date-time description: Data do ínicio do processo de importação endDate: type: string format: date-time description: Data do fim do processo de importação situationType: type: string allOf: – #/definitions/importationSituationType description: Situação atual do processo de importação batch: type: integer format: int64 description: Identificador único do lote observations: type: string description: Observações referentes ao processo de importação importationEventFiles: type: array items: type: object allOf: – #/definitions/importationEventFile description: Arquivos importados importationZipFiles: type: array items: type: object allOf: – #/definitions/importationZipFile description: Arquivos ZIP importados importationEventFile: description: Arquivo referente ao evento eSocial no processo de importação type: object properties: id: type: string format: uuid description: Id da entidade. fileName: type: string description: Nome do arquivo situationType: type: string allOf: – #/definitions/importationFileSituationType description: Situação da importação do arquivo layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do evento eventId: type: string maxLength: 36 description: Id do evento observations: type: string description: Observações referêntes ao arquivo importation: type: object allOf: – #/definitions/importation description: Importação da qual esse arquivo pertence zipFile: type: object allOf: – #/definitions/importationZipFile description: Arquivo ZIP do qual esse arquivo pertence importationZipFile: description: Arquivo ZIP pertencente a importação de eventos eSocial type: object required: – importationEventFiles properties: id: type: string format: uuid description: Id da entidade. fileName: type: string description: Nome do arquivo situationType: type: string allOf: – #/definitions/importationFileSituationType description: Situação da importação do arquivo observations: type: string description: Observações referêntes ao arquivo importation: type: object allOf: – #/definitions/importation description: Importação da qual esse ZIP pertence importationEventFiles: type: array items: type: object allOf: – #/definitions/importationEventFile minimum: 1 description: Arquivos pertencentes a esse zip layoutSituation: description: Situação de layout do eSocial. type: object required: – layoutId – eventId – eventDate – layoutType – layoutSourceType – statusType – employerDocumentNumber – subscriptionType – environmentIdType – sendPriority – configurationId properties: id: type: string format: uuid description: Id da entidade. layoutId: type: string maxLength: 36 description: Identificador do layout. eventId: type: string maxLength: 36 description: Identificador do evento. eventDate: type: string format: date-time description: Data e hora do evento. layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do layout. layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. operationType: type: string allOf: – #/definitions/operationType description: Tipo da operação. statusType: type: string allOf: – #/definitions/statusType description: Status do layout. layoutMessage: type: string description: Mensagem do layout (Erro ou Retorno do governo). receiptNumber: type: string maxLength: 100 description: Número do recibo. registrationNumber: type: string maxLength: 30 description: Número de matricula employerDocumentNumber: type: string maxLength: 15 description: CPF / CNPJ do empregador. employeeDocumentNumber: type: string maxLength: 11 description: CPF do trabalhador. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição.\n 1 – CNPJ\n 2 – CPF\n 3 – CAEPF (Cadastro de Atividade Econômica de Pessoa Física)\n 4 – CNO (Cadastro Nacional de Obra) environmentIdType: type: string allOf: – #/definitions/environmentIdType description: Tipo de ambiente. sendPriority: type: integer format: int64 description: Prioridade de envio. layoutSituationMessage: type: string description: Mensagem de erro no processamento layoutSituationStackTrace: type: string description: StackTrace erro de processamento configurationId: type: string maxLength: 36 description: Identificador da configuração. batch: type: integer format: int64 description: Lote de importação que originou o evento rawGovernmentReturn: type: string description: Retorno do governo layoutSituationDependency: description: Dependências de envio. type: object required: – layoutSituation – layoutSituationDependency properties: id: type: string format: uuid description: Id da entidade. layoutSituation: type: object allOf: – #/definitions/layoutSituation description: Situação de layout do eSocial. layoutSituationDependency: type: object allOf: – #/definitions/layoutSituation description: Situação de layout do eSocial. layoutS2210: description: S-2220 – Monitoramento da Saúde do Trabalhador. type: object required: – layoutSourceType – startDate – jsonText properties: id: type: string format: uuid description: Id da entidade. layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. eventId: type: string maxLength: 36 description: Identificador do evento. eventDate: type: string format: date-time description: Data e hora do evento. employerDocumentNumber: type: string maxLength: 14 description: CPF / CNPJ do empregador. employeeDocumentNumber: type: string maxLength: 11 description: CPF do trabalhador. registrationNumber: type: string maxLength: 30 description: Número de matricula receiptNumber: type: string maxLength: 100 description: Número do recibo. startDate: type: string format: date description: Data do acidente. startTime: type: string description: Horário do acidente environmentCode: type: string maxLength: 30 description: Código do ambiente. deathDate: type: string format: date description: Data do óbito. jsonText: type: object allOf: – #/definitions/eSocialS2210 description: Dados completo do layout em JSON. tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. providerXml: type: object allOf: – #/definitions/providerXml description: Xml recebido do prestador. batch: type: integer format: int64 description: Lote de importação que originou o evento layoutS2220: description: S-2220 – Monitoramento da Saúde do Trabalhador. type: object required: – layoutSourceType – jsonText properties: id: type: string format: uuid description: Id da entidade. layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. eventId: type: string maxLength: 36 description: Identificador do evento. eventDate: type: string format: date-time description: Data e hora do evento. employerDocumentNumber: type: string maxLength: 15 description: CPF / CNPJ do empregador. employeeDocumentNumber: type: string maxLength: 11 description: CPF do trabalhador. registrationNumber: type: string maxLength: 30 description: Número de matricula receiptNumber: type: string maxLength: 100 description: Número do recibo. startDate: type: string format: date description: Data de emissão da ASO. tpExameOcup: type: string allOf: – #/definitions/occupationalMedicalExaminationType description: Tipo do exame médico ocupacional jsonText: type: object allOf: – #/definitions/eSocialS2220 description: Dados completo do layout em JSON. tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. providerXml: type: object allOf: – #/definitions/providerXml description: Xml recebido do prestador. batch: type: integer format: int64 description: Lote de importação que originou o evento layoutS2240: description: S-2240 – Condições Ambientais do Trabalho – Fatores de Risco. type: object required: – layoutSourceType – jsonText properties: id: type: string format: uuid description: Id da entidade. layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. eventId: type: string maxLength: 36 description: Identificador do evento. eventDate: type: string format: date-time description: Data e hora do evento. employerDocumentNumber: type: string maxLength: 15 description: CPF / CNPJ do empregador. employeeDocumentNumber: type: string maxLength: 11 description: CPF do trabalhador. registrationNumber: type: string maxLength: 30 description: Número de matricula receiptNumber: type: string maxLength: 100 description: Número do recibo. startDate: type: string format: date description: Data de inicio do layout. jsonText: type: object allOf: – #/definitions/eSocialS2240 description: Dados completo do layout em JSON. tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. providerXml: type: object allOf: – #/definitions/providerXml description: Xml recebido do prestador. batch: type: integer format: int64 description: Lote de importação que originou o evento layoutS3000: description: S-3000 – Exclusão de eventos. type: object required: – layoutSourceType – jsonText properties: id: type: string format: uuid description: Id da entidade. layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. eventId: type: string maxLength: 36 description: Identificador do evento. eventDate: type: string format: date-time description: Data e hora do evento. employerDocumentNumber: type: string maxLength: 15 description: CPF / CNPJ do empregador. employeeDocumentNumber: type: string maxLength: 11 description: CPF do trabalhador. registrationNumber: type: string maxLength: 30 description: Número de matricula originReceiptNumber: type: string maxLength: 100 description: Número de recibo do layout que será excluído. receiptNumber: type: string maxLength: 100 description: Número do recibo. eventType: type: string allOf: – #/definitions/eventS3000Type description: Tipo do evento. jsonText: type: object allOf: – #/definitions/eSocialS3000 description: Dados completo do layout em JSON. tpInsc: type: string allOf: – #/definitions/subscriptionType description: Código correspondente ao tipo de inscrição. providerXml: type: object allOf: – #/definitions/providerXml description: Xml recebido do prestador. batch: type: integer format: int64 description: Lote de importação que originou o evento providerXml: description: Xml recebido do prestador. type: object required: – xml – xmlStatus – providerStatusType – receiptDate properties: id: type: string format: uuid description: Id da entidade. xml: type: string description: Xml string xmlStatus: type: string allOf: – #/definitions/xmlStatusType description: Status do xml providerStatusType: type: string allOf: – #/definitions/providerStatusType description: Situação do consumo do status do XML pelo prestador SST. layoutSituation: type: object allOf: – #/definitions/layoutSituation description: Situação de layout do eSocial. stackTrace: type: string description: Stacktrace. message: type: string description: Mensagem. idEvento: type: string description: Id do evento. layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de layout. receiptDate: type: string format: date-time description: Data de recebimento. providerCompanyId: type: string description: Id da empresa no prestador SST. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição. subscriptionNumber: type: string description: Numero de incrição. providerXmlId: type: string description: Id do xml do prestador providerErrorMessage: type: string description: Relatório de erro ocorrido no provedor. batch: type: integer format: int64 description: Lote de importação que originou o evento layoutSourceType: type: string allOf: – #/definitions/layoutSourceType description: Origem do layout. generalConfiguration: description: Configurações gerais type: object required: – edocsConfigurationModeType properties: id: type: string format: uuid description: Id interno da entidade. configurationMode: type: string allOf: – #/definitions/configurationMode description: Modo de cofiguração edocsConfigurationModeType: type: string allOf: – #/definitions/edocsConfigurationModeType description: Modo de configuração do envio de informações ao eDocs 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