Mais pesquisados:Customização, Tutorial, Documentação

esocial4integration

533 views 0 09/07/2019 Atualizado em 15/09/2025 integrador

2.0info: 6.0.0 esocial4integration description: Serviço do e-Social para integrações de terceiros. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: esocial4integration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /esocial4integration/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/enumInformation: post: description: Retorna os itens das enumerações traduzidos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nomes das enumerações. responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/activeFeature: post: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – feature properties: feature: type: string description: Feature que será consultada responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: feature description: Feature que será consultada in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationQuery: post: description: Retorna a lista de pendências com os filtros indicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: string description: Filtro pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de integrações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/branchQuery: post: description: Retorna a lista de filiais com os filtros indicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: string description: Filtro pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationBranch minimum: 1 description: As configurações de filial encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationToStringQuery: post: description: Retorna uma String com os principais dados de uma pendência concatenados para comparações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pagination properties: filter: type: object allOf: – #/definitions/pendencyFilters description: Filtro. pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Uma String contendo os dados da pendência de forma concatenada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationThirdSystemQuery: post: description: Retorna uma lista de pendências de integração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startScheduledDate – endScheduledDate – companyCode properties: startScheduledDate: type: string format: date description: Data inicial. endScheduledDate: type: string format: date description: Data final. companyCode: type: string description: Código da empresa. esocialRegistration: type: string description: Matricula do esocial. cpf: type: string maxLength: 11 description: Cpf. integrationReason: type: string allOf: – #/definitions/integrationType description: Motivo da integração. situation: type: string allOf: – #/definitions/statusType description: Situação. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de pendencia de integração. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de pendências de integração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startScheduledDate description: Data inicial. in: query required: true type: string format: date – name: endScheduledDate description: Data final. in: query required: true type: string format: date – name: companyCode description: Código da empresa. in: query required: true type: string – name: esocialRegistration description: Matricula do esocial. in: query type: string – name: cpf description: Cpf. in: query type: string maxLength: 11 – name: integrationReason description: Motivo da integração. in: query type: string allOf: – #/definitions/integrationType – name: situation description: Situação. in: query type: string allOf: – #/definitions/statusType responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de pendencia de integração. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationCountQuery: post: description: Retorna a quantidade total de registros que pertencem ao filtro informado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/pendencyFilters description: Filtro. responses: 200: description: Ok schema: type: object required: – result properties: result: type: integer format: int64 description: Número total de registros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/fetchWaitingRetrySchedulerCount: post: description: Retorna a quantidade de pendências com status igual a WAITING_RETRY_SCHEDULER presentes na base de dados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: integer format: int64 description: Número total de registros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de pendências com status igual a WAITING_RETRY_SCHEDULER presentes na base de dados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: integer format: int64 description: Número total de registros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/retrieveSentIntegrationsQuery: post: description: Retorna uma lista de pendências de integração. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: pagination: type: object allOf: – #/definitions/pagination description: Paginação dos registros. responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Integrações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationEmployeeChanges: post: description: Busca as mudanças entre a pendencia informada e a última pendência válida desse colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationId properties: integrationId: type: string description: Id da pendência responses: 200: description: Ok schema: type: object required: – changes properties: changes: type: string description: JSON com as mudanças entre a pendencia informada e a última pendência válida desse colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as mudanças entre a pendencia informada e a última pendência válida desse colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: integrationId description: Id da pendência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – changes properties: changes: type: string description: JSON com as mudanças entre a pendencia informada e a última pendência válida desse colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/configurationProviderToShowListQuery: post: description: Busca as informações necessárias para a tela de prestadores poder listar elas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationCompanyId properties: configurationCompanyId: type: string description: Id da entidade de configuração de empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationProviderSummary minimum: 1 description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações necessárias para a tela de prestadores poder listar elas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: configurationCompanyId description: Id da entidade de configuração de empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/configurationProviderSummary minimum: 1 description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/companyAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/companyBranchAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/employeeAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/autocompleteFilterCompany: post: description: Primitiva para obtenção de informações consumidas pelo campo de lookup 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/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações consumidas pelo campo de lookup 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/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/autocompleteFilterCompanyBranch: post: description: Primitiva para obtenção de informações consumidas pelo campo de lookup 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 parameters: type: array items: type: object allOf: – #/definitions/keyValue description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/subscriptionNumberAutoCompleteQuery: post: description: Busca os dados necessário para montar a lista do auto-complete de cpfs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessário para montar a lista do auto-complete de cpfs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/providerNameAutoCompleteQuery: post: description: Busca os dados necessários para montar a lista dos nomes dos prestadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchQuery properties: searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados necessários para montar a lista dos nomes dos prestadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchQuery description: Texto para pesquisa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationList: post: description: Faz a listagem filtrada de pendências de integração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro da consulta de pendências de integração size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultado default: 0 ordination: type: string description: Ordenação dos resultados displayFields: type: array items: type: string description: Campos retornados no resultado responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Pendências de integração encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationPendencyList: post: description: Faz a listagem filtrada de pendências de integração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/pendencyFilters description: Filtro da consulta de pendências de integração size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultado default: 0 ordination: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos resultados displayFields: type: array items: type: string description: Campos retornados no resultado responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Pendências de integração encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/existsThirdPartyIntegrationAndMissingPrimitive: post: description: Retorna uma flag indicando se houve integração com algum sistema de terceiro ativo e alguma primitiva não está configurada para um prestador ativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma flag indicando se houve integração com algum sistema de terceiro ativo e alguma primitiva não está configurada para um prestador ativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/integrationPendenciesIdsList: post: description: Faz a listagem filtrada de pendências de integração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/pendencyFilters description: Filtro da consulta de pendências de integração size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultado default: 0 ordination: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos resultados displayFields: type: array items: type: string description: Campos retornados no resultado responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: string minimum: 1 description: Pendências de integração encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/configurationProviderNameAndCodeChangeDetector: post: description: Verifica se existe alguma alteração no nome ou código do prestador nas suas configurações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationProviderId properties: configurationProviderId: type: string description: Id da configuração do prestador companyProviderIdentification: type: string description: Código de identificação da empresa no prestador SST. branchProviderList: type: array items: type: object allOf: – #/definitions/configurationBranchChangeDetector description: Filiais do prestador SST. providerName: type: string description: Nome da empresa no prestador SST. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno da consulta. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/providerEmployeeIdentificationQuery: post: description: Realiza a busca da identificação única do colaborador retornada pelo sistema do prestador SST tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: externalId: type: string maxLength: 36 description: Id do colaborador no Gestão de Departamento Pessoal (Payroll). companyCode: type: integer format: int64 description: Código da empresa. employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. employeeCode: type: integer format: int64 description: Código do colaborador. cpfNumber: type: string maxLength: 11 description: Número do CPF. responses: 200: description: Ok schema: type: object required: – providerEmployeeIdentification properties: providerEmployeeIdentification: type: string description: Identificação única do colaborador no sistema do prestador SST 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a busca da identificação única do colaborador retornada pelo sistema do prestador SST tags: – Queries x-senior-visibility: PRIVATE parameters: – name: externalId description: Id do colaborador no Gestão de Departamento Pessoal (Payroll). in: query type: string maxLength: 36 – name: companyCode description: Código da empresa. in: query type: integer format: int64 – name: employeeType description: Tipo do colaborador. in: query type: string allOf: – #/definitions/employeeType – name: employeeCode description: Código do colaborador. in: query type: integer format: int64 – name: cpfNumber description: Número do CPF. in: query type: string maxLength: 11 responses: 200: description: Ok schema: type: object required: – providerEmployeeIdentification properties: providerEmployeeIdentification: type: string description: Identificação única do colaborador no sistema do prestador SST 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/initialLoadProviderInProgress: post: description: Consulta para retornar boolean indicando que possui carga inicial referente a configuração de empresa e prestador em andamento. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationProviderId – companyId properties: configurationProviderId: type: string description: ID da configuração do prestador. companyId: type: string description: ID da empresa. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno da consulta. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta para retornar boolean indicando que possui carga inicial referente a configuração de empresa e prestador em andamento. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: configurationProviderId description: ID da configuração do prestador. in: query required: true type: string – name: companyId description: ID da empresa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno da consulta. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/initialLoadBranchStatus: post: description: Consulta para retornar o status da carga inicial das filiais por configuração do prestador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationProviderId – companyId properties: configurationProviderId: type: string description: ID da configuração do prestador. companyId: type: string description: ID da empresa. companyBranchIds: type: array items: type: string description: Lista de IDs das filiais. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/initialLoadBranchStatusResult minimum: 1 description: Lista com o retorno da consulta do status da carga inicial das filiais. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/exportCompanySetting: post: description: tags: – Queries x-senior-visibility: 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 /esocial4integration/queries/exportConfigurationCompany: 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 /esocial4integration/queries/exportConfigurationProvider: 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 /esocial4integration/queries/exportConfigurationBranch: 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 /esocial4integration/queries/exportConfigurationUserNotification: 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 /esocial4integration/queries/exportBranchIntegration: 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 /esocial4integration/queries/exportIntegration: 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 /esocial4integration/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/queries/exportCompany: 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 /esocial4integration/queries/exportCompanyBranch: 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 /esocial4integration/queries/exportDeficiency: 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 /esocial4integration/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 /esocial4integration/queries/exportWorkstation: 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 /esocial4integration/queries/exportShift: 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 /esocial4integration/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 /esocial4integration/queries/exportDepartment: 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 /esocial4integration/queries/exportCostCenter: 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 /esocial4integration/queries/exportReasonLeave: 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 /esocial4integration/queries/exportSalaryPremium: 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 /esocial4integration/queries/exportGeneralConfiguration: 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 /esocial4integration/queries/exportActiveSingleProviderESocialCategory: 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 /esocial4integration/queries/exportActiveESocialCategory: 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 /esocial4integration/queries/exportWorkEnvironment: 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 /esocial4integration/queries/exportInitialLoadProviderRequest: 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 /esocial4integration/queries/exportInitialLoadProviderBranchRequest: 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 /esocial4integration/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 /esocial4integration/actions/integrationThirdSystem: post: description: Envia dados do colaborador recebido por sistemas de terceiros. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – integrationType – scheduledDate – operationType – externalSystem properties: employee: type: object allOf: – #/definitions/employee description: Entidade colaborador integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. scheduledDate: type: string format: date description: Data de agendamento. operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação. externalSystem: type: string description: Sistema terceiro responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultIntegrationThirdSystem description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/integrationThirdSystemCancel: post: description: Envia dados do colaborador recebido por sistemas de terceiros. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idIntegration properties: idIntegration: type: string maxLength: 36 description: Id da integração. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultIntegrationThirdSystem description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/retrieveDataFromField: post: description: Retorna os valores existentes na base em determinada tabela e campo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – table – field – searchQuery properties: table: type: string allOf: – #/definitions/filterTables description: Tabela para consulta. field: type: string description: Campo para consulta. searchQuery: type: string description: Texto para pesquisa. responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Retorno da busca. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/syncConfigurationBranchWithPayrollBranches: post: description: Sincroniza as filiais do prestado SST com as filiais do payroll tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyIdentification properties: companyIdentification: type: string description: Identificação da empresa. responses: 200: description: Ok schema: type: object required: – ok – hasRecords properties: ok: type: boolean description: Flag indicando o sucesso da sincronia hasRecords: type: boolean description: Flag indicando se existem registros configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de configuração por filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/persistConfigurationCompany: post: description: Realiza a consistencia de uma configuração de empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: configurationCompany: type: object allOf: – #/definitions/configurationCompany description: Configuração de empresa configurationCompanyDelete: type: string description: Id da configuração de empresa que será deletada configurationProviders: type: array items: type: object allOf: – #/definitions/configurationProviderOperation description: Configurações de prestadores configurationProviderSituation: type: array items: type: object allOf: – #/definitions/keyValuePairBoolean description: Uma lista de id/flag indicando as configurações de prestadores e os respectivos valores do campo situation configurationProviderDelete: type: array items: type: string description: Uma lista de ids de prestadores SST que serão deletados operationType: type: string allOf: – #/definitions/operationType description: Operação realizada em cima da entidade configurationCompany responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: Flag indicando o sucesso da sincronia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/checkCompanyOnProvider: post: description: Verifica o status da empresa no prestador SST tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – providerType – companyProviderIdentification properties: providerType: type: string allOf: – #/definitions/providerType description: Tipo do prestador companyProviderIdentification: type: string description: Código da empresa no prestador SST responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Status da empresa no prestador SST 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/cancelPendencies: post: description: Cancela uma lista de pendências de integração. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciesToProcess properties: pendenciesToProcess: type: array items: type: object allOf: – #/definitions/integrationPendency minimum: 1 description: Lista de pendências para cancelar. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Possível aviso gerado durante o processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/resendPendencies: post: description: Regera e reenvia uma lista de pendências de integração. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciesToProcess properties: pendenciesToProcess: type: array items: type: object allOf: – #/definitions/integrationPendency minimum: 1 description: Lista de pendências para regerar e reenviar. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do processamento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/trySwitchingToMultipleProvidersMode: post: description: Retorna uma flag indicando se o modo de configuração foi alterado com sucesso para Múltiplos prestadores tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da tentativa de alteração do modo de configuração para Múltiplos Prestadores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/existsConfigurationBranch: post: description: Verifica se existe uma configuração já cadastrada na base. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchCode – subscriptionType – subscriptionNumber – providerId properties: branchCode: type: string description: Código da filial. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição. subscriptionNumber: type: string description: Número de inscrição. providerId: type: string description: Id do prestador. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Retorno da consulta. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/importCompanySetting: post: description: tags: – Actions x-senior-visibility: 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 /esocial4integration/actions/importConfigurationCompany: 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 /esocial4integration/actions/importConfigurationProvider: 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 /esocial4integration/actions/importConfigurationBranch: 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 /esocial4integration/actions/importConfigurationUserNotification: 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 /esocial4integration/actions/importBranchIntegration: 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 /esocial4integration/actions/importIntegration: 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 /esocial4integration/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/actions/importCompany: 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 /esocial4integration/actions/importCompanyBranch: 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 /esocial4integration/actions/importDeficiency: 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 /esocial4integration/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 /esocial4integration/actions/importWorkstation: 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 /esocial4integration/actions/importShift: 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 /esocial4integration/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 /esocial4integration/actions/importDepartment: 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 /esocial4integration/actions/importCostCenter: 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 /esocial4integration/actions/importReasonLeave: 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 /esocial4integration/actions/importSalaryPremium: 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 /esocial4integration/actions/importGeneralConfiguration: 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 /esocial4integration/actions/importActiveSingleProviderESocialCategory: 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 /esocial4integration/actions/importActiveESocialCategory: 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 /esocial4integration/actions/importWorkEnvironment: 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 /esocial4integration/actions/importInitialLoadProviderRequest: 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 /esocial4integration/actions/importInitialLoadProviderBranchRequest: 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 /esocial4integration/signals/integrationScheduled: post: description: Processa todas as pendências de integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationPublishPendencyEvent: post: description: Publica uma integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationId properties: integrationId: type: string description: Id da integração. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationPublishConsumeEmployeeIntegrationsByTenantEvent: post: description: Busca por pendências que não tiveram confirmação de recebimento pelo prestador SST. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationEmployeeWork: post: description: Processa uma admissão ou alteração da admissão de um colaborador. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: employeeId: type: string description: Id do colaborador no Payroll. integrationEmployeeType: type: string allOf: – #/definitions/integrationEmployeeType description: Tipo da integração. companyCode: type: integer format: int64 description: Código da empresa. cnpjCompanyBranch: type: string description: CNPJ da filial matriz. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/integrationUpdateStatus: post: description: Atualiza o status da integração. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationId – statusType properties: integrationId: type: string description: Id da integração. statusType: type: string allOf: – #/definitions/providerStatusType description: Status da integração. errorMessage: type: string description: Mensagem de erro. errorCode: type: string description: Código de identificação do erro. providerEmployeeIdentification: type: string description: Identificação única do colaborador no sistema do prestador SST responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/retryScheduler: post: description: Tenta regerar pendências falhadas tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/generatePendencies: post: description: Gera pendências das empresas ativas tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/employeeInitialLoad: post: description: Geração de carga inicial dos colaboradores tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companies properties: companies: type: array items: type: string minimum: 1 description: Lista de códigos de empresas que terão os employees integrados – essas integrações seguirão a regra da tela de configuração de empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/evaluateEmployeeChangePendencies: post: description: Processa as pendências de alteração de dados do colaborador que estão aguardando avaliação. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/contractsCorrection: post: description: \nGera alterações de dados para colaboradores com troca de contrato que possuem dados do contrato inativo como os últimos enviados ao prestador SST.\nIsso só pode ser executado uma vez, a partir dai essa rotina não faz mais nada. https://jira.senior.com.br/browse/HCMSST-3413\n tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/employeeDataCorrection: post: description: Gera pendências de alteração de dados para todos os colaboradores que já possuem pelo menos uma pendência integrada com o prestador SST. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/cleanUp: post: description: \nFaz uma limpeza na base de dados, eliminando pendências irrelevantes com mais de 7 dias desde a sua data de recebimento. Assim\ncomo as entidades, usadas nas pendências de integração, que não possuem mais ligação nenhuma com alguma pendência.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenantNames: type: array items: type: string description: Lista dos próximos Tenants a serem processados pela limpeza responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/employeeInitialLoadByCompanyBranch: post: description: Geração de carga inicial dos colaboradores a partir de filiais tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyCode – companyBranchCode – providerId properties: companyCode: type: string description: Código da empresa companyBranchCode: type: string description: Código de filial que terá seus colaboradores integrados providerId: type: string description: Id do prestador. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/generalConfigurationChange: post: description: Mudança na configuração geral. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – generalConfiguration properties: generalConfiguration: type: object allOf: – #/definitions/generalConfiguration description: Tipo de configuração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/incorrectlyReactivatedFiredEmployeeCorrection: post: description: Busca por pendências do tipo EMPLOYEE_CHANGE de colaboradores demitidos que tenham sido enviadas ao prestador SST indevidamente, em seguida\nas trata para que sejam reenviadas e possam ser marcadas como irrelevantes tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/resendIntegrationScheduledError: post: description: Reenvia toda pendências de integração com erros a cada 10 minutos. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/resendPendencyExclusionAdmissionProvider: post: description: Busca por pendências de exclusão de admissão de colaboradores que não tenham sido enviadas ao prestador e realiza o reenvio da pendência tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/eSocialCategoriesMigration: post: description: Atualiza as categorias do Esocial faltantes na configuração do prestador tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/initialLoadBranchBatchIntegration: post: description: Realizar a integração da carga inicial da filial por lote. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyBranchId – companyBranchCode – providerId – offset properties: companyBranchId: type: string description: ID da filial. companyBranchCode: type: string description: Código da filial. providerId: type: string description: ID do prestador SST. offset: type: integer format: int64 description: Número com o offset de páginação do lote. initialLoadProviderBranchRequestId: type: string description: ID da Request de carga inicial por prestador e filial. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/validateInitialLoadBranchBatchIntegration: post: description: Realiza a validação das pendências de integração da carga inicial da filial por lote. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchName – providerType – providerName properties: branchName: type: string description: Nome da filial. providerType: type: string allOf: – #/definitions/providerType description: Tipo de sistema do prestador SST. providerName: type: string description: Nome do prestador SST. initialLoadProviderBranchRequestId: type: string description: ID da Request de carga inicial por prestador e filial. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/updatePendenciesProviderInformation: post: description: Atualiza as informações do prestador SST nas pendências de integração por lote. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyCode – newProviderName – newCompanyProviderIdentification – providerType – offset properties: companyCode: type: integer format: int64 description: Código da empresa. newProviderName: type: string description: Novo nome do prestador SST. newCompanyProviderIdentification: type: string description: Novo código de identificação do prestador SST. newConfigurationBranches: type: array items: type: object allOf: – #/definitions/configurationBranchOperation description: Lista com as novas configurações das filiais do prestador SST. oldConfigurationBranches: type: array items: type: object allOf: – #/definitions/configurationBranchProviderIdentification description: Lista antiga das configurações das filiais do prestador SST. providerType: type: string allOf: – #/definitions/providerType description: Tipo de sistema do prestador SST. offset: type: integer format: int64 description: Número com o offset de páginação do lote. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/updateAttemptsStatus: post: description: Reseta os campos regenenateAttemps para null e resendScheduledErrorAttempts para 0 (zero) tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/processPendingValidation: post: description: Valida as pendências de integração em lotes que estejam com o status WAITING_VALIDATION antes de serem integradas. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/employeeInitialLoadByCompanyAndProvider: post: description: Geração de carga inicial dos colaboradores por empresa e prestador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyCode – providerId properties: companyCode: type: string description: Código da empresa. providerId: type: string description: Id do prestador. activateBranches: type: boolean description: Boolean para indicar se deve ativar a integração de todas as filiais. default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/signals/pendingInitialLoadBranch: post: description: Processa as filiais que estão com status PENDING para carga inicial. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento). x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/consumePendenciesByTenantEvent: post: description: Publica um aviso de que há pendências sem retorno do provedor SST. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencySOCEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para o prestador SOC. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyRSDataEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para o prestador RSData. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyMedNetEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para o prestador MedNet. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyCustomEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador customizado. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyGSOEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador GSO. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyNexoCSEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador Nexo CS. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyLabortecEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador Labortec. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyDrOcupacionalEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador Dr Ocupacional. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencySoftwareSGGEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador Software SGG. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyTAPEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador TAP. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencySBOSEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador SBOS. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyApollusEHSEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador Apollus EHS. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/integrationPendencyProClinicEvent: post: description: Publica um colaborador (Admissão, Alteração da admissão, Movimentações e Desligamento) para prestador ProClinic. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integration properties: integration: type: object allOf: – #/definitions/integration description: Dados de integração. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/importCompanySettingEvent: 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 /esocial4integration/events/exportCompanySettingEvent: 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 /esocial4integration/events/importConfigurationCompanyEvent: 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 /esocial4integration/events/exportConfigurationCompanyEvent: 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 /esocial4integration/events/importConfigurationProviderEvent: 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 /esocial4integration/events/exportConfigurationProviderEvent: 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 /esocial4integration/events/importConfigurationBranchEvent: 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 /esocial4integration/events/exportConfigurationBranchEvent: 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 /esocial4integration/events/importConfigurationUserNotificationEvent: 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 /esocial4integration/events/exportConfigurationUserNotificationEvent: 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 /esocial4integration/events/importBranchIntegrationEvent: 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 /esocial4integration/events/exportBranchIntegrationEvent: 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 /esocial4integration/events/importIntegrationEvent: 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 /esocial4integration/events/exportIntegrationEvent: 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 /esocial4integration/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /esocial4integration/events/importCompanyEvent: 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 /esocial4integration/events/exportCompanyEvent: 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 /esocial4integration/events/importCompanyBranchEvent: 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 /esocial4integration/events/exportCompanyBranchEvent: 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 /esocial4integration/events/importDeficiencyEvent: 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 /esocial4integration/events/exportDeficiencyEvent: 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 /esocial4integration/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 /esocial4integration/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 /esocial4integration/events/importWorkstationEvent: 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 /esocial4integration/events/exportWorkstationEvent: 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 /esocial4integration/events/importShiftEvent: 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 /esocial4integration/events/exportShiftEvent: 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 /esocial4integration/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 /esocial4integration/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 /esocial4integration/events/importDepartmentEvent: 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 /esocial4integration/events/exportDepartmentEvent: 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 /esocial4integration/events/importCostCenterEvent: 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 /esocial4integration/events/exportCostCenterEvent: 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 /esocial4integration/events/importReasonLeaveEvent: 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 /esocial4integration/events/exportReasonLeaveEvent: 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 /esocial4integration/events/importSalaryPremiumEvent: 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 /esocial4integration/events/exportSalaryPremiumEvent: 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 /esocial4integration/events/importGeneralConfigurationEvent: 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 /esocial4integration/events/exportGeneralConfigurationEvent: 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 /esocial4integration/events/importActiveSingleProviderESocialCategoryEvent: 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 /esocial4integration/events/exportActiveSingleProviderESocialCategoryEvent: 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 /esocial4integration/events/importActiveESocialCategoryEvent: 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 /esocial4integration/events/exportActiveESocialCategoryEvent: 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 /esocial4integration/events/importWorkEnvironmentEvent: 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 /esocial4integration/events/exportWorkEnvironmentEvent: 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 /esocial4integration/events/importInitialLoadProviderRequestEvent: 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 /esocial4integration/events/exportInitialLoadProviderRequestEvent: 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 /esocial4integration/events/importInitialLoadProviderBranchRequestEvent: 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 /esocial4integration/events/exportInitialLoadProviderBranchRequestEvent: 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 /esocial4integration/entities/companySetting: 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/companySetting responses: 200: description: The created resource schema: #/definitions/companySetting 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/companySetting responses: 200: description: The created resource schema: #/definitions/companySetting 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/companySetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting/{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/editCompanySetting responses: 200: description: Ok schema: #/definitions/editCompanySetting 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/companySetting responses: 200: description: Ok schema: #/definitions/companySetting 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/companySetting 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 /esocial4integration/entities/companySetting/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companySetting responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationCompany responses: 200: description: The created resource schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationCompany responses: 200: description: The created resource schema: #/definitions/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany/{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/editConfigurationCompany responses: 200: description: Ok schema: #/definitions/editConfigurationCompany 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/configurationCompany responses: 200: description: Ok schema: #/definitions/configurationCompany 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/configurationCompany 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 /esocial4integration/entities/configurationCompany/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationCompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationProvider responses: 200: description: The created resource schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationProvider responses: 200: description: The created resource schema: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{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/editConfigurationProvider responses: 200: description: Ok schema: #/definitions/editConfigurationProvider 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/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 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/configurationProvider 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 /esocial4integration/entities/configurationCompany/{parentId}/configurationProvider: 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: array items: #/definitions/configurationProvider responses: 200: description: The created resources schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: 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: array items: #/definitions/configurationProvider responses: 200: description: The created resources schema: type: array items: #/definitions/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationProvider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationCompany/{parentId}/configurationProvider/{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/editConfigurationProvider responses: 200: description: Ok schema: #/definitions/editConfigurationProvider 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/configurationProvider responses: 200: description: Ok schema: #/definitions/configurationProvider 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/configurationProvider 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 /esocial4integration/entities/configurationProvider/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationProvider responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationBranch: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationBranch responses: 200: description: The created resource schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationBranch responses: 200: description: The created resource schema: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationBranch/{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/editConfigurationBranch responses: 200: description: Ok schema: #/definitions/editConfigurationBranch 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/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 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/configurationBranch 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 /esocial4integration/entities/configurationProvider/{parentId}/configurationBranch: 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: array items: #/definitions/configurationBranch responses: 200: description: The created resources schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: 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: array items: #/definitions/configurationBranch responses: 200: description: The created resources schema: type: array items: #/definitions/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{parentId}/configurationBranch/{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/editConfigurationBranch responses: 200: description: Ok schema: #/definitions/editConfigurationBranch 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/configurationBranch responses: 200: description: Ok schema: #/definitions/configurationBranch 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/configurationBranch 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 /esocial4integration/entities/configurationBranch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationUserNotification: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationUserNotification responses: 200: description: The created resource schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configurationUserNotification responses: 200: description: The created resource schema: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationUserNotification/{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/editConfigurationUserNotification responses: 200: description: Ok schema: #/definitions/editConfigurationUserNotification 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/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 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/configurationUserNotification 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 /esocial4integration/entities/configurationProvider/{parentId}/configurationUserNotification: 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: array items: #/definitions/configurationUserNotification responses: 200: description: The created resources schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: 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: array items: #/definitions/configurationUserNotification responses: 200: description: The created resources schema: type: array items: #/definitions/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/configurationUserNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{parentId}/configurationUserNotification/{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/editConfigurationUserNotification responses: 200: description: Ok schema: #/definitions/editConfigurationUserNotification 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/configurationUserNotification responses: 200: description: Ok schema: #/definitions/configurationUserNotification 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/configurationUserNotification 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 /esocial4integration/entities/configurationUserNotification/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configurationUserNotification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/branchIntegration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchIntegration responses: 200: description: The created resource schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchIntegration responses: 200: description: The created resource schema: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/branchIntegration/{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/editBranchIntegration responses: 200: description: Ok schema: #/definitions/editBranchIntegration 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/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 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/branchIntegration 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 /esocial4integration/entities/companySetting/{parentId}/branchIntegrations: 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: array items: #/definitions/branchIntegration responses: 200: description: The created resources schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: 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: array items: #/definitions/branchIntegration responses: 200: description: The created resources schema: type: array items: #/definitions/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/branchIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting/{parentId}/branchIntegrations/{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/editBranchIntegration responses: 200: description: Ok schema: #/definitions/editBranchIntegration 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/branchIntegration responses: 200: description: Ok schema: #/definitions/branchIntegration 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/branchIntegration 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 /esocial4integration/entities/branchIntegration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/branchIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/integration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integration responses: 200: description: The created resource schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integration responses: 200: description: The created resource schema: #/definitions/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/integration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/integration/{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/editIntegration responses: 200: description: Ok schema: #/definitions/editIntegration 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/integration responses: 200: description: Ok schema: #/definitions/integration 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/integration 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 /esocial4integration/entities/integration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{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/editEmployee responses: 200: description: Ok schema: #/definitions/editEmployee 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/employee responses: 200: description: Ok schema: #/definitions/employee 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/employee 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 /esocial4integration/entities/integration/{parentId}/employee: 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/employee responses: 200: description: The created resource schema: #/definitions/employee 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/employee responses: 200: description: The created resource schema: #/definitions/employee 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/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/integration/{parentId}/employee/{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/editEmployee responses: 200: description: Ok schema: #/definitions/editEmployee 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/employee responses: 200: description: Ok schema: #/definitions/employee 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/employee 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 /esocial4integration/entities/employee/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/company: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/company/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /esocial4integration/entities/employee/{parentId}/company: 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/previousCompany: 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/reintegrationCompanyOrigin: 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/company/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /esocial4integration/entities/employee/{parentId}/previousCompany/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /esocial4integration/entities/employee/{parentId}/reintegrationCompanyOrigin/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /esocial4integration/entities/company/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companyBranch: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companyBranch/{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/editCompanyBranch responses: 200: description: Ok schema: #/definitions/editCompanyBranch 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/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 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/companyBranch 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 /esocial4integration/entities/employee/{parentId}/companyBranch: 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/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/previousCompanyBranch: 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/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/companyBranch/{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/editCompanyBranch responses: 200: description: Ok schema: #/definitions/editCompanyBranch 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/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 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/companyBranch 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 /esocial4integration/entities/employee/{parentId}/previousCompanyBranch/{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/editCompanyBranch responses: 200: description: Ok schema: #/definitions/editCompanyBranch 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/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 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/companyBranch 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 /esocial4integration/entities/companyBranch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/deficiency: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deficiency responses: 200: description: The created resource schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deficiency responses: 200: description: The created resource schema: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/deficiency/{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/editDeficiency responses: 200: description: Ok schema: #/definitions/editDeficiency 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/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 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/deficiency 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 /esocial4integration/entities/employee/{parentId}/deficiencies: 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: array items: #/definitions/deficiency responses: 200: description: The created resources schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: 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: array items: #/definitions/deficiency responses: 200: description: The created resources schema: type: array items: #/definitions/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/deficiency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/deficiencies/{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/editDeficiency responses: 200: description: Ok schema: #/definitions/editDeficiency 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/deficiency responses: 200: description: Ok schema: #/definitions/deficiency 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/deficiency 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 /esocial4integration/entities/deficiency/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deficiency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/eSocialCategory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/eSocialCategory/{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/editESocialCategory responses: 200: description: Ok schema: #/definitions/editESocialCategory 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/eSocialCategory responses: 200: description: Ok schema: #/definitions/eSocialCategory 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/eSocialCategory 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 /esocial4integration/entities/employee/{parentId}/eSocialCategory: 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/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 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/eSocialCategory responses: 200: description: The created resource schema: #/definitions/eSocialCategory 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/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/eSocialCategory/{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/editESocialCategory responses: 200: description: Ok schema: #/definitions/editESocialCategory 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/eSocialCategory responses: 200: description: Ok schema: #/definitions/eSocialCategory 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/eSocialCategory 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 /esocial4integration/entities/eSocialCategory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialCategory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workstation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstation responses: 200: description: The created resource schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstation responses: 200: description: The created resource schema: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workstation/{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/editWorkstation responses: 200: description: Ok schema: #/definitions/editWorkstation 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/workstation responses: 200: description: Ok schema: #/definitions/workstation 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/workstation 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 /esocial4integration/entities/employee/{parentId}/workstation: 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/workstation responses: 200: description: The created resource schema: #/definitions/workstation 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/workstation responses: 200: description: The created resource schema: #/definitions/workstation 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/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/workstation/{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/editWorkstation responses: 200: description: Ok schema: #/definitions/editWorkstation 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/workstation responses: 200: description: Ok schema: #/definitions/workstation 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/workstation 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 /esocial4integration/entities/workstation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workstation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/shift: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shift responses: 200: description: The created resource schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shift responses: 200: description: The created resource schema: #/definitions/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/shift/{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/editShift responses: 200: description: Ok schema: #/definitions/editShift 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/shift responses: 200: description: Ok schema: #/definitions/shift 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/shift 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 /esocial4integration/entities/employee/{parentId}/shift: 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/shift responses: 200: description: The created resource schema: #/definitions/shift 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/shift responses: 200: description: The created resource schema: #/definitions/shift 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/shift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/shift/{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/editShift responses: 200: description: Ok schema: #/definitions/editShift 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/shift responses: 200: description: Ok schema: #/definitions/shift 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/shift 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 /esocial4integration/entities/shift/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shift responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/jobPosition: post: description: 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 /esocial4integration/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 /esocial4integration/entities/employee/{parentId}/jobPosition: 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/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: parentId in: path required: true type: string – 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: 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/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/jobPosition/{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/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: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/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 /esocial4integration/entities/department: 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/department responses: 200: description: The created resource schema: #/definitions/department 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/department responses: 200: description: The created resource schema: #/definitions/department 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/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/department/{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/editDepartment responses: 200: description: Ok schema: #/definitions/editDepartment 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/department responses: 200: description: Ok schema: #/definitions/department 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/department 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 /esocial4integration/entities/employee/{parentId}/department: 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/department responses: 200: description: The created resource schema: #/definitions/department 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/department responses: 200: description: The created resource schema: #/definitions/department 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/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/department/{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/editDepartment responses: 200: description: Ok schema: #/definitions/editDepartment 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/department responses: 200: description: Ok schema: #/definitions/department 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/department 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 /esocial4integration/entities/department/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/department responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/costCenter: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/costCenter/{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/editCostCenter responses: 200: description: Ok schema: #/definitions/editCostCenter 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/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 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/costCenter 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 /esocial4integration/entities/employee/{parentId}/costCenter: 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/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 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/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 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/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/costCenter/{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/editCostCenter responses: 200: description: Ok schema: #/definitions/editCostCenter 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/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 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/costCenter 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 /esocial4integration/entities/costCenter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/costCenter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/reasonLeave: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/reasonLeave/{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/editReasonLeave responses: 200: description: Ok schema: #/definitions/editReasonLeave 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/reasonLeave responses: 200: description: Ok schema: #/definitions/reasonLeave 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/reasonLeave 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 /esocial4integration/entities/employee/{parentId}/reasonLeave: 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/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 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/reasonLeave responses: 200: description: The created resource schema: #/definitions/reasonLeave 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/reasonLeave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/reasonLeave/{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/editReasonLeave responses: 200: description: Ok schema: #/definitions/editReasonLeave 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/reasonLeave responses: 200: description: Ok schema: #/definitions/reasonLeave 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/reasonLeave 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 /esocial4integration/entities/reasonLeave/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/reasonLeave responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/salaryPremium: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/salaryPremium/{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/editSalaryPremium responses: 200: description: Ok schema: #/definitions/editSalaryPremium 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/salaryPremium responses: 200: description: Ok schema: #/definitions/salaryPremium 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/salaryPremium 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 /esocial4integration/entities/employee/{parentId}/salaryPremium: 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/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 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/salaryPremium responses: 200: description: The created resource schema: #/definitions/salaryPremium 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/salaryPremium 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/salaryPremium/{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/editSalaryPremium responses: 200: description: Ok schema: #/definitions/editSalaryPremium 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/salaryPremium responses: 200: description: Ok schema: #/definitions/salaryPremium 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/salaryPremium 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 /esocial4integration/entities/salaryPremium/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salaryPremium responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/generalConfiguration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/generalConfiguration/{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/editGeneralConfiguration responses: 200: description: Ok schema: #/definitions/editGeneralConfiguration 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/generalConfiguration responses: 200: description: Ok schema: #/definitions/generalConfiguration 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/generalConfiguration 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 /esocial4integration/entities/generalConfiguration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generalConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/activeSingleProviderESocialCategory: 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/activeSingleProviderESocialCategory responses: 200: description: The created resource schema: #/definitions/activeSingleProviderESocialCategory 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/activeSingleProviderESocialCategory responses: 200: description: The created resource schema: #/definitions/activeSingleProviderESocialCategory 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/activeSingleProviderESocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/activeSingleProviderESocialCategory/{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/editActiveSingleProviderESocialCategory responses: 200: description: Ok schema: #/definitions/editActiveSingleProviderESocialCategory 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/activeSingleProviderESocialCategory responses: 200: description: Ok schema: #/definitions/activeSingleProviderESocialCategory 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/activeSingleProviderESocialCategory 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 /esocial4integration/entities/companySetting/{parentId}/activeESocialCategories: 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: array items: #/definitions/activeSingleProviderESocialCategory responses: 200: description: The created resources schema: type: array items: #/definitions/activeSingleProviderESocialCategory 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: array items: #/definitions/activeSingleProviderESocialCategory responses: 200: description: The created resources schema: type: array items: #/definitions/activeSingleProviderESocialCategory 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/activeSingleProviderESocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/companySetting/{parentId}/activeESocialCategories/{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/editActiveSingleProviderESocialCategory responses: 200: description: Ok schema: #/definitions/editActiveSingleProviderESocialCategory 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/activeSingleProviderESocialCategory responses: 200: description: Ok schema: #/definitions/activeSingleProviderESocialCategory 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/activeSingleProviderESocialCategory 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 /esocial4integration/entities/activeSingleProviderESocialCategory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activeSingleProviderESocialCategory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/activeESocialCategory: 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/activeESocialCategory responses: 200: description: The created resource schema: #/definitions/activeESocialCategory 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/activeESocialCategory responses: 200: description: The created resource schema: #/definitions/activeESocialCategory 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/activeESocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/activeESocialCategory/{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/editActiveESocialCategory responses: 200: description: Ok schema: #/definitions/editActiveESocialCategory 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/activeESocialCategory responses: 200: description: Ok schema: #/definitions/activeESocialCategory 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/activeESocialCategory 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 /esocial4integration/entities/configurationProvider/{parentId}/activeESocialCategories: 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: array items: #/definitions/activeESocialCategory responses: 200: description: The created resources schema: type: array items: #/definitions/activeESocialCategory 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: array items: #/definitions/activeESocialCategory responses: 200: description: The created resources schema: type: array items: #/definitions/activeESocialCategory 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/activeESocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/configurationProvider/{parentId}/activeESocialCategories/{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/editActiveESocialCategory responses: 200: description: Ok schema: #/definitions/editActiveESocialCategory 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/activeESocialCategory responses: 200: description: Ok schema: #/definitions/activeESocialCategory 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/activeESocialCategory 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 /esocial4integration/entities/activeESocialCategory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activeESocialCategory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workEnvironment: 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/workEnvironment responses: 200: description: The created resource schema: #/definitions/workEnvironment 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/workEnvironment responses: 200: description: The created resource schema: #/definitions/workEnvironment 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/workEnvironment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/workEnvironment/{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/editWorkEnvironment responses: 200: description: Ok schema: #/definitions/editWorkEnvironment 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/workEnvironment responses: 200: description: Ok schema: #/definitions/workEnvironment 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/workEnvironment 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 /esocial4integration/entities/employee/{parentId}/workEnvironment: 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/workEnvironment responses: 200: description: The created resource schema: #/definitions/workEnvironment 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/workEnvironment responses: 200: description: The created resource schema: #/definitions/workEnvironment 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/workEnvironment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/employee/{parentId}/workEnvironment/{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/editWorkEnvironment responses: 200: description: Ok schema: #/definitions/editWorkEnvironment 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/workEnvironment responses: 200: description: Ok schema: #/definitions/workEnvironment 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/workEnvironment 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 /esocial4integration/entities/workEnvironment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workEnvironment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/initialLoadProviderRequest: 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/initialLoadProviderRequest responses: 200: description: The created resource schema: #/definitions/initialLoadProviderRequest 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/initialLoadProviderRequest responses: 200: description: The created resource schema: #/definitions/initialLoadProviderRequest 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/initialLoadProviderRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/initialLoadProviderRequest/{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/editInitialLoadProviderRequest responses: 200: description: Ok schema: #/definitions/editInitialLoadProviderRequest 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/initialLoadProviderRequest responses: 200: description: Ok schema: #/definitions/initialLoadProviderRequest 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/initialLoadProviderRequest 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 /esocial4integration/entities/initialLoadProviderRequest/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/initialLoadProviderRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/initialLoadProviderBranchRequest: 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/initialLoadProviderBranchRequest responses: 200: description: The created resource schema: #/definitions/initialLoadProviderBranchRequest 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/initialLoadProviderBranchRequest responses: 200: description: The created resource schema: #/definitions/initialLoadProviderBranchRequest 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/initialLoadProviderBranchRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial4integration/entities/initialLoadProviderBranchRequest/{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/editInitialLoadProviderBranchRequest responses: 200: description: Ok schema: #/definitions/editInitialLoadProviderBranchRequest 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/initialLoadProviderBranchRequest responses: 200: description: Ok schema: #/definitions/initialLoadProviderBranchRequest 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/initialLoadProviderBranchRequest 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 /esocial4integration/entities/initialLoadProviderBranchRequest/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/initialLoadProviderBranchRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim configurationMode: type: string enum: – SINGLEPROVIDER – MULTIPLEPROVIDERS description: Status do healthcheck: * `SINGLEPROVIDER` – Unico prestador * `MULTIPLEPROVIDERS` – Múltiplos prestadores integrationEmployeeType: type: string enum: – NEW_EMPLOYEE – EMPLOYEE_CHANGE – DISMISSAL – EMPLOYEE_ESOCIAL_REGISTRATION description: Tipo de alteração do colaborador.: * `NEW_EMPLOYEE` – Novo colaborador. * `EMPLOYEE_CHANGE` – Alteração do colaborador. * `DISMISSAL` – Demissão do colaborador. * `EMPLOYEE_ESOCIAL_REGISTRATION` – Alteração matrícula eSocial integrationHistoricOfEmployeeType: type: string enum: – HISTORICAL_COST_CENTER – HISTORICAL_DEPARTMENT – HISTORICAL_ESOCIAL_CATEGORY – HISTORICAL_JOB_POSITION – HISTORICAL_LEAVE – HISTORICAL_WORKSTATION – HISTORICAL_COMPANY_BRANCH – HISTORICAL_WORKSHIFT – HISTORICAL_WORK_ENVIRONMENT description: Tipo de alteração do histórico do colaborador.: * `HISTORICAL_COST_CENTER` – Histórico de centro de custo. * `HISTORICAL_DEPARTMENT` – Histórico de departamento. * `HISTORICAL_ESOCIAL_CATEGORY` – Histórico de categoria eSocial * `HISTORICAL_JOB_POSITION` – Histórico de cargo. * `HISTORICAL_LEAVE` – Histórico de afastamento. * `HISTORICAL_WORKSTATION` – Histórico de posto de trabalho. * `HISTORICAL_COMPANY_BRANCH` – Histórico de filial. * `HISTORICAL_WORKSHIFT` – Histórico de escala. * `HISTORICAL_WORK_ENVIRONMENT` – Histórico de ambiente de trabalho. statusType: type: string enum: – SCHEDULED – INTEGRATING – PROCESSING_RESEND – SENT_TO_PROVIDER – ON_PROVIDER – INTEGRATION_ERROR – INTEGRATION_ERROR_PROVIDER – WARNING – CANCELED – IN_ANALYSIS – ANALYSIS_ERROR – IRRELEVANT – CANCEL_REGENERATED – WAITING_RETRY_SCHEDULER – WAITING_PENDENCY_EVALUATION – REFERENCE_PENDENCY – WAITING_VALIDATION description: Tipo do status de integração.: * `SCHEDULED` – Envio da pendência agendado. * `INTEGRATING` – Processando a pendência. * `PROCESSING_RESEND` – Processando o reenvio * `SENT_TO_PROVIDER` – Pendência enviada ao prestador SST. Aguardando confirmação da integração. * `ON_PROVIDER` – Pendência integrada com sucesso pelo prestador SST. * `INTEGRATION_ERROR` – Pendência gerada com erro. * `INTEGRATION_ERROR_PROVIDER` – Erro no processamento da pendência no prestador SST. * `WARNING` – Alerta. * `CANCELED` – Pendência cancelada. * `IN_ANALYSIS` – Em análise. * `ANALYSIS_ERROR` – Erro na análise. * `IRRELEVANT` – Irrelevante para o envio. * `CANCEL_REGENERATED` – Pendência regerada. * `WAITING_RETRY_SCHEDULER` – Aguardando agendador de tentativa de reenvio. * `WAITING_PENDENCY_EVALUATION` – Aguardando avaliação. * `REFERENCE_PENDENCY` – Pendência de referência para avaliação. * `WAITING_VALIDATION` – Aguardando Validação. providerStatusType: type: string enum: – ON_PROVIDER – INTEGRATION_ERROR description: Tipo so status da integração para o provedor SST.: * `ON_PROVIDER` – Recebido pelo prestador SST. * `INTEGRATION_ERROR` – Erro no prestador SST durante a integração. fieldOfPlatform: type: string enum: – COMPANY – COMPANY_BRANCH description: Campos da Plataforma, referente Abrangências: * `COMPANY` – Empresa * `COMPANY_BRANCH` – Filial integrationType: type: string enum: – INITIAL_LOAD – NEW_EMPLOYEE – EMPLOYEE_CHANGE – EMPLOYEE_ESOCIAL_REGISTRATION – HISTORICAL_COMPANY – HISTORICAL_COMPANY_BRANCH – HISTORICAL_COST_CENTER – HISTORICAL_WORKSTATION – HISTORICAL_DEPARTMENT – HISTORICAL_JOB_POSITION – HISTORICAL_WORKSHIFT – HISTORICAL_LEAVE – HISTORICAL_ESOCIAL_CATEGORY – HISTORICAL_SALARY_PREMIUM – DISMISSAL – HISTORICAL_WORK_ENVIRONMENT – REINTEGRATION description: Tipo da integração.: * `INITIAL_LOAD` – Carga Inicial * `NEW_EMPLOYEE` – Novo colaborador. * `EMPLOYEE_CHANGE` – Alteração do colaborador. * `EMPLOYEE_ESOCIAL_REGISTRATION` – Alteração matrícula eSocial * `HISTORICAL_COMPANY` – Histórico de empresa. * `HISTORICAL_COMPANY_BRANCH` – Histórico de filial. * `HISTORICAL_COST_CENTER` – Histórico de centro de custo. * `HISTORICAL_WORKSTATION` – Histórico de posto de trabalho. * `HISTORICAL_DEPARTMENT` – Histórico de departamento. * `HISTORICAL_JOB_POSITION` – Histórico de cargo. * `HISTORICAL_WORKSHIFT` – Histórico de escala. * `HISTORICAL_LEAVE` – Histórico de afastamento. * `HISTORICAL_ESOCIAL_CATEGORY` – Histórico de categoria eSocial. * `HISTORICAL_SALARY_PREMIUM` – Histórico de informações adicionais * `DISMISSAL` – Demissão do colaborador. * `HISTORICAL_WORK_ENVIRONMENT` – Histórico de ambiente de trabalho. * `REINTEGRATION` – Reintegração do colaborador. subscriptionType: type: string enum: – CNPJ – CPF – CAEPF – CNO – CEI – NOT_FOUND description: Tipo de inscrição.: * `CNPJ` – 1 – CNPJ. * `CPF` – 2 – CPF. * `CAEPF` – 3 – CAEPF (Cadastro de Atividade Econômica de Pessoa Física). * `CNO` – 4 – CNO (Cadastro Nacional de Obra). * `CEI` – 5 – CEI. * `NOT_FOUND` – Não encontrado. employeeType: type: string enum: – EMPLOYEE – THIRD – PARTNER – NOT_FOUND description: Tipo do colaborador.: * `EMPLOYEE` – Colaborador. * `THIRD` – Terceiro. * `PARTNER` – Parceiro. * `NOT_FOUND` – Não encontrado. maritalStatusType: type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – SEPARATED – STABLE_UNION – OTHER – CONCUBINAGE – NOT_FOUND description: Estado civil.: * `SINGLE` – Solteiro. * `MARRIED` – Casado. * `DIVORCED` – Divorciado * `WIDOWER` – Viúvo * `SEPARATED` – Separado. * `STABLE_UNION` – União estável. * `OTHER` – Outro tipo de estado civil. * `CONCUBINAGE` – Concubinato * `NOT_FOUND` – Não encontrado. genderType: type: string enum: – MALE – FEMALE description: Gênero do colaborador.: * `MALE` – Masculino. * `FEMALE` – Feminino. situationType: type: string enum: – PRE_ADMISSION – PRE_ADMISSION_CANCELED – WORKING – VACATION – FIRED – AWAY – LICENSE – RETIREMENT description: Situação do colaborador.: * `PRE_ADMISSION` – Pré-admissão * `PRE_ADMISSION_CANCELED` – Pré-admissão cancelada * `WORKING` – Trabalhando. * `VACATION` – Férias * `FIRED` – Demitido. * `AWAY` – Afastado. * `LICENSE` – Licença. * `RETIREMENT` – Aposentadoria. contractType: type: string enum: – EMPLOYEE – MANAGER – FARMWORKER – RETIRED – TRAINEE – APPRENTICE – FIXEDDUEDATE – RETIREDMANAGER – PUBLICAGENT – TEACHER – COOPERATIVEWORKER – DOMESTICWORKER – TEACHERFIXEDDUEDATE – NOT_FOUND – THIRD_PARTY description: Tipo do contrato.: * `EMPLOYEE` – Empregado * `MANAGER` – Diretor * `FARMWORKER` – Trabalhador rural * `RETIRED` – Aposentado * `TRAINEE` – Estagiário * `APPRENTICE` – Aprendiz * `FIXEDDUEDATE` – Prazo determinado * `RETIREDMANAGER` – Diretor aposentado * `PUBLICAGENT` – Agente público * `TEACHER` – Professor * `COOPERATIVEWORKER` – Cooperado * `DOMESTICWORKER` – Trabalhador domestico * `TEACHERFIXEDDUEDATE` – Professor, prazo determinado * `NOT_FOUND` – Não encontrado. * `THIRD_PARTY` – Terceiro deficiencyType: type: string enum: – PHYSICAL – AUDITORY – VISUAL – MENTAL – INTELLECTUAL – OTHER – NOT_FOUND description: Tipo da deficiência no e-Social.: * `PHYSICAL` – Física. * `AUDITORY` – Auditiva. * `VISUAL` – Visual. * `MENTAL` – Mental. * `INTELLECTUAL` – Intelectual. * `OTHER` – Outro tipo de deficiência. * `NOT_FOUND` – Não encontrado. eSocialCategoryType: type: string enum: – Category_101 – Category_102 – Category_103 – Category_104 – Category_105 – Category_106 – Category_107 – Category_108 – Category_111 – Category_201 – Category_202 – Category_301 – Category_302 – Category_303 – Category_304 – Category_305 – Category_306 – Category_307 – Category_308 – Category_309 – Category_310 – Category_311 – Category_312 – Category_313 – Category_401 – Category_410 – Category_701 – Category_711 – Category_712 – Category_721 – Category_722 – Category_723 – Category_731 – Category_734 – Category_738 – Category_741 – Category_751 – Category_761 – Category_771 – Category_781 – Category_901 – Category_902 – Category_903 – Category_904 – Category_905 – Category_9995 – Category_9996 – Category_9997 – Category_9999 – Category_501 – Category_906 description: Tipo de categoria do e-Social.: * `Category_101` – Empregado – Geral, inclusive o empregado público da administração direta ou indireta contratado pela CLT * `Category_102` – Empregado – Trabalhador Rural por Pequeno Prazo da Lei 11.718/2008 * `Category_103` – Empregado – Aprendiz * `Category_104` – Empregado – Doméstico * `Category_105` – Empregado – contrato a termo firmado nos termos da Lei 9601/98 * `Category_106` – Trabalhador Temporário – contrato nos termos da Lei 6019/74 * `Category_107` – Empregado – Contrato de trabalho Verde e Amarelo – sem acordo para antecipação mensal da multa rescisória do FGTS * `Category_108` – Empregado – Contrato de trabalho Verde e Amarelo – com acordo para antecipação mensal da multa rescisória do FGTS * `Category_111` – Empregado – contrato de trabalho intermitente * `Category_201` – Trabalhador Avulso – Portuário * `Category_202` – Trabalhador Avulso – Não Portuário * `Category_301` – Servidor Público – Titular de Cargo Efetivo, Magistrado, Ministro de Tribunal de Contas, Conselheiro de Tribunal Contas e Membro do Ministério Público * `Category_302` – Servidor Público – Ocupante de Cargo exclusivo em comissão * `Category_303` – Exercente de mandato eletivo * `Category_304` – Servidor público exercente de mandato eletivo, inclusive com exercício de cargo em comissão * `Category_305` – Servidor público indicado para conselho ou órgão representativo, na condição de representante do governo, órgão ou entidade da administração pública * `Category_306` – Servidor público contratado por tempo determinado, sujeito a regime administrativo especial definido em lei própria * `Category_307` – Militar * `Category_308` – Conscrito * `Category_309` – Agente Público – Outros * `Category_310` – Servidor público eventual * `Category_311` – Ministros, juízes, procuradores, promotores ou oficiais de justiça à disposição da Justiça Eleitoral * `Category_312` – Auxiliar local * `Category_313` – Servidor público exercente de atividade de instrutoria, curso ou concurso, convocado para pareceres técnicos, depoimentos ou aditância no exterior * `Category_401` – Dirigente Sindical – informação prestada pelo Sindicato * `Category_410` – Trabalhador cedido/exercício em outro órgão/juiz auxiliar – Informação prestada pelo cessionário/destino * `Category_701` – Contribuinte individual – Autônomo em geral, exceto se enquadrado em uma das demais categorias de contribuinte individual * `Category_711` – Contribuinte individual – Transportador autônomo de passageiros * `Category_712` – Contribuinte individual – Transportador autônomo de carga * `Category_721` – Contribuinte individual – Diretor não empregado com FGTS * `Category_722` – Contribuinte individual – Diretor não empregado sem FGTS * `Category_723` – Contribuinte individual – empresários, sócios e membro de conselho de administração ou fiscal * `Category_731` – Contribuinte individual – Cooperado que presta serviços a empresa por intermédio de cooperativa de trabalho * `Category_734` – Contribuinte individual – Transportador Cooperado que presta serviços por intermédio de cooperativa de trabalho * `Category_738` – Contribuinte individual – Cooperado filiado a Cooperativa de Produção * `Category_741` – Contribuinte individual – Micro Empreendedor Individual * `Category_751` – Contribuinte individual – magistrado classista temporário da Justiça do Trabalho ou da Justiça Eleitoral que seja aposentado de qualquer regime previdenciário * `Category_761` – Contribuinte individual – Associado eleito para direção de Cooperativa, associação ou entidade de classe de qualquer natureza ou finalidade, bem como o síndico ou adm., desde que recebam remuneração * `Category_771` – Contribuinte individual – Membro de conselho tutelar, nos termos da Lei nº 8.069, de 13 de julho de 1990 * `Category_781` – Ministro de confissão religiosa ou membro de vida consagrada, de congregação ou de ordem religiosa * `Category_901` – Estagiário * `Category_902` – Médico Residente * `Category_903` – Bolsista, nos termos da lei 8958/1994 * `Category_904` – Participante de curso de formação, como etapa de concurso público, sem vínculo de emprego/estatutário * `Category_905` – Atleta não profissional em formação que receba bolsa * `Category_9995` – Beneficiário Ente Público * `Category_9996` – Beneficiário Ente Público – Somente Cadastro Beneficio * `Category_9997` – Demitido com data anterior à sucessão (categoria exclusiva Senior) * `Category_9999` – Não se aplica * `Category_501` – Dirigente sindical – Segurado especial * `Category_906` – Beneficiário do programa nacional de prestação de serviço civil voluntário directionType: type: string enum: – ASC – DESC description: Tipo de ordenação.: * `ASC` – Ascendente. * `DESC` – Descendente. operationType: type: string enum: – INSERT – UPDATE – DELETE description: Tipo de operação.: * `INSERT` – Inserção. * `UPDATE` – Atualização. * `DELETE` – Exclusão. filterTables: type: string enum: – INTEGRATION description: Tables disponíveis para filtro nas telas de cadastro.: * `INTEGRATION` – Pendência de integração. state: type: string enum: – AC – AL – AP – AM – BA – CE – DF – ES – GO – MA – MT – MS – MG – PA – PB – PR – PE – PI – RJ – RN – RS – RO – RR – SC – SP – SE – TO description: Estados brasileiros: * `AC` – Acre * `AL` – Alagoas * `AP` – Amapá * `AM` – Amazonas * `BA` – Bahia * `CE` – Ceará * `DF` – Distrito Federal * `ES` – Espírito Santo * `GO` – Goiás * `MA` – Maranhão * `MT` – Mato Grosso * `MS` – Mato Grosso do Sul * `MG` – Minas Gerais * `PA` – Pará * `PB` – Paraíba * `PR` – Paraná * `PE` – Pernambuco * `PI` – Piauí * `RJ` – Rio de Janeiro * `RN` – Rio Grande do Norte * `RS` – Rio Grande do Sul * `RO` – Rondônia * `RR` – Roraima * `SC` – Santa Catarina * `SP` – São Paulo * `SE` – Sergipe * `TO` – Tocantins providerType: type: string enum: – CUSTOM – DR_OCUPACIONAL – GSO – LABORTEC – MED_NET – NEXO_CS – RS_DATA – SOC – SOFTWARE_SGG – TAP – SBOS – APOLLUS_EHS – PRO_CLINIC description: Lista de prestadores SST homologados pelo sistema Integrador SST: * `CUSTOM` – Prestadores customizados(não homologados) * `DR_OCUPACIONAL` – Prestador DR Ocupacional * `GSO` – Prestador GSO * `LABORTEC` – Prestador Labortec * `MED_NET` – Prestador MedNet * `NEXO_CS` – Nexo CS – EHS Software * `RS_DATA` – Prestador RSData * `SOC` – Prestador SOC * `SOFTWARE_SGG` – Prestador Software SGG * `TAP` – Prestador TAP * `SBOS` – Prestador SBOS * `APOLLUS_EHS` – Prestador Apollus EHS * `PRO_CLINIC` – Prestador ProClinic specialRetirementType: type: string enum: – DOES_NOT_HAVE_SPECIAL_RETIREMENT – NO_EXPOSURE_TO_HARMFUL_AGENTS_EMPLOYEE_ALREADY_EXPOSED – SPECIAL_RETIREMENT_AT_FIFTEEN_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_FIVE_YEARS_OF_SERVICE description: Tipo de aposentadoria especial: * `DOES_NOT_HAVE_SPECIAL_RETIREMENT` – Não possui aposentadoria especial * `NO_EXPOSURE_TO_HARMFUL_AGENTS_EMPLOYEE_ALREADY_EXPOSED` – Não exposição a agente nocivo. Trabalhador já esteve exposto * `SPECIAL_RETIREMENT_AT_FIFTEEN_YEARS_OF_SERVICE` – Aposentadoria especial aos 15 anos de serviço * `SPECIAL_RETIREMENT_AT_TWENTY_YEARS_OF_SERVICE` – Aposentadoria especial aos 20 anos de serviço * `SPECIAL_RETIREMENT_AT_TWENTY_FIVE_YEARS_OF_SERVICE` – Aposentadoria especial aos 25 anos de serviço workshiftScaleType: type: string enum: – FIRST_SHIFT – SECOND_SHIFT – THIRD_SHIFT – FOURTH_SHIFT – MIXED – GENERAL description: Turnos da Escala: * `FIRST_SHIFT` – Primeiro Turno * `SECOND_SHIFT` – Segundo Turno * `THIRD_SHIFT` – Terceiro Turno * `FOURTH_SHIFT` – Quarto Turno * `MIXED` – Misto * `GENERAL` – GERAL executionStatusType: type: string enum: – NOT_EXECUTED – EXECUTING – EXECUTED description: Status da execução: * `NOT_EXECUTED` – Não executado * `EXECUTING` – Executando * `EXECUTED` – Executado workEnvironmentType: type: string enum: – OWN_EMPLOYER – THIRD description: Tipo de ambiente de trabalho: * `OWN_EMPLOYER` – Estabelecimento do próprio empregador * `THIRD` – Estabelecimento de terceiros hireType: type: string enum: – Empty – FirstJob – Reemprego – TransferWithOnus – TransferWithoutOnus – Incorporation – Reintegration – Reconstruction – Reversal – Provisional – Request – Redistribution – Decentralized – Removal – Readaptation description: Tipo de admissão do colaborador: * `Empty` – Vazio * `FirstJob` – Primeiro Emprego * `Reemprego` – Reemprego * `TransferWithOnus` – Transferência com ônus * `TransferWithoutOnus` – Transferência sem ônus * `Incorporation` – Incorporação/Fusão/Cisão/Outros * `Reintegration` – Reintegração * `Reconstruction` – Recondução (Servidor Público) * `Reversal` – Reversão (Servidor Público) * `Provisional` – Provisório de servidor do mesmo órgão/entidade * `Request` – Requisição * `Redistribution` – Redistribuição (Servidor Público) * `Decentralized` – Descentralizado de servidor do mesmo órgão/entidade * `Removal` – Remoção (Servidor Público) * `Readaptation` – Readaptação (Servidor Público) transferReasonType: type: string enum: – TRANSFER_COMPANY – TRANSFER_COMPANY_BRANCH – NO_REASON_TRANSFER description: Tipo de transferência: * `TRANSFER_COMPANY` – Transferência de Empresa * `TRANSFER_COMPANY_BRANCH` – Transferência de Filial * `NO_REASON_TRANSFER` – Não É Causa de Transferência timeTrackingType: type: string enum: – TYPE_01_WORKING – TYPE_02_VACATION – TYPE_03_AID_DISEASE – TYPE_04_WORK_ACCIDENT – TYPE_05_MILITARY_SERVICE – TYPE_06_MATERNITY_LICENSE – TYPE_07_FIRED – TYPE_08_LICENSE_WITHOUT_PAY – TYPE_09_PAID_BY_COMPANY_LICENSE – TYPE_10_PAID_BY_EMPLOYEE_LICENSE – TYPE_11_PATERNITY_LICENSE – TYPE_12_COLLECTIVE_HOLIDAY – TYPE_13_NOTICE_WORKED – TYPE_14_MEDICAL_LICENSE_PAID_BY_COMPANY – TYPE_15_ABSENCES – TYPE_16_OVERTIME – TYPE_17_TIME_TRACKING – TYPE_18_READINESS – TYPE_19_MATERNITY_LICENSE_INSS – TYPE_20_ASSOCIATION_MANDATE – TYPE_21_USED_VACATION_TAKEN – TYPE_22_RETIREMENT – TYPE_23_WORK_ACCIDENT_LICENSE_PAID_BY_COMPANY – TYPE_24_CITIZEN_COMPANY_MATERNITY – TYPE_99_OTHER – TYPE_25_PROFESSIONAL_QUALIFICATION description: Tipos de afastamento: * `TYPE_01_WORKING` – Trabalhando * `TYPE_02_VACATION` – Férias * `TYPE_03_AID_DISEASE` – Auxílio Doença * `TYPE_04_WORK_ACCIDENT` – Acidente de Trabalho * `TYPE_05_MILITARY_SERVICE` – Serviço Militar * `TYPE_06_MATERNITY_LICENSE` – Licença Maternidade * `TYPE_07_FIRED` – Demitido * `TYPE_08_LICENSE_WITHOUT_PAY` – Licença sem remuneração * `TYPE_09_PAID_BY_COMPANY_LICENSE` – Licença remunerada pela empresa * `TYPE_10_PAID_BY_EMPLOYEE_LICENSE` – Licença remunerada pelo colaborador * `TYPE_11_PATERNITY_LICENSE` – Licença paternidade * `TYPE_12_COLLECTIVE_HOLIDAY` – Férias coletivas * `TYPE_13_NOTICE_WORKED` – Aviso prévio trabalhado * `TYPE_14_MEDICAL_LICENSE_PAID_BY_COMPANY` – Licença médica pago pela empresa * `TYPE_15_ABSENCES` – Faltas * `TYPE_16_OVERTIME` – Horas extras * `TYPE_17_TIME_TRACKING` – Apuração Ponto * `TYPE_18_READINESS` – Sobreaviso/Prontidão * `TYPE_19_MATERNITY_LICENSE_INSS` – Licença maternidade INSS * `TYPE_20_ASSOCIATION_MANDATE` – Mandato sindical * `TYPE_21_USED_VACATION_TAKEN` – Férias gozadas já adiantadas * `TYPE_22_RETIREMENT` – Aposentadoria * `TYPE_23_WORK_ACCIDENT_LICENSE_PAID_BY_COMPANY` – Licença acidente de trabalho pago pela empresa * `TYPE_24_CITIZEN_COMPANY_MATERNITY` – Maternidade empresa cidadã * `TYPE_99_OTHER` – Outros * `TYPE_25_PROFESSIONAL_QUALIFICATION` – Qualificação profissional initialLoadStatusType: type: string enum: – PENDING – IN_PROGRESS – COMPLETED – ERROR description: Status da carga inicial.: * `PENDING` – Pendente * `IN_PROGRESS` – Em processamento * `COMPLETED` – Finalizado * `ERROR` – Erro 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 autocompleteFilter: description: DTO com informações do lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro keyValue: description: Objeto chave valor para map type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status resultBaseData: description: Retorno base para os endpoints. discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. default: _discriminator: type: string description: resultIntegrationThirdSystem: description: Retorno para integração com sistemas de terceiros. allOf: – #/definitions/resultBaseData – type: object required: – integrationId properties: integrationId: type: string description: Id da pendencia de integração. enumInformationData: description: DTO de lista com as enumerações traduzidas. type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração. items: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Lista com os items das enumerações. enumInformationItemData: description: DTO de lista com os items das enumerações. type: object required: – key – value properties: key: type: string description: Chave do item da enumeração. value: type: string description: Valor traduzido do item da enumeração. configurationBranchSummary: description: Resumo da Configuração de Filial type: object properties: id: type: string description: Id da filial. name: type: string description: Nome da filial branchProviderIdentification: type: string description: Código de identificação da empresa no Prestador SST situation: type: boolean description: Situação pagination: description: Dados da paginação. type: object required: – current – size properties: current: type: integer format: int64 description: Página de início. size: type: integer format: int64 description: Quantidade de registros por página. orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenar por. ordination: description: Dados da ordenação. type: object required: – field properties: field: type: string description: Campo que será ordenado. direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação. integrationPendency: description: Dados da pendência de integração. type: object required: – id – integrationType properties: id: type: string description: Id da pendência. integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. statusType: type: string allOf: – #/definitions/statusType description: Status da pendência. fieldData: description: Dados do campo consultado. type: object required: – key – value properties: key: type: string description: Chave do campo. value: type: string description: Valor do campo. secondaryValue: type: string description: Valor secundário tertiaryValue: type: string description: Valor terciário fourthValue: type: string description: Valor quartário codeOfEmployeeCompanyAndBranch: type: string description: Código do colaborador, Empresa e Filial configurationProviderSummary: description: Resumo da configuração de prestador type: object required: – id – situation – providerName – providerType – configurationBranchSummary – configurationBranchNames – sendDeficiencies – sendAdditionalInformation – sendHistoricalCostCenter – sendHistoricalWorkstation – sendHistoricalDepartment – sendHistoricalJobposition – sendHistoricalWorkshift – sendHistoricalLeave – sendHistoricalWorkEnvironment – sendAdmissionExclusion – sendDismissalExclusion – sendHistoricExclusion properties: id: type: string description: Id do prestador situation: type: boolean description: Situação do prestador providerName: type: string description: Nome do prestador providerType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do prestador configurationBranchSummary: type: string description: Resumo das filiais configurationBranchNames: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Chave/Valor dos ids das filiais junto com o nome traduzido delas configurationBranchesSummary: type: array items: type: object allOf: – #/definitions/configurationBranchSummary description: Lista de configurações de filial companyProviderIdentification: type: string maxLength: 255 description: Código da identificação da empresa no prestador SST sendDeficiencies: type: boolean description: Envia deficiências sendAdditionalInformation: type: boolean description: Envia informações adicionais sendHistoricalCostCenter: type: boolean description: Envia Histórico de centro de custo sendHistoricalWorkstation: type: boolean description: Envia Histórico de posto de trabalho sendHistoricalDepartment: type: boolean description: Envia Histórico de Setor sendHistoricalJobposition: type: boolean description: Envia Histórico de Cargo sendHistoricalWorkshift: type: boolean description: Envia Histórico de Turno sendHistoricalLeave: type: boolean description: Envia Histórico de afastamento sendHistoricalWorkEnvironment: type: boolean description: Envia histórico de ambiente de trabalho employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. sendAdmissionExclusion: type: boolean description: Envia exclusão de admissão sendDismissalExclusion: type: boolean description: Envia exclusão de demissão (reintegração) sendHistoricExclusion: type: boolean description: Envia exclusão de histórico activeESocialCategories: type: array items: type: object allOf: – #/definitions/activeESocialCategorySummary description: Lista de categorias do eSocial e suas situações ativa/inativa para serem consideradas nas integrações configurationProviderOperation: description: Operação que será feita na tabela de prestadores type: object required: – configurationProvider – operationType properties: configurationProvider: type: object allOf: – #/definitions/configurationProvider description: Entidade de prestador com as alterações operationType: type: string allOf: – #/definitions/operationType description: Operação que será realizada configurationBranches: type: array items: type: object allOf: – #/definitions/configurationBranchOperation description: Lista de operações sobre as filiais desse prestador configurationBranchOperation: description: Operação que será feita na tabela de filiais type: object required: – configurationBranch – operationType properties: configurationBranch: type: object allOf: – #/definitions/configurationBranch description: Entidade de filial com as alterações operationType: type: string allOf: – #/definitions/operationType description: Operação que será realizada keyValuePairBoolean: description: Chave/Valor com o valor sendo booleano type: object required: – key – value properties: key: type: string description: Chave value: type: boolean description: Valor keyValuePairString: description: Chave/Valor ambos sendo String type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor pendencyFilters: description: Filtro da consulta de pendências de integração type: object properties: statusType: type: array items: type: string allOf: – #/definitions/statusType description: Lista de tipos de status de integração. companyBranchCode: type: array items: type: object allOf: – #/definitions/keyValuePairString description: Lista de códigos de Filiais. companyName: type: array items: type: string description: Lista de nomes de empresas. companyCode: type: array items: type: string description: Lista de códigos de Empresa cpfNumber: type: array items: type: string description: Lista de números de CPF. employeeName: type: array items: type: object allOf: – #/definitions/keyValuePairString description: Lista de nomes de Colaboradores employeeCode: type: array items: type: string description: Lista o código dos Colaboradores integrationType: type: array items: type: string allOf: – #/definitions/integrationType description: Lista de tipos de integração. messageFromIntegrationOrCancelationReason: type: string description: Mensagem de integração ou cancelamento providerName: type: array items: type: string description: Lista de nomes de prestadores SST providerType: type: array items: type: string allOf: – #/definitions/providerType description: Lista de prestadores SST homologados pelo sistema Integrador SST receiptDate: type: object allOf: – #/definitions/dateTimeRange description: Recebimento de pendência contendo data de inicio e fim sendDate: type: object allOf: – #/definitions/dateTimeRange description: Envio de pendência contendo data de inicio e fim mandatoryStatusType: type: string description: Status mandatório ids: type: array items: type: string description: Lista de ids de pendências dateTimeRange: description: Range/Período entre datas, contendo início e fim type: object properties: start: type: string description: Data de início end: type: string description: Data de fim activeESocialCategorySummary: description: Situação da categoria do eSocial sendo ativa ou inativa para integração. type: object required: – id – code – situation properties: id: type: string description: Id da categoria eSocial. code: type: string allOf: – #/definitions/eSocialCategoryType description: Chave da categoria eSocial. situation: type: boolean description: Situação da categoria ativa ou inativa para integração configurationToValidateInitialLoad: description: DTO de informações necessárias para validar Carga Inicial type: object required: – branchName – providerType – providerName – companyProviderIdentification properties: branchName: type: string description: Nome da Filial a ser validada(Carga Inicial) providerType: type: string allOf: – #/definitions/providerType description: Sistema prestador SST providerName: type: string description: Nome prestador SST companyProviderIdentification: type: string description: Código da identificação da empresa no prestador SST employeeIntegrationStartDate: type: string format: date description: Considerar colaboradores admitidos a partir de initialLoadProviderBranchRequestId: type: string description: ID da Request de carga inicial por prestador e filial. configurationBranchChangeDetector: description: DTO contendo o código da filial e código da filial no prestador SST para comparação de mudanças type: object properties: branchCode: type: string description: Código da filial branchProviderIdentification: type: string description: Código de identificação da filial no prestador SST configurationBranchProviderIdentification: description: DTO de informações de configurações da filial no prestador SST type: object required: – subscriptionNumber properties: branchProviderIdentification: type: string description: Código de identificação da filial no prestador SST subscriptionNumber: type: string description: CNPJ da filial initialLoadBranchStatusResult: description: DTO de retorno da consulta do status da carga inicial por filial. type: object required: – companyBranchId – status properties: companyBranchId: type: string description: ID da filial. status: type: string allOf: – #/definitions/initialLoadStatusType description: Status da carga inicial. startDate: type: string format: date-time description: Data e hora de início da carga inicial. finishDate: type: string format: date-time description: Data e hora de fim da carga inicial. companySetting: description: Configuração da integração por empresa. type: object required: – companyIdentification – companyName – situation properties: id: type: string format: uuid description: Id da entidade. companyIdentification: type: string description: Identificação da empresa. companyName: type: string description: Nome da empresa. providerCompanyIdentification: type: string description: Identificação da empresa no prestador SST. situation: type: boolean description: Situação da configuração (Ligada ou companySettingDesligada). branchIntegrations: type: array items: type: object allOf: – #/definitions/branchIntegration description: Filiais permitidas para a integração. employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. activeESocialCategories: type: array items: type: object allOf: – #/definitions/activeSingleProviderESocialCategory description: Lista de categorias do eSocial consideradas na integração. editCompanySetting: type: object required: – id allOf: – #/definitions/companySetting configurationCompany: description: Configuração de empresa type: object required: – companyIdentification – companyName properties: id: type: string format: uuid description: Id da entidade companyIdentification: type: string maxLength: 255 description: Código da empresa companyName: type: string maxLength: 255 description: Nome da empresa configurationProvider: type: array items: type: object allOf: – #/definitions/configurationProvider description: Prestadores SST backupRegistrationRangeStart: type: integer format: int64 description: Início da faixa de cadastros de backup backupRegistrationRangeEnd: type: integer format: int64 description: Fim da faixa de cadastros de backup editConfigurationCompany: type: object required: – id allOf: – #/definitions/configurationCompany configurationProvider: description: Configuração do Prestador SST por empresa type: object required: – providerName – providerType – situation – sendDeficiencies – sendAdditionalInformation – sendHistoricalCostCenter – sendHistoricalWorkstation – sendHistoricalDepartment – sendHistoricalJobposition – sendHistoricalWorkshift – sendHistoricalLeave properties: id: type: string format: uuid description: Id da entidade providerName: type: string maxLength: 255 description: Nome prestador SST providerType: type: string allOf: – #/definitions/providerType description: Sistema prestador SST situation: type: boolean description: Situação companyProviderIdentification: type: string maxLength: 255 description: Código da identificação da empresa no prestador SST configurationCompanyId: type: object allOf: – #/definitions/configurationCompany description: Relacionamento com a empresa sendDeficiencies: type: boolean description: Envia deficiências sendAdditionalInformation: type: boolean description: Envia informações adicionais sendHistoricalCostCenter: type: boolean description: Envia Histórico de centro de custo sendHistoricalWorkstation: type: boolean description: Envia Histórico de posto de trabalho sendHistoricalDepartment: type: boolean description: Envia Histórico de Setor sendHistoricalJobposition: type: boolean description: Envia Histórico de Cargo sendHistoricalWorkshift: type: boolean description: Envia Histórico de Turno sendHistoricalLeave: type: boolean description: Envia Histórico de afastamento sendHistoricalWorkEnvironment: type: boolean description: Envia histórico de ambiente de trabalho configurationBranch: type: array items: type: object allOf: – #/definitions/configurationBranch description: Lista de configuração por filial configurationUserNotification: type: array items: type: object allOf: – #/definitions/configurationUserNotification description: Lista de usuários que serão notificados em caso de falha employeeIntegrationStartDate: type: string format: date description: Considerar pendências de admissão a partir de. activeESocialCategories: type: array items: type: object allOf: – #/definitions/activeESocialCategory description: Lista de categorias do eSocial consideradas na integração. sendAdmissionExclusion: type: boolean description: Envia exclusão de admissão default: true sendDismissalExclusion: type: boolean description: Envia exclusão de demissão (reintegração) default: false sendHistoricExclusion: type: boolean description: Envia exclusão de histórico default: false editConfigurationProvider: type: object required: – id allOf: – #/definitions/configurationProvider configurationBranch: description: Configuração do prestador SST por filial type: object required: – branchCode – branchName – situation properties: id: type: string format: uuid description: Id da entidade subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição subscriptionNumber: type: string description: Número de inscrição branchCode: type: string description: Código da filial branchName: type: string description: Nome da filial configurationProviderId: type: object allOf: – #/definitions/configurationProvider description: Relacionamento com a configuração do prestador branchProviderIdentification: type: string description: Código de identificação da empresa no Prestador SST situation: type: boolean description: Situação shortBranchName: type: string maxLength: 255 description: Apelido da filial editConfigurationBranch: type: object required: – id allOf: – #/definitions/configurationBranch configurationUserNotification: description: Configuração de usuários para recebimento de notificação em caso de falha na integração type: object required: – notificationUser properties: id: type: string format: uuid description: Id da entidade notificationUser: type: string description: Usuário a ser notificado configurationProviderId: type: object allOf: – #/definitions/configurationProvider description: Relacionamento com a configuração do prestador editConfigurationUserNotification: type: object required: – id allOf: – #/definitions/configurationUserNotification branchIntegration: description: Filiais da integração type: object required: – subscriptionType – subscriptionNumber properties: id: type: string format: uuid description: Id da entidade. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo da inscrição. subscriptionNumber: type: string description: Numero da inscrição. companySetting: type: object allOf: – #/definitions/companySetting description: Id da configuração da integração da empresa. editBranchIntegration: type: object required: – id allOf: – #/definitions/branchIntegration integration: description: Controle de integrações. type: object required: – externalId – operationType – statusType – integrationType – receiptDate – lotWorkstation properties: id: type: string format: uuid description: Id da entidade. externalId: type: string maxLength: 36 description: Id do colaborador no Payroll. externalHistoricId: type: string maxLength: 36 description: Id de histórico do colaborador no Payroll. operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação employee: type: object allOf: – #/definitions/employee description: Colaborador da integração. statusType: type: string allOf: – #/definitions/statusType description: Tipo do status de integração. integrationType: type: string allOf: – #/definitions/integrationType description: Tipo da integração. receiptDate: type: string format: date-time description: Data e hora do recebimento do colaborador. sendDate: type: string format: date-time description: Data e hora do envio para o provedor SST. scheduledDate: type: string format: date description: Data de agendamento para envio da pendencia. dateWhen: type: string format: date description: Data do histórico gerado. integrationMessage: type: string description: Mensagem da integração. stackTrace: type: string description: StackTrace do erro. companyCode: type: integer format: int64 description: Código da empresa. companyName: type: string description: Nome da empresa. companyBranchCode: type: integer format: int64 description: Código da filial. companyBranchName: type: string description: Razão social. branchName: type: string description: Nome da filial. employeeCode: type: integer format: int64 description: Código do colaborador. eSocialRegistration: type: string maxLength: 30 description: Matrícula do e-Social. cpfNumber: type: string description: Número do CPF. employeeName: type: string description: Nome do colaborador. providerCompanyIdentification: type: string description: Identificação da empresa no prestador SST. providerEmployeeIdentification: type: string description: Identificação única do colaborador no sistema do prestador SST providerPreviousEmployeeIdentification: type: string description: Identificação única anterior do colaborador no sistema do prestador SST integrationSequence: type: integer format: int64 description: Identificação da empresa no prestador SST. cancelationReason: type: string description: Motivo cancelamento. previewSendDate: type: string format: date-time description: Data prevista para envio lotWorkstation: type: string description: Lote do histórico de posto de trabalho changes: type: string maxLength: 4000 description: Mudanças em relação a última integração externalSystem: type: string description: Sistema terceiro integrationOrigin: type: string maxLength: 36 description: Pendência de integração de origem providerType: type: string allOf: – #/definitions/providerType description: Prestador para o qual a pendencia foi enviada providerName: type: string description: Nome do prestador SST regenerateAttempts: type: integer format: int64 description: Número de tentativas de regerar a pendência referenceDate: type: string format: date description: Data de referência das informações básicas do colaborador. providerPreviousCompanyIdentification: type: string description: Identificação da empresa anterior do colaborador no prestador SST. cpfChange: type: boolean description: Foi feita uma mudança no número de cpf do colaborador. default: false regeneratedByUser: type: boolean description: Essa pendência foi regerada pelo usuário. default: false integrationErrorCode: type: string maxLength: 20 description: Código de identificação da mensagem de erro. classification: type: integer format: int64 description: Classificação para processamento da pendência. resendScheduledErrorAttempts: type: integer format: int64 description: Número de tentativas de reenvio automático de pendências integrationNote: type: string description: Nota sobre a pendência previousProviderType: type: string allOf: – #/definitions/providerType description: Prestador anterior para o qual a pendencia foi enviada previousProviderName: type: string description: Nome do prestador SST anterior para o qual a pendencia foi enviada providerAttempts: type: integer format: int64 description: Número de tentativas de envio da pendência ao prestador SST editIntegration: type: object required: – id allOf: – #/definitions/integration employee: description: Colaborador. type: object required: – externalId – situationType – company – companyBranch properties: id: type: string format: uuid description: Id interno do colaborador. externalId: type: string maxLength: 36 description: Id externo do colaborador (no Payroll). employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. code: type: integer format: int64 description: Código do colaborador. eSocialRegistration: type: string maxLength: 30 description: Matrícula do e-Social. name: type: string description: Nome do colaborador. socialName: type: string description: Nome social cpfNumber: type: string description: Número do CPF. nisNumber: type: string maxLength: 11 description: Número do NIS. birthday: type: string format: date description: Data de nascimento. hireDate: type: string format: date description: Data de admissão. maritalStatusType: type: string allOf: – #/definitions/maritalStatusType description: Estado civil. genderType: type: string allOf: – #/definitions/genderType description: Gênero do colaborador. situationType: type: string allOf: – #/definitions/situationType description: Situação do colaborador. contractType: type: string allOf: – #/definitions/contractType description: Tipo do contrato. eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria do colaborador no e-Social. isDeficient: type: boolean description: Colaborador é deficiente? company: type: object allOf: – #/definitions/company description: Empresa do colaborador. companyBranch: type: object allOf: – #/definitions/companyBranch description: Filial do colaborador. costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo. department: type: object allOf: – #/definitions/department description: Local / Setor do colaborador. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo do colaborador. shift: type: object allOf: – #/definitions/shift description: Turno do colaborador. workstation: type: object allOf: – #/definitions/workstation description: Posto de trabalho. reasonLeave: type: object allOf: – #/definitions/reasonLeave description: Motivo do afastamento. deficiencies: type: array items: type: object allOf: – #/definitions/deficiency description: Deficiência do colaborador. dismissalDate: type: string format: date description: Data de demissão. ctpsNumber: type: string description: Número da carteira de trabalho ctpsSerie: type: string maxLength: 5 description: Série da carteira de trabalho ctpsIssuanceDate: type: string format: date description: Data de emissão da carteira de trabalho ctpsSerieDigit: type: string maxLength: 5 description: Digito da carteira de trabalho ctpsState: type: string allOf: – #/definitions/state description: Estado da carteira de trabalho rgNumber: type: string description: Carteira de identidade rgIssuer: type: string description: Orgão emissor da carteira de identidade rgState: type: string allOf: – #/definitions/state description: Estado da carteira de identidade rgIssuanceDate: type: string format: date description: Data de emissão da carteira de identidade numberContractSameHireDate: type: integer format: int64 description: Número de contratos do colaborador previousCompany: type: object allOf: – #/definitions/company description: Empresa anterior do colaborador. previousCompanyBranch: type: object allOf: – #/definitions/companyBranch description: Filial anterior do colaborador. salaryPremium: type: object allOf: – #/definitions/salaryPremium description: Adicionais no salário do colaborador previousEmployeeType: type: string allOf: – #/definitions/employeeType description: Tipo anterior do colaborador previousCode: type: integer format: int64 description: Código anterior do colaborador workEnvironment: type: object allOf: – #/definitions/workEnvironment description: Ambiente de trabalho do colaborador hireType: type: string allOf: – #/definitions/hireType description: Tipo de admissão reintegrationCompanyOrigin: type: object allOf: – #/definitions/company description: Empresa origem da reintegração do colaborador reintegrationEmployeeTypeOrigin: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador origem da reintegração reintegrationCodeOrigin: type: integer format: int64 description: Código origem da reintegração do colaborador editEmployee: type: object required: – id allOf: – #/definitions/employee company: description: Empresa. type: object required: – code – name properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da empresa. name: type: string description: Nome da empresa. editCompany: type: object required: – id allOf: – #/definitions/company companyBranch: description: Filial da empresa. type: object required: – code – name – subscriptionType – subscriptionNumber – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da filial. name: type: string description: Razão social da filial. companyBranchName: type: string description: Nome da filial. subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Inscrição da filial. subscriptionNumber: type: string maxLength: 14 description: Número da inscrição. dateWhen: type: string format: date description: Data do histórico da filial (A partir de). editCompanyBranch: type: object required: – id allOf: – #/definitions/companyBranch deficiency: description: Deficiência do colaborador. type: object required: – code – name – isMainDeficiency – deficiencyType – dateWhen – isRehabilitated properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código da deficiência. name: type: string description: Nome da deficiência. isMainDeficiency: type: boolean description: É a deficiência principal? deficiencyType: type: string allOf: – #/definitions/deficiencyType description: Tipo da deficiência no e-Social. dateWhen: type: string format: date description: Data de início da deficiência. isRehabilitated: type: boolean description: Reabilitado. employee: type: object allOf: – #/definitions/employee description: Colaborador. editDeficiency: type: object required: – id allOf: – #/definitions/deficiency eSocialCategory: description: Categoria eSocial. type: object required: – code – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string allOf: – #/definitions/eSocialCategoryType description: Chave da categoria eSocial. dateWhen: type: string format: date description: Data do histórico da categoria eSocial (A partir de). editESocialCategory: type: object required: – id allOf: – #/definitions/eSocialCategory workstation: description: Posto de trabalho. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do posto de trabalho. structureCode: type: integer format: int64 description: Estrutura do posto de trabalho. name: type: string description: Nome do posto de trabalho. dateWhen: type: string format: date description: Data do histórico do posto de trabalho (A partir de). editWorkstation: type: object required: – id allOf: – #/definitions/workstation shift: description: Turno do colaborador. type: object required: – code – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código do turno. name: type: string description: Nome do turno. dateWhen: type: string format: date description: Data do histórico da Turno (A partir de). workshiftScaleType: type: string allOf: – #/definitions/workshiftScaleType description: Turno da escala editShift: type: object required: – id allOf: – #/definitions/shift jobPosition: description: Cargo do colaborador. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do cargo. structureCode: type: string description: Código da estrutura do cargo cboCode: type: string description: Código do CBO do cargo. name: type: string description: Nome do cargo. dateWhen: type: string format: date description: Data do histórico de Cargo (A partir de). editJobPosition: type: object required: – id allOf: – #/definitions/jobPosition department: description: Local do colaborador. type: object required: – code – structureCode – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do local. structureCode: type: integer format: int64 description: Código de organograma do local. name: type: string description: Nome do local. dateWhen: type: string format: date description: Data do histórico do Setor (A partir de). editDepartment: type: object required: – id allOf: – #/definitions/department costCenter: description: Centro de custo do colaborador. type: object required: – code – name – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. code: type: string description: Código do centro de custo. name: type: string description: Nome do centro de custo. dateWhen: type: string format: date description: Data do histórico do centro de custo (A partir de). editCostCenter: type: object required: – id allOf: – #/definitions/costCenter reasonLeave: description: Motivo do afastamento. type: object required: – code – name – startDate properties: id: type: string format: uuid description: Id interno da entidade. code: type: integer format: int64 description: Código do motivo. name: type: string description: Nome do motivo. startDate: type: string format: date-time description: Data de início do afastamento. estimatedEndDate: type: string format: date description: Data de previsão de término do afastamento. endDate: type: string format: date-time description: Data de término do afastamento. transferReasonType: type: string allOf: – #/definitions/transferReasonType description: Tipo de transferência timeTrackingType: type: string allOf: – #/definitions/timeTrackingType description: Tipo de afastamento editReasonLeave: type: object required: – id allOf: – #/definitions/reasonLeave salaryPremium: description: Adicionais no salário do colaborador type: object required: – dateWhen – specialRetirementType properties: id: type: string format: uuid description: Id interno da entidade. dateWhen: type: string format: date description: Data de inicio endDate: type: string format: date description: Data fim insalubrity: type: number format: double description: Insalubridade hazard: type: number format: double description: Periculosidade lengthOfService: type: number format: double description: Fator tempo de serviço specialRetirementType: type: string allOf: – #/definitions/specialRetirementType description: Aposentadoria especial editSalaryPremium: type: object required: – id allOf: – #/definitions/salaryPremium generalConfiguration: description: Configurações gerais type: object properties: id: type: string format: uuid description: Id interno da entidade. generatePendencies: type: boolean description: Geração de pendência de integração processingInitialLoad: type: boolean description: Processando carga inicial configurationMode: type: string allOf: – #/definitions/configurationMode description: Modo de cofiguração contractsCorrection: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de correção de contratos workingEmployeeDataCorrection: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de correção de dados de colaboradores trabalhando dismissedEmployeeDataCorrection: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de correção de dados de colaboradores demitidos cleanUpFeature: type: boolean description: Flag que indica se a rotina que deleta registros inúteis da base está ativa. cleanUpLock: type: boolean description: Flag que indica se a rotina que deleta registros inúteis da base está sendo executada. incorrectlyReactivatedFiredEmployeeCorrection: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de correção de colaboradores demitidos reativados indevidamente no prestador SST resendPendencyExclusionAdmissionProvider: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de reenvio de pendências de exclusão de admissão do colaborador que não tenham sido enviadas ao prestador historicalJobPositionDataCorrection: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de correção de dados do histórico de cargo do colaborador cleanUpLastExecutionTime: type: string format: date-time description: Data e hora da última execução da rotina CleanUpTask. eSocialCategoriesMigration: type: string allOf: – #/definitions/executionStatusType description: Status da execução da rotina de migração dos tipos de categoria do eSocial editGeneralConfiguration: type: object required: – id allOf: – #/definitions/generalConfiguration activeSingleProviderESocialCategory: description: Categoria do eSocial ativa para integração no modo de configuração de único prestador. type: object required: – code properties: id: type: string format: uuid description: Id interno da entidade code: type: string allOf: – #/definitions/eSocialCategoryType description: Chave da categoria eSocial. companySetting: type: object allOf: – #/definitions/companySetting description: Relação com a configuração de empresa. editActiveSingleProviderESocialCategory: type: object required: – id allOf: – #/definitions/activeSingleProviderESocialCategory activeESocialCategory: description: Categoria do eSocial ativa para integração. type: object required: – code properties: id: type: string format: uuid description: Id interno da entidade code: type: string allOf: – #/definitions/eSocialCategoryType description: Chave da categoria eSocial. configurationProvider: type: object allOf: – #/definitions/configurationProvider description: Relação com a configuração de prestador SST. situation: type: boolean description: Situação da categoria ativa ou inativa para integração default: true editActiveESocialCategory: type: object required: – id allOf: – #/definitions/activeESocialCategory workEnvironment: description: Ambiente de trabalho do colaborador type: object required: – location – code – name – subscriptionType – subscriptionNumber – dateWhen properties: id: type: string format: uuid description: Id interno da entidade. location: type: string allOf: – #/definitions/workEnvironmentType description: Local de trabalho code: type: string description: Código do ambiente de trabalho name: type: string description: Nome do ambiente de trabalho subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição subscriptionNumber: type: string maxLength: 14 description: Número de inscrição. dateWhen: type: string format: date description: Data do histórico de ambiente de trabalho (A partir de) editWorkEnvironment: type: object required: – id allOf: – #/definitions/workEnvironment initialLoadProviderRequest: description: Request de carga inicial por prestador. type: object required: – configurationProviderId – configurationCompanyId – startDate – status properties: id: type: string format: uuid description: Id interno da entidade. configurationProviderId: type: string format: uuid description: Relacionamento com a configuração do prestador. configurationCompanyId: type: string format: uuid description: Relacionamento com a empresa. username: type: string description: Username do usuário que solicitou a carga inicial. startDate: type: string format: date-time description: Data e hora de início da carga inicial. status: type: string allOf: – #/definitions/initialLoadStatusType description: Status da carga inicial. finishDate: type: string format: date-time description: Data e hora de fim da carga inicial. errorMessage: type: string description: Mensagem de erro. editInitialLoadProviderRequest: type: object required: – id allOf: – #/definitions/initialLoadProviderRequest initialLoadProviderBranchRequest: description: Request de carga inicial por prestador e filial. type: object required: – initialLoadProviderRequestId – configurationBranchId – activateBranchIntegration – status properties: id: type: string format: uuid description: Id interno da entidade. initialLoadProviderRequestId: type: object allOf: – #/definitions/initialLoadProviderRequest description: Relacionamento com o request de carga inicial por prestador. configurationBranchId: type: string format: uuid description: Relacionamento com a filial da empresa. activateBranchIntegration: type: boolean description: Ativar a integração da filial status: type: string allOf: – #/definitions/initialLoadStatusType description: Status da carga inicial. startDate: type: string format: date-time description: Data e hora de início da carga inicial. finishDate: type: string format: date-time description: Data e hora de fim da carga inicial. errorMessage: type: string description: Mensagem de erro. editInitialLoadProviderBranchRequest: type: object required: – id allOf: – #/definitions/initialLoadProviderBranchRequest 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação