HCM – Foundation General (general)

2.0info: 6.1.2 HCM – Foundation General description: HCM – Foundation General x-senior-domain: HCM – Foundation x-senior-domain-path: hcm_foundation x-senior-service-path: general contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_foundationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/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 /general/queries/listCollectiveNegotiationBySyndicate: post: description: Lista os campos de listagem das negociações coletivas e as datas do histórico atual pelo ID d sindicato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – syndicateId – offset – size properties: syndicateId: type: string description: Id do sindicato offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho da página sort: type: array items: type: object allOf: – #/definitions/ordination description: Campos de ordenação (code | name | lastModifiedDate) responses: 200: description: Ok schema: type: object required: – collectiveNegotiations – totalElements properties: collectiveNegotiations: type: array items: type: object allOf: – #/definitions/collectiveNegotiationForListDTO minimum: 1 description: Negociações coletivas com as datas iniciais e final do histórico atual totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/collectiveNegotiationHistoryLookup: post: description: Primitiva para a consulta de dados dos históricos de negociações coletivas (collectiveNegotiationHistory) utilizados em campos lookup das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para a consulta de dados dos históricos de negociações coletivas (collectiveNegotiationHistory) utilizados em campos lookup das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getValidBusinessDay: post: description: Retorna o dia útil válido mais próximo com base na data informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branch – referenceDate – direction properties: branch: type: string description: Id da filial para avaliar referenceDate: type: string format: date description: Data de referência direction: type: string allOf: – #/definitions/searchDirectionType description: Direção de busca das datas responses: 200: description: Ok schema: type: object required: – resultDate properties: resultDate: type: string format: date description: Dia útil mais próximo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o dia útil válido mais próximo com base na data informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: branch description: Id da filial para avaliar in: query required: true type: string – name: referenceDate description: Data de referência in: query required: true type: string format: date – name: direction description: Direção de busca das datas in: query required: true type: string allOf: – #/definitions/searchDirectionType responses: 200: description: Ok schema: type: object required: – resultDate properties: resultDate: type: string format: date description: Dia útil mais próximo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getCompanyStructures: post: description: Busca os identificadores únicos de todas as estruturas históricas de uma empresa com base numa data de referencia. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyIds – referenceDate properties: companyIds: type: array items: type: string minimum: 1 description: Identificadores únicos das empresas referenceDate: type: string format: date description: Data de referência para a busca structureTypes: type: array items: type: string allOf: – #/definitions/structureType description: Estruturas que serão trazidas. Caso nada seja informado, todas elas serão pesquisadas. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyStructuresItem minimum: 1 description: Lista de estruturas das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportJobPositionStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportJobPosition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportAnnotationType: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationship: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportESocialReason: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSyndicate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportHolidayGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportHoliday: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportJobPositionStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCompanyBranchIndications: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationshipStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmploymentRelationshipStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiationHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiationHistoryAttachment: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCollectiveNegotiationHistoryNightHoursExtension: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportLocation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportLocationStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportLocationStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSyndicateStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituationStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportAnnotationTypeStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSyndicateStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportSituationStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportAnnotationTypeStructureCompanyHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCbo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCountry: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportState: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportCity: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportESocialCategory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportExclusionProcess: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportExclusionProcessStepGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportExclusionProcessStep: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/duplicateCollectiveNegotiationHistory: post: description: Duplicar o histórico de negociação coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – oldCollectiveNegotiationHistoryId – collectiveNegotiationHistoryDTO properties: oldCollectiveNegotiationHistoryId: type: string description: Id do histórico de negociação coletiva de origem collectiveNegotiationHistoryDTO: type: object allOf: – #/definitions/collectiveNegotiationHistoryDTO description: DTO do histórico de negociação coletiva responses: 200: description: Ok schema: type: object required: – collectiveNegotiationHistoryId properties: collectiveNegotiationHistoryId: type: string description: Id do histórico de negociação coletiva duplicado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/createNationalHolidays: post: description: Criar os feriados nacionais tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – yearCompetence – holidayGroupId properties: yearCompetence: type: integer format: int64 description: Ano de competência holidayGroupId: type: string description: Tabela de feriados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateEmploymentRelationships: post: description: Salva em lote os vínculos empregatícios derivado de uma lista de tipos de contratos e códigos de categorias do eSocial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/partialEmploymentRelationship minimum: 1 description: Lista de vínculos para serem atualizados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/syndicateWithDefaultCollectiveNegotiationSave: post: description: Cria um sindicato com a negociação coletiva padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code – name – collectiveNegotiation – syndicateStructure properties: id: type: string description: Identificador único do sindicato code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string description: Razão social do sindicato collectiveNegotiation: type: object allOf: – #/definitions/defaultCollectiveNegotiationDto description: negociação coletiva syndicateStructure: type: object allOf: – #/definitions/genericIdDTO description: Estrutura de sindicato externalId: type: string maxLength: 255 description: Identificador externo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/syndicateWithDefaultCollectiveNegotiationDelete: post: description: Deleta um sindicato, a negociação coletiva padrão associada a ele e o histórico de negociação coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: externalId: type: string maxLength: 255 description: Identificador externo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/activateLicenses: post: description: Ativa as licenças de um tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string maxLength: 255 description: Tenant que terá os recursos liberados isIntegrated: type: boolean description: Flag indicando se o tenant irá possuir a rotina de integração ativa default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/actions/importJobPositionStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importJobPosition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importAnnotationType: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationship: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importESocialReason: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSyndicate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importHolidayGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importHoliday: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importJobPositionStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCompanyBranchIndications: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationshipStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEmploymentRelationshipStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiationHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiationHistoryAttachment: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCollectiveNegotiationHistoryNightHoursExtension: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importLocation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importLocationStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importLocationStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSyndicateStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituationStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importAnnotationTypeStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSyndicateStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importSituationStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importAnnotationTypeStructureCompanyHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCbo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCountry: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importState: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importCity: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importESocialCategory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importExclusionProcess: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importExclusionProcessStepGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importExclusionProcessStep: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/signals/startExclusionProcess: post: description: Inicia um processo de exclusão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pid properties: pid: type: string description: Id do Processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/exclusionProcessStatusChanged: post: description: Evento responsável por informar mudança no status do processo de exclusão x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pid – entityName – recordId – description – status properties: pid: type: string description: Identificador do process de exclusão entityName: type: string description: Nome da entidade recordId: type: string description: Identificador do registro description: type: string description: Descrição do registro status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importJobPositionStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportJobPositionStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importAnnotationTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportAnnotationTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importESocialReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportESocialReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSyndicateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSyndicateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importHolidayGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportHolidayGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importHolidayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportHolidayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importJobPositionStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportJobPositionStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCompanyBranchIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCompanyBranchIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEmploymentRelationshipStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmploymentRelationshipStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationHistoryAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationHistoryAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCollectiveNegotiationHistoryNightHoursExtensionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCollectiveNegotiationHistoryNightHoursExtensionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importLocationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportLocationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importLocationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportLocationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importLocationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportLocationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSyndicateStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSyndicateStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importAnnotationTypeStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportAnnotationTypeStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSyndicateStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSyndicateStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importSituationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSituationStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importAnnotationTypeStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportAnnotationTypeStructureCompanyHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCboEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCboEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importStateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportStateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importCityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportCityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importESocialCategoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportESocialCategoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importExclusionProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportExclusionProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importExclusionProcessStepGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportExclusionProcessStepGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importExclusionProcessStepEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportExclusionProcessStepEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPositionStructure responses: 200: description: The created resource schema: #/definitions/jobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPositionStructure responses: 200: description: The created resource schema: #/definitions/jobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editJobPositionStructure responses: 200: description: Ok schema: #/definitions/editJobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPositionStructure responses: 200: description: Ok schema: #/definitions/jobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPositionStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobPositionStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPosition: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPosition/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editJobPosition responses: 200: description: Ok schema: #/definitions/editJobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPosition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobPosition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationType: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationType responses: 200: description: The created resource schema: #/definitions/annotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationType responses: 200: description: The created resource schema: #/definitions/annotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/annotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationType/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnnotationType responses: 200: description: Ok schema: #/definitions/editAnnotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/annotationType responses: 200: description: Ok schema: #/definitions/annotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/annotationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/annotationType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situation responses: 200: description: The created resource schema: #/definitions/situation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situation responses: 200: description: The created resource schema: #/definitions/situation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/situation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSituation responses: 200: description: Ok schema: #/definitions/editSituation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/situation responses: 200: description: Ok schema: #/definitions/situation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/situation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/situation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationship: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationship responses: 200: description: The created resource schema: #/definitions/employmentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationship responses: 200: description: The created resource schema: #/definitions/employmentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employmentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationship/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmploymentRelationship responses: 200: description: Ok schema: #/definitions/editEmploymentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employmentRelationship responses: 200: description: Ok schema: #/definitions/employmentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employmentRelationship 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationship/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employmentRelationship responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialReason: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialReason responses: 200: description: The created resource schema: #/definitions/eSocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialReason responses: 200: description: The created resource schema: #/definitions/eSocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eSocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialReason/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editESocialReason responses: 200: description: Ok schema: #/definitions/editESocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eSocialReason responses: 200: description: Ok schema: #/definitions/eSocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eSocialReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialReason/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicate responses: 200: description: The created resource schema: #/definitions/syndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicate responses: 200: description: The created resource schema: #/definitions/syndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/syndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSyndicate responses: 200: description: Ok schema: #/definitions/editSyndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/syndicate responses: 200: description: Ok schema: #/definitions/syndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/syndicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/syndicate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holidayGroup: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holidayGroup responses: 200: description: The created resource schema: #/definitions/holidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holidayGroup responses: 200: description: The created resource schema: #/definitions/holidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/holidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holidayGroup/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHolidayGroup responses: 200: description: Ok schema: #/definitions/editHolidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holidayGroup responses: 200: description: Ok schema: #/definitions/holidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/holidayGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holidayGroup/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/holidayGroup responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holiday: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holiday/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHoliday responses: 200: description: Ok schema: #/definitions/editHoliday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: Ok schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/holiday/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/holiday responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPositionStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/jobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPositionStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/jobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editJobPositionStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editJobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPositionStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/jobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPositionStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/jobPositionStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobPositionStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/companyBranchIndications: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranchIndications responses: 200: description: The created resource schema: #/definitions/companyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranchIndications responses: 200: description: The created resource schema: #/definitions/companyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/companyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/companyBranchIndications/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCompanyBranchIndications responses: 200: description: Ok schema: #/definitions/editCompanyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyBranchIndications responses: 200: description: Ok schema: #/definitions/companyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyBranchIndications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/companyBranchIndications/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyBranchIndications responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationshipStructure responses: 200: description: The created resource schema: #/definitions/employmentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationshipStructure responses: 200: description: The created resource schema: #/definitions/employmentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employmentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmploymentRelationshipStructure responses: 200: description: Ok schema: #/definitions/editEmploymentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employmentRelationshipStructure responses: 200: description: Ok schema: #/definitions/employmentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employmentRelationshipStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employmentRelationshipStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationshipStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/employmentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employmentRelationshipStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/employmentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employmentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmploymentRelationshipStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editEmploymentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employmentRelationshipStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/employmentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employmentRelationshipStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employmentRelationshipStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employmentRelationshipStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiation responses: 200: description: The created resource schema: #/definitions/collectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiation responses: 200: description: The created resource schema: #/definitions/collectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCollectiveNegotiation responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiation responses: 200: description: Ok schema: #/definitions/collectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/collectiveNegotiation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistory responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistory responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCollectiveNegotiationHistory responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiationHistory responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/collectiveNegotiationHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistoryAttachment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistoryAttachment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCollectiveNegotiationHistoryAttachment responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/{parentId}/collectiveNegotiationHistoryAttachment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/{parentId}/collectiveNegotiationHistoryAttachment/{id}: put: description: Esta entidade pode ser customizada. 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/editCollectiveNegotiationHistoryAttachment responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: 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 /general/entities/collectiveNegotiationHistoryAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/collectiveNegotiationHistoryAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistoryNightHoursExtension: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistoryNightHoursExtension/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCollectiveNegotiationHistoryNightHoursExtension responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/{parentId}/collectiveNegotiationHistoryNightHoursExtension: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: The created resource schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/collectiveNegotiationHistory/{parentId}/collectiveNegotiationHistoryNightHoursExtension/{id}: put: description: Esta entidade pode ser customizada. 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/editCollectiveNegotiationHistoryNightHoursExtension responses: 200: description: Ok schema: #/definitions/editCollectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectiveNegotiationHistoryNightHoursExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: 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 /general/entities/collectiveNegotiationHistoryNightHoursExtension/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/collectiveNegotiationHistoryNightHoursExtension responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/location: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/location responses: 200: description: The created resource schema: #/definitions/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/location responses: 200: description: The created resource schema: #/definitions/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/location/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLocation responses: 200: description: Ok schema: #/definitions/editLocation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/location responses: 200: description: Ok schema: #/definitions/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/location/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/location responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/locationStructure responses: 200: description: The created resource schema: #/definitions/locationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/locationStructure responses: 200: description: The created resource schema: #/definitions/locationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/locationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLocationStructure responses: 200: description: Ok schema: #/definitions/editLocationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/locationStructure responses: 200: description: Ok schema: #/definitions/locationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/locationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/locationStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/locationStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/locationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/locationStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/locationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/locationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLocationStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editLocationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/locationStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/locationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/locationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/locationStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/locationStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicateStructure responses: 200: description: The created resource schema: #/definitions/syndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicateStructure responses: 200: description: The created resource schema: #/definitions/syndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/syndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSyndicateStructure responses: 200: description: Ok schema: #/definitions/editSyndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/syndicateStructure responses: 200: description: Ok schema: #/definitions/syndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/syndicateStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/syndicateStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situationStructure responses: 200: description: The created resource schema: #/definitions/situationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situationStructure responses: 200: description: The created resource schema: #/definitions/situationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/situationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSituationStructure responses: 200: description: Ok schema: #/definitions/editSituationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/situationStructure responses: 200: description: Ok schema: #/definitions/situationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/situationStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/situationStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationTypeStructure responses: 200: description: The created resource schema: #/definitions/annotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationTypeStructure responses: 200: description: The created resource schema: #/definitions/annotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/annotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnnotationTypeStructure responses: 200: description: Ok schema: #/definitions/editAnnotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/annotationTypeStructure responses: 200: description: Ok schema: #/definitions/annotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/annotationTypeStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/annotationTypeStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicateStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/syndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/syndicateStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/syndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/syndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSyndicateStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editSyndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/syndicateStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/syndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/syndicateStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/syndicateStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/syndicateStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situationStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/situationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situationStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/situationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/situationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSituationStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editSituationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/situationStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/situationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/situationStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/situationStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/situationStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationTypeStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/annotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationTypeStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/annotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/annotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnnotationTypeStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editAnnotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/annotationTypeStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/annotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/annotationTypeStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/annotationTypeStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/annotationTypeStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/country: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/country/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/state: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/state/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/city: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/city/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcess: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcessStepGroup: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcess/{parentId}/groups: post: 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/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcess/{parentId}/groups/{id}: put: 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/editExclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/editExclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/exclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /general/entities/exclusionProcessStep: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcessStepGroup/{parentId}/steps: post: 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/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/exclusionProcessStepGroup/{parentId}/steps/{id}: put: 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/editExclusionProcessStep responses: 200: description: Ok schema: #/definitions/editExclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/exclusionProcessStep responses: 200: description: Ok schema: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 definitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim annotationFinalityType: type: string enum: – SUCCESSION – SALARY_DESCRIPTION_START – SALARY_DESCRIPTION_END – DEFICIENCY – WORK_CONTRACT_OBSERVATIONS – ELECTRICAL_INSTALLATIONS_WORK_AUTHORIZATION – INTERVENTIONS_ON_MACHINE – CRANE_EQUIPMENT_OPERATOR – TRAINING – WORK_SCHEDULE_ART_62_INC_1_START – WORK_SCHEDULE_ART_62_INC_1_END – WORK_SCHEDULE_ART_62_INC_2_START – WORK_SCHEDULE_ART_62_INC_2_END – WORK_SCHEDULE_ART_62_INC_3_START – WORK_SCHEDULE_ART_62_INC_3_END – CNPJ_TRANSFER – OTHERS description: Finalidade anotação: * `SUCCESSION` – Sucessão * `SALARY_DESCRIPTION_START` – Descrição de salário: início * `SALARY_DESCRIPTION_END` – Descrição de salário: fim * `DEFICIENCY` – Deficiência * `WORK_CONTRACT_OBSERVATIONS` – Observações do contrato de trabalho * `ELECTRICAL_INSTALLATIONS_WORK_AUTHORIZATION` – Autorização para trabalhar em Instalações elétricas * `INTERVENTIONS_ON_MACHINE` – Operação e realização de intervenções em máquinas * `CRANE_EQUIPMENT_OPERATOR` – Operador do equipamento de guindar * `TRAINING` – Treinamento, Capacitação ou Exercício Simulado * `WORK_SCHEDULE_ART_62_INC_1_START` – Regime de Jornada: CLT Art 62 inciso 1 início * `WORK_SCHEDULE_ART_62_INC_1_END` – Regime de Jornada: CLT Art 62 inciso 1 fim * `WORK_SCHEDULE_ART_62_INC_2_START` – Regime de Jornada: CLT Art 62 inciso 2 início * `WORK_SCHEDULE_ART_62_INC_2_END` – Regime de Jornada: CLT Art 62 inciso 2 fim * `WORK_SCHEDULE_ART_62_INC_3_START` – Regime de Jornada: CLT Art 62 inciso 3 início * `WORK_SCHEDULE_ART_62_INC_3_END` – Regime de Jornada: CLT Art 62 inciso 3 fim * `CNPJ_TRANSFER` – Transferências entre CNPJs * `OTHERS` – Outros exclusionProcessStatus: type: string enum: – PENDING – PROCESSING – ERROR – SUCCESS description: Status do processo de exclusão: * `PENDING` – Pendente * `PROCESSING` – Processando * `ERROR` – Erro * `SUCCESS` – Sucesso eSocialReasonType: type: string enum: – V0 – V1 – V3 – V5 – V6 – V7 – V8 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V33 – V34 – V35 – V36 – V37 – V38 – V39 – V40 – V41 – V42 description: Motivo afastamento e-social: * `V0` – Não enviar * `V1` – Acidente/Doença do trabalho * `V3` – Acidente/Doença não relacionada ao trabalho * `V5` – Afastamento/licença de servidor público ou militar prevista em estatuto, sem remuneração * `V6` – Aposentadoria por invalidez * `V7` – Acompanhamento – Licença para acompanhamento de membro da família enfermo * `V8` – [Válido até 18/07/2021] Afastamento do empregado para participar de atividade do Conselho Curador do FGTS – art. 65, §6º, Dec. 99.684/90 (Regulamento do FGTS) * `V10` – Afastamento/licença prevista em regime próprio (estatuto), com remuneração * `V11` – Cárcere * `V12` – Cargo Eletivo – Candidato a cargo eletivo – Art. 25, parágrafo único, da Lei 7.664/1988 – Celetistas em geral * `V13` – Cargo Eletivo – Candidato a cargo eletivo – Art. 1°, inciso II, alínea “l” da Lei Complementar 64/1990 – Servidor público, estatutário ou não, dos órgãos ou entidades da Administração Direta ou Indireta da União, dos Estados, do Distrito Federal, dos Municípios e dos Territórios, inclusive das fundações mantidas pelo Poder Público. * `V14` – [Válido até 09/03/2022] Cessão/Requisição * `V15` – Gozo de férias ou recesso – Afastamento temporário para o gozo de férias ou recesso * `V16` – Licença remunerada – Lei, liberalidade da empresa ou Acordo/Convenção Coletiva de Trabalho * `V17` – Licença Maternidade * `V18` – Licença maternidade – Prorrogação por 60 dias, Lei 11.770/2008 (Empresa Cidadã), inclusive para o cônjuge sobrevivente * `V19` – Licença Maternidade – Afastamento temporário por motivo de aborto não criminoso * `V20` – Licença maternidade – Afastamento temporário por motivo de licença-maternidade para o cônjuge sobrevivente ou decorrente de adoção ou de guarda judicial de criança * `V21` – Licença não remunerada ou Sem Vencimento * `V22` – Mandato eleitoral – Afastamento temporário para o exercício de mandato eleitoral * `V23` – [Válido até 18/07/2021] Mandato Eleitoral – Afastamento temporário para o exercício de mandato eleitoral, com remuneração * `V24` – Mandato Sindical – Afastamento temporário para exercício de mandato sindical * `V25` – Mulher vítima de violência – Art. 9º, § 2º, inciso II, da Lei 11.340/2006 – Lei Maria da Penha * `V26` – Participação de empregado no Conselho Nacional de Previdência Social – CNPS – Art. 3º da Lei 8.213/1991 * `V27` – Qualificação – Afastamento por suspensão do contrato de acordo com o art 476-A da CLT * `V28` – Representante Sindical – Afastamento pelo tempo que se fizer necessário, quando, na qualidade de representante de entidade sindical, estiver participando de reunião oficial de organismo internacional do qual o Brasil seja membro * `V29` – Serviço Militar – Afastamento temporário para prestar serviço militar obrigatório * `V30` – [Válido até 18/07/2021] Suspensão disciplinar – Art. 474 da CLT * `V31` – Servidor público em disponibilidade * `V33` – [Válido até 18/07/2021] Licença maternidade – 180 dias, Lei 13.301/2016 * `V34` – Inatividade do trabalhador avulso (portuário ou não portuário) por período superior a 90 dias * `V35` – Licença maternidade – Antecipação e/ou prorrogação mediante atestado médico * `V36` – Afastamento temporário de exercente de mandato eletivo para cargo em comissão * `V37` – [Válido até 25/08/2021] Suspensão temporária do contrato de trabalho nos termos do Programa Emergencial de Manutenção do Emprego e da Renda * `V38` – Impedimento de concorrência à escala para trabalho avulso * `V39` – Suspensão de pagamento de servidor público por não recadastramento * `V40` – Exercício em outro órgão de servidor ou empregado público cedido * `V41` – Qualificação – Afastamento por suspensão do contrato de acordo com o art. 15 da Lei 14.457/2022 * `V42` – Qualificação – Afastamento por suspensão do contrato de acordo com o art. 17 da Lei 14.457/2022 situationType: type: string enum: – WORKING – VACATION – ILLNESSAID – LABORACCIDENT – MILITARYSERVICE – MATERNITYLEAVE – MATERNITYLEAVENONCRIMINALABORTION – MATERNITYLEAVEANTICIPATIONEXTENSION – CITIZENCOMPANYMATERNITY – INSSMATERNITYLEAVE – LEAVEWITHOUTCOMPENSATION – PAIDLEAVE – PATERNITYLEAVE – CITIZENCOMPANYPATERNITY – COLLECTIVEVACATION – MEDICALLEAVE – MEDICALLEAVEWITHOUTINSS – ABSENCES – OVERTIME – TIMEEVALUATIONSITUATION – PRECAUTIONREADINESS – TRADEUNIONMANDATE – WORKACCIDENTLEAVE – WORKACCIDENTLEAVEWITHOUTINSS – RETIREMENTDUETODISABILITY – PROFESSIONALQUALIFICATION – PRIORNOTICEHOURSWORKED – OTHERS – REINSTATEMENT description: Tipo da situação: * `WORKING` – Trabalhando * `VACATION` – Férias * `ILLNESSAID` – Auxílio doença * `LABORACCIDENT` – Acidente de trabalho * `MILITARYSERVICE` – Serviço militar * `MATERNITYLEAVE` – Licença maternidade * `MATERNITYLEAVENONCRIMINALABORTION` – Licença maternidade – Aborto não criminoso * `MATERNITYLEAVEANTICIPATIONEXTENSION` – Licença maternidade – Prorrogação mediante atestado médico * `CITIZENCOMPANYMATERNITY` – Licença maternidade – Empresa cidadã * `INSSMATERNITYLEAVE` – Licença maternidade INSS * `LEAVEWITHOUTCOMPENSATION` – Licença sem remuneração * `PAIDLEAVE` – Licença remunerada * `PATERNITYLEAVE` – Licença paternidade * `CITIZENCOMPANYPATERNITY` – Licença paternidade – Empresa cidadã * `COLLECTIVEVACATION` – Férias coletivas * `MEDICALLEAVE` – Licença médica (pgto Empresa) * `MEDICALLEAVEWITHOUTINSS` – Licença médica sem incidência INSS * `ABSENCES` – Faltas * `OVERTIME` – Horas extras * `TIMEEVALUATIONSITUATION` – Situação de apuração ponto * `PRECAUTIONREADINESS` – Sobreaviso/Prontidão * `TRADEUNIONMANDATE` – Mandato sindical * `WORKACCIDENTLEAVE` – Licença acidente de trabalho (pgto Empresa) * `WORKACCIDENTLEAVEWITHOUTINSS` – Licença acidente de trabalho sem incidência INSS * `RETIREMENTDUETODISABILITY` – Aposentadoria por invalidez * `PROFESSIONALQUALIFICATION` – Qualificação profissional * `PRIORNOTICEHOURSWORKED` – Aviso prévio trabalhado * `OTHERS` – Outros * `REINSTATEMENT` – Contrato temporariamente suspenso – Reintegração contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro directionType: type: string enum: – ASC – DESC description: Tipo de ordenação: * `ASC` – Ascendente * `DESC` – Descendente searchDirectionType: type: string enum: – BEFORE – AFTER description: Tipo de direção de busca: * `BEFORE` – Antes * `AFTER` – Depois structureType: type: string enum: – JOB_POSITION_STRUCTURE – LOCATION_STRUCTURE – SYNDICATE_STRUCTURE – SITUATION_STRUCTURE – ANNOTATION_TYPE_STRUCTURE – EMPLOYMENT_RELATIONSHIP_STRUCTURE description: Tipo de estrutura: * `JOB_POSITION_STRUCTURE` – Estrutura de cargos * `LOCATION_STRUCTURE` – Estrutura de locais * `SYNDICATE_STRUCTURE` – Estrutura de sindicatos * `SITUATION_STRUCTURE` – Estrutura de situações * `ANNOTATION_TYPE_STRUCTURE` – Estrutura de tipos de anotação * `EMPLOYMENT_RELATIONSHIP_STRUCTURE` – Estrutura de vínculos userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: 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 collectiveNegotiationForListDTO: description: DTO para a listagem de negociações coletivas com as datas do histórico atual type: object required: – id – code – name – startDate properties: id: type: string description: ID da negociação coletiva code: type: integer format: int64 description: Código da negociação coletiva name: type: string description: Nome da negociação coletiva startDate: type: string format: date description: Data inicial do histórico atual endDate: type: string format: date description: Data final do histórico atual ordination: description: Definição de ordenação type: object required: – field properties: field: type: string description: Campo da ordenação direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação collectiveNegotiationHistoryDTO: description: DTO do histórico de negociação coletiva type: object required: – collectiveNegotiation – startDate – startNightHours – endNightHours properties: id: type: string description: Identificador único do histórico de negocição coletiva collectiveNegotiation: type: string description: Id da negociação coletiva startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final startNightHours: type: integer format: int64 description: Início horas noturnas endNightHours: type: integer format: int64 description: Fim horas noturnas observation: type: string description: Observação collectiveNegotiationHistoryClockingEventDTO: description: DTO do histórico de negociação coletiva do ponto type: object properties: id: type: string description: Identificador único situationDefinitionId: type: string description: Definição de situações minimumBreakForWorkingTimeBetween4And6Hours: type: integer format: int64 description: Intervalo mínimo para jornada entre 4 e 6 horas minimumBreakForWorkingTimeOver6Hours: type: integer format: int64 description: Intervalo mínimo para jornada acima de 6 horas minimumWorkForWorkingTimeOver6Hours: type: integer format: int64 description: Mínimo trabalho para jornada acima de 6 horas saveCollectiveNegotiationHistoryDTO: description: Input para salvar e atualizar a negocição coletiva type: object required: – collectiveNegotiationHistoryDTO properties: collectiveNegotiationHistoryDTO: type: object allOf: – #/definitions/collectiveNegotiationHistoryDTO description: DTO do histórico de negociação coletiva collectiveNegotiationHistoryClockingEventDTO: type: object allOf: – #/definitions/collectiveNegotiationHistoryClockingEventDTO description: DTO do histórico de negociação coletiva do ponto lookupItem: description: Resultado de consulta de lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro partialEmploymentRelationship: description: Vínculo empregatício parcial type: object required: – code – name properties: code: type: integer format: int64 description: Código do qual os vínculos serão derivados name: type: array items: type: object allOf: – #/definitions/keyValuePair minimum: 1 description: Chave/valor com a localização e o nome do qual os vínculos serão derivados data: type: array items: type: object allOf: – #/definitions/contractTypeAndESocialCategoryCode description: Lista de tipos de contratos e categorias do eSocial únicos keyValuePair: description: Chave/valor type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor contractTypeAndESocialCategoryCode: description: Tipo de contrato e categoria do eSocial type: object required: – contractType properties: contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato eSocialCategoryCode: type: integer format: int64 description: Código da categoria do eSocial externalId: type: string maxLength: 255 description: Identificador externo defaultCollectiveNegotiationDto: description: DTO da negociação coletiva padrão type: object required: – startNightHours – endNightHours properties: startNightHours: type: integer format: int64 description: Início horas noturnas endNightHours: type: integer format: int64 description: Fim horas noturnas genericIdDTO: description: DTO para duplicação de históricos. type: object required: – id properties: id: type: string maxLength: 36 description: Identificador companyStructuresItem: description: Estruturas da empresa type: object required: – companyId – structures properties: companyId: type: string description: Identificador único da empresa structures: type: array items: type: object allOf: – #/definitions/structureItem minimum: 1 description: Estruturas structureItem: description: Estrutura type: object required: – structureType – structureId properties: structureType: type: string allOf: – #/definitions/structureType description: Tipo da estrutura structureId: type: string description: Identificador único da estrutura jobPositionStructure: description: Estrutura de cargos type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string description: Descrição x-i18n: true externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editJobPositionStructure: type: object required: – id allOf: – #/definitions/jobPositionStructure jobPosition: description: Cargo type: object required: – shortName – jobPositionStructure properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 999999999 name: type: string maxLength: 100 description: Descrição x-i18n: true shortName: type: string maxLength: 30 description: Descrição reduzida x-i18n: true jobPositionStructure: type: object allOf: – #/definitions/jobPositionStructure description: Estrutura de cargos cbo: type: object allOf: – #/definitions/cbo description: CBO initialValidity: type: string format: date description: Validade inicial finalValidity: type: string format: date description: Validade final deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 100 shortName: type: string maxLength: 30 example: pt-BR: name: Exemplo de texto usando locale pt-BR.shortName: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale.shortName: Text example using en-US locale. editJobPosition: type: object required: – id allOf: – #/definitions/jobPosition annotationType: description: Tipo de anotação type: object required: – code – name – annotationTypeStructure properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 999 name: type: string description: Descrição x-i18n: true finality: type: string allOf: – #/definitions/annotationFinalityType description: Finalidade annotationTypeStructure: type: object allOf: – #/definitions/annotationTypeStructure description: Estrutura de tipo de anotação showInAdmissionCard: type: boolean description: Mostrar na ficha de registro default: false deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editAnnotationType: type: object required: – id allOf: – #/definitions/annotationType situation: description: Situação type: object required: – code – name – situationType – situationStructure properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 999 name: type: string description: Nome x-i18n: true situationType: type: string allOf: – #/definitions/situationType description: Tipo da situação justifiedDaySituation: type: object allOf: – #/definitions/situation description: Situação dias justificados situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editSituation: type: object required: – id allOf: – #/definitions/situation employmentRelationship: description: Vínculo empregatício type: object required: – code – name – contractType – employmentRelationshipStructure properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome x-i18n: true contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato employmentRelationshipStructure: type: object allOf: – #/definitions/employmentRelationshipStructure description: Estrutura de vínculo empregatício eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do eSocial deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editEmploymentRelationship: type: object required: – id allOf: – #/definitions/employmentRelationship eSocialReason: description: Motivo e-social type: object required: – situation – competence – eSocialReasonType – sendEsocialObservation properties: id: type: string format: uuid description: Identificador único situation: type: object allOf: – #/definitions/situation description: Situação competence: type: string format: date description: Competência eSocialReasonType: type: string allOf: – #/definitions/eSocialReasonType description: Motivo de afastamento e-social sendEsocialObservation: type: boolean description: Se envia observação para o e-social deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialReason: type: object required: – id allOf: – #/definitions/eSocialReason syndicate: description: Sindicato type: object required: – code – syndicateStructure properties: id: type: string format: uuid description: Identificador code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string description: Razão social do sindicato abbreviation: type: string maxLength: 20 description: Sigla cnpj: type: string maxLength: 14 description: CNPJ entityCode: type: string maxLength: 20 description: Código da entidade postalCode: type: string maxLength: 20 description: CEP city: type: object allOf: – #/definitions/city description: Cidade neighborhood: type: string maxLength: 75 description: Bairro adress: type: string description: Logradouro adressNumber: type: string maxLength: 60 description: Número adressComplement: type: string description: Complemento localCode: type: string maxLength: 6 description: DDD Telefone phone: type: string maxLength: 20 description: Telefone email: type: string maxLength: 100 description: Email site: type: string description: Site employerUnion: type: string description: Sindicato Patronal da CCT cnpjEmployerUnion: type: string description: CNPJ Sindicato Patronal da CCT syndicateStructure: type: object allOf: – #/definitions/syndicateStructure description: Estrutura de sindicato deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSyndicate: type: object required: – id allOf: – #/definitions/syndicate holidayGroup: description: Tabela de feriados type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string description: Nome deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editHolidayGroup: type: object required: – id allOf: – #/definitions/holidayGroup holiday: description: Feriado type: object required: – name – holidayDate – holidayGroup properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome x-i18n: true holidayDate: type: string format: date description: Data do feriado yearCompetence: type: integer format: int64 description: Ano de competência holidayGroup: type: object allOf: – #/definitions/holidayGroup description: Tabela de feriados deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editHoliday: type: object required: – id allOf: – #/definitions/holiday jobPositionStructureCompanyHistory: description: Histórico de estrutura de cargos da empresa type: object required: – company – jobPositionStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa jobPositionStructure: type: object allOf: – #/definitions/jobPositionStructure description: Estrutura de cargos startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editJobPositionStructureCompanyHistory: type: object required: – id allOf: – #/definitions/jobPositionStructureCompanyHistory companyBranchIndications: description: Assinalamentos da filial type: object required: – nightlyHolidayGroup – daytimeHolidayGroup properties: id: type: string format: uuid description: Identificador único nightlyHolidayGroup: type: object allOf: – #/definitions/holidayGroup description: Tabela de feriados noturna daytimeHolidayGroup: type: object allOf: – #/definitions/holidayGroup description: Tablea de feriados diurna companyBranch: type: object allOf: – #/definitions/e070fil description: Filial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCompanyBranchIndications: type: object required: – id allOf: – #/definitions/companyBranchIndications employmentRelationshipStructure: description: Estrutura do vínculo empregatício type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Descrição x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editEmploymentRelationshipStructure: type: object required: – id allOf: – #/definitions/employmentRelationshipStructure employmentRelationshipStructureCompanyHistory: description: Histórico de estrutura de vínculo da empresa type: object required: – company – employmentRelationshipStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa employmentRelationshipStructure: type: object allOf: – #/definitions/employmentRelationshipStructure description: Estrutura do vínculo empregatício startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmploymentRelationshipStructureCompanyHistory: type: object required: – id allOf: – #/definitions/employmentRelationshipStructureCompanyHistory collectiveNegotiation: description: Negociação coletiva type: object required: – syndicate – code – name properties: id: type: string format: uuid description: Identificador único syndicate: type: object allOf: – #/definitions/syndicate description: Sindicato code: type: integer format: int64 description: Código minimum: 1 name: type: string description: Descrição deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCollectiveNegotiation: type: object required: – id allOf: – #/definitions/collectiveNegotiation collectiveNegotiationHistory: description: Histórico de negociação coletiva type: object required: – collectiveNegotiation – startDate – startNightHours – endNightHours properties: id: type: string format: uuid description: Identificador único collectiveNegotiation: type: object allOf: – #/definitions/collectiveNegotiation description: Negociação coletiva startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Date Final startNightHours: type: integer format: int64 description: Início horas noturnas minimum: 0 maximum: 1440 endNightHours: type: integer format: int64 description: Fim horas noturnas minimum: 0 maximum: 1440 observation: type: string maxLength: 999 description: Observação collectiveNegotiationHistoryAttachment: type: object allOf: – #/definitions/collectiveNegotiationHistoryAttachment description: Anexo do histórico de negociação coletiva collectiveNegotiationHistoryNightHoursExtension: type: object allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension description: Histórico de Negociação – Prorrogação Horas Noturnas deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCollectiveNegotiationHistory: type: object required: – id allOf: – #/definitions/collectiveNegotiationHistory collectiveNegotiationHistoryAttachment: description: Anexo do histórico de negociação coletiva type: object required: – name – idBlobService – locationURI – fileSize – version properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistory: type: object allOf: – #/definitions/collectiveNegotiationHistory description: Histórico de cadastro de sindicato name: type: string maxLength: 255 description: Nome idBlobService: type: string maxLength: 1000 description: Identificador único do BlobService locationURI: type: string maxLength: 255 description: Location URI fileSize: type: integer format: int64 description: Tamanho do arquivo type: string description: Versão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCollectiveNegotiationHistoryAttachment: type: object required: – id allOf: – #/definitions/collectiveNegotiationHistoryAttachment collectiveNegotiationHistoryNightHoursExtension: description: Histórico de Negociação – Prorrogação Horas Noturnas type: object required: – extensionNightHoursForOvertime – extensionNightHoursForWork – minimumNightHoursForExtension – overtimeOnJourneyStart – restPeriodToInterruptExtensionNightHours properties: id: type: string format: uuid description: Identificador único collectiveNegotiationHistory: type: object allOf: – #/definitions/collectiveNegotiationHistory description: Histórico do cadastro de sindicato extensionNightHoursForOvertime: type: boolean description: Prorrogação noturna para extras extensionNightHoursForWork: type: boolean description: Prorrogação noturna para trabalho minimumNightHoursForExtension: type: integer format: int64 description: Mínimo em noturno para prorrogação overtimeOnJourneyStart: type: boolean description: Extras no início da jornada restPeriodToInterruptExtensionNightHours: type: integer format: int64 description: Descanso para interromper prorrogação noturna deleted: type: boolean description: Indicativo de exclusão do registro default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCollectiveNegotiationHistoryNightHoursExtension: type: object required: – id allOf: – #/definitions/collectiveNegotiationHistoryNightHoursExtension location: description: Local type: object required: – code – name – locationStructure properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Nome x-i18n: true locationStructure: type: object allOf: – #/definitions/locationStructure description: Estrutura de locais initialValidity: type: string format: date description: Validade Inicial finalValidity: type: string format: date description: Validade Final deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editLocation: type: object required: – id allOf: – #/definitions/location locationStructure: description: Estrutura de Locais type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string maxLength: 255 description: Nome x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editLocationStructure: type: object required: – id allOf: – #/definitions/locationStructure locationStructureCompanyHistory: description: Histórico de estrutura de locais da empresa type: object required: – company – locationStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa locationStructure: type: object allOf: – #/definitions/locationStructure description: Estrutura de cargos startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLocationStructureCompanyHistory: type: object required: – id allOf: – #/definitions/locationStructureCompanyHistory syndicateStructure: description: Estrutura de sindicato type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Nome x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editSyndicateStructure: type: object required: – id allOf: – #/definitions/syndicateStructure situationStructure: description: Estrutura de situação type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Nome x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editSituationStructure: type: object required: – id allOf: – #/definitions/situationStructure annotationTypeStructure: description: Estrutura de tipo de anotação type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Nome x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editAnnotationTypeStructure: type: object required: – id allOf: – #/definitions/annotationTypeStructure syndicateStructureCompanyHistory: description: Histórico de estrutura de sindicato da empresa type: object required: – company – syndicateStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa syndicateStructure: type: object allOf: – #/definitions/syndicateStructure description: Estrutura de sindicato startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSyndicateStructureCompanyHistory: type: object required: – id allOf: – #/definitions/syndicateStructureCompanyHistory situationStructureCompanyHistory: description: Histórico de estrutura de situação da empresa type: object required: – company – situationStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSituationStructureCompanyHistory: type: object required: – id allOf: – #/definitions/situationStructureCompanyHistory annotationTypeStructureCompanyHistory: description: Histórico de estrutura de tipo de anotação da empresa type: object required: – company – annotationTypeStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa annotationTypeStructure: type: object allOf: – #/definitions/annotationTypeStructure description: Estrutura de tipo de anotação startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnnotationTypeStructureCompanyHistory: type: object required: – id allOf: – #/definitions/annotationTypeStructureCompanyHistory cbo: description: Cadastro da Classificação Brasileira de Ocupações(CBO) 2002 type: object required: – code – description properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string description: Descrição extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: country: description: País type: object required: – code – name properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Código name: type: string maxLength: 100 description: Nome x-i18n: true spedCode: type: integer format: int64 description: Código no SPED deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 100 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. state: description: Estado type: object required: – code – name properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Código name: type: string maxLength: 100 description: Nome abbreviation: type: string maxLength: 2 description: Sigla country: type: object allOf: – #/definitions/country description: País deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: city: description: Cidade type: object required: – code – name properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Código name: type: string description: Nome state: type: object allOf: – #/definitions/state description: Estado deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 100 description: Nome fantasia excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Sigla excluido: type: boolean description: Indica se o registro foi excluído default: false companyBranchIndications: type: object allOf: – #/definitions/companyBranchIndications description: Assinalamentos da filial extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eSocialCategory: description: Categorias eSocial type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string maxLength: 300 description: Descrição exclusionProcess: description: Processo de exclusão type: object required: – entityName – recordId – description – status properties: id: type: string format: uuid description: Identificador único entityName: type: string description: Nome da entidade recordId: type: string description: Identificador único do registro description: type: string description: Descrição status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim errorMessage: type: string description: Mensagem de erro groups: type: array items: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Grupos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: exclusionProcessStepGroup: description: Grupo de etapas do processo de exclusão type: object required: – description – status properties: id: type: string format: uuid description: Identificador único exclusionProcess: type: object allOf: – #/definitions/exclusionProcess description: Process de exclusão description: type: string description: Descrição status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status errorMessage: type: string description: Mensagem de erro errorDetail: type: string description: Datelhe do erro startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim steps: type: array items: type: object allOf: – #/definitions/exclusionProcessStep description: Passos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStepGroup: type: object required: – id allOf: – #/definitions/exclusionProcessStepGroup exclusionProcessStep: description: Etapa do processo de exclusão type: object required: – description – status properties: id: type: string format: uuid description: Identificador único stepGroup: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Grupo de etapas do processo de exclusão description: type: string description: Descrição status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim errorMessage: type: string description: Mensagem de erro errorDetail: type: string description: Datelhe do erro created_by: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStep: type: object required: – id allOf: – #/definitions/exclusionProcessStep notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage