HCM – Esocial Manager General (general)

2.0info: 1.2.0 HCM – Esocial Manager General description: HCM – Esocial Manager General x-senior-domain: HCM – Esocial Manager General x-senior-domain-path: hcm_esocial_manager x-senior-service-path: general contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_esocial_managersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/listLayouts: post: description: Lista as informações dos leiautes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/filterLayoutStatus responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/layoutStatusDTO minimum: 1 description: DTO de informações do leiaute totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as informações dos leiautes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: layout description: Leiaute in: query type: integer format: int64 – name: status description: Status do leiaute in: query type: string allOf: – #/definitions/statusLayoutType – name: identifier description: Identificador do leiaute in: query type: string – name: environmentType description: Tipo de ambiente in: query type: string allOf: – #/definitions/environmentType – name: startReferenceDate description: Data início de referência in: query type: string format: date – name: endReferenceDate description: Data fim de referência in: query type: string format: date – name: startCreateDate description: Data início de criação in: query type: string format: date-time – name: endCreateDate description: Data fim de criação in: query type: string format: date-time – name: resume description: Resumo do leiaute in: query type: string – name: company description: Empresa in: query type: string – name: employee description: Colaborador in: query type: string – name: size description: Tamanho da página in: query type: integer format: int64 – name: offset description: Página in: query type: integer format: int64 – name: ordination description: Ordenação dos leiautes in: query type: string allOf: – #/definitions/enumLayoutOrdination responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/layoutStatusDTO minimum: 1 description: DTO de informações do leiaute totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getLayoutDetail: post: description: Lista os detalhes do leiaute tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutId properties: layoutId: type: string description: Identificador do leiaute responses: 200: description: Ok schema: type: object properties: layoutDetailDTO: type: object allOf: – #/definitions/layoutDetailDTO description: DTO de detalhes do leiaute 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os detalhes do leiaute tags: – Queries x-senior-visibility: PRIVATE parameters: – name: layoutId description: Identificador do leiaute in: query required: true type: string responses: 200: description: Ok schema: type: object properties: layoutDetailDTO: type: object allOf: – #/definitions/layoutDetailDTO description: DTO de detalhes do leiaute 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getLayoutStatusXmlApiTest: post: description: Retorna o XML e o JSON a partir das informações do leiaute (layoutStatus) para os testes de API tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filterLayoutStatus properties: filterLayoutStatus: type: object allOf: – #/definitions/filterLayoutStatus description: Filtro para busca do XML responses: 200: description: Ok schema: type: object properties: layoutStatusId: type: string description: Identificador único das informações do leiaute xml: type: string description: XML gerado importation: type: string description: Dados em formato JSON 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportESocialDefinition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportESocialDefinitionAutoSend: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportLayoutStatus: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportLayoutReturn: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEDocsDefinition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEDocsDefinitionCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteLayoutStatusApiTest: post: description: Excluí a tabela de informações do leiaute (layoutStatus) para os testes de API tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutStatusId properties: layoutStatusId: type: string maxLength: 36 description: Identificador único das informações do leiaute responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importESocialDefinition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importESocialDefinitionAutoSend: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importLayoutStatus: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importLayoutReturn: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEDocsDefinition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importEDocsDefinitionCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/events/importESocialDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportESocialDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importESocialDefinitionAutoSendEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportESocialDefinitionAutoSendEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importLayoutStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportLayoutStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importLayoutReturnEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportLayoutReturnEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEDocsDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEDocsDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importEDocsDefinitionCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEDocsDefinitionCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/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 /general/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 /general/entities/eSocialDefinition: 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/eSocialDefinition responses: 200: description: The created resource schema: #/definitions/eSocialDefinition 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/eSocialDefinition responses: 200: description: The created resource schema: #/definitions/eSocialDefinition 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/eSocialDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialDefinition/{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/editESocialDefinition responses: 200: description: Ok schema: #/definitions/editESocialDefinition 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/eSocialDefinition responses: 200: description: Ok schema: #/definitions/eSocialDefinition 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/eSocialDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialDefinition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialDefinitionAutoSend: 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/eSocialDefinitionAutoSend responses: 200: description: The created resource schema: #/definitions/eSocialDefinitionAutoSend 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/eSocialDefinitionAutoSend responses: 200: description: The created resource schema: #/definitions/eSocialDefinitionAutoSend 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/eSocialDefinitionAutoSend 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialDefinitionAutoSend/{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/editESocialDefinitionAutoSend responses: 200: description: Ok schema: #/definitions/editESocialDefinitionAutoSend 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/eSocialDefinitionAutoSend responses: 200: description: Ok schema: #/definitions/eSocialDefinitionAutoSend 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/eSocialDefinitionAutoSend 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eSocialDefinitionAutoSend/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eSocialDefinitionAutoSend responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinition: 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/eDocsDefinition responses: 200: description: The created resource schema: #/definitions/eDocsDefinition 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/eDocsDefinition responses: 200: description: The created resource schema: #/definitions/eDocsDefinition 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/eDocsDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinition/{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/editEDocsDefinition responses: 200: description: Ok schema: #/definitions/editEDocsDefinition 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/eDocsDefinition responses: 200: description: Ok schema: #/definitions/eDocsDefinition 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/eDocsDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eDocsDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinitionCompany: 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/eDocsDefinitionCompany responses: 200: description: The created resource schema: #/definitions/eDocsDefinitionCompany 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/eDocsDefinitionCompany responses: 200: description: The created resource schema: #/definitions/eDocsDefinitionCompany 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/eDocsDefinitionCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinitionCompany/{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/editEDocsDefinitionCompany responses: 200: description: Ok schema: #/definitions/editEDocsDefinitionCompany 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/eDocsDefinitionCompany responses: 200: description: Ok schema: #/definitions/eDocsDefinitionCompany 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/eDocsDefinitionCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/eDocsDefinitionCompany/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eDocsDefinitionCompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: statusLayoutType: type: string enum: – WAITING_MANUAL_SUBMISSION – WAITING_AUTOMATIC_SUBMISSION – EDOC_ERROR – SENDING_TO_GOVERNMENT – WAITING_GOVERNMENT_RETURN – MESSAGE_RETURNED – RECEIPT_RETURNED – RECEIPT_MANUAL – EVENT_DELETED – EVENT_CANCELED description: Status do leiaute (Criado na lib hcm-esocialcommons): * `WAITING_MANUAL_SUBMISSION` – Aguardando envio manual * `WAITING_AUTOMATIC_SUBMISSION` – Aguardando envio automático * `EDOC_ERROR` – Erro no mensageiro do evento * `SENDING_TO_GOVERNMENT` – Enviando evento para o governo * `WAITING_GOVERNMENT_RETURN` – Aguardando retorno * `MESSAGE_RETURNED` – Mensagem retornada do governo * `RECEIPT_RETURNED` – Recibo retornado com sucesso * `RECEIPT_MANUAL` – Recibo informado manualmente * `EVENT_DELETED` – Erro tratado (evento excluído) * `EVENT_CANCELED` – Evento cancelado environmentType: type: string enum: – PRODUCTION – RESTRICTED_PRODUCTION description: Tipo de ambiente (Criado na lib hcm-esocialcommons): * `PRODUCTION` – Produção * `RESTRICTED_PRODUCTION` – Produção restrita eSocialGroup: type: string enum: – G1 – G2 – G3 – G4 description: Grupo de Entrada: * `G1` – Grandes Empresas * `G2` – Empresas Não Optantes Simples Nacional * `G3` – Empresas Sem Fins Lucrativos ou Optantes Simples Nacional * `G4` – Orgãos Públicos Federal Organizações Internacionais statusEventType: type: string enum: – PROCESSING – WAITING_GOVERNMENT_RETURN – GOVERNMENT_RETURN – ERROR – MANUAL_RECEIPT description: Status do evento do eSocial: * `PROCESSING` – Processando * `WAITING_GOVERNMENT_RETURN` – Aguardando retorno * `GOVERNMENT_RETURN` – Retorno do governo * `ERROR` – Erro * `MANUAL_RECEIPT` – Informado manualmente governmentReturnType: type: string enum: – RECEIPT_RETURNED – MESSAGE_RETURNED description: Tipo de retorno do governo: * `RECEIPT_RETURNED` – Número do recibo retornado * `MESSAGE_RETURNED` – Mensagem retornada rectificationType: type: string enum: – ORIGINAL – RECTIFICATION description: Tipo de retificação (Criado na lib hcm-esocialcommons): * `ORIGINAL` – Original * `RECTIFICATION` – Retificação inscriptionType: type: string enum: – CNPJ – CPF – CAEPF – CNO description: Tipo de incrição (Criado na lib hcm-esocialcommons): * `CNPJ` – CNPJ * `CPF` – CPF * `CAEPF` – CAEPF (Cadastro de Atividade Econômica de Pessoa Física) * `CNO` – CNO (Cadastro Nacional de Obra) enumLayoutOrdination: type: string enum: – COMPANY_ASC – COMPANY_DESC – LAYOUT_ASC – LAYOUT_DESC – DATE_REFERENCE_ASC – DATE_REFERENCE_DESC – DATE_CREATE_ASC – DATE_CREATE_DESC – EMPLOYEE_ASC – EMPLOYEE_DESC – STATUS_ASC – STATUS_DESC – IDENTIFIER_ASC – IDENTIFIER_DESC description: Ordenação dos leiautes: * `COMPANY_ASC` – Empresa crescente * `COMPANY_DESC` – Empresa decrescente * `LAYOUT_ASC` – Leiaute crescente * `LAYOUT_DESC` – Leiaute decrescente * `DATE_REFERENCE_ASC` – Data de referência crescente * `DATE_REFERENCE_DESC` – Data de referência decrescente * `DATE_CREATE_ASC` – Data de criação crescente * `DATE_CREATE_DESC` – Data de criação decrescente * `EMPLOYEE_ASC` – Colaborador crescente * `EMPLOYEE_DESC` – Colaborador decrescente * `STATUS_ASC` – Situação crescente * `STATUS_DESC` – Situação decrescente * `IDENTIFIER_ASC` – Identificador do leiaute crescente * `IDENTIFIER_DESC` – Identificador do leiaute decrescente 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim companyDTO: description: DTO de empresa type: object required: – code – name properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 name: type: string maxLength: 100 description: Nome da empresa employeeDTO: description: DTO de colaborador type: object required: – code – name properties: id: type: string description: Identificador único code: type: integer format: int64 description: Cadastro name: type: string maxLength: 100 description: Nome companyRegistrationDTO: description: DTO do registro da empresa type: object properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 name: type: string maxLength: 100 description: Nome da empresa registrationType: type: string allOf: – #/definitions/inscriptionType description: Tipo de inscrição registration: type: string description: Inscrição employeeRegistrationDTO: description: DTO do registro do colaborador type: object properties: id: type: string description: Identificador único code: type: integer format: int64 description: Cadastro name: type: string maxLength: 100 description: Nome employeeRegistration: type: string description: Tipo de inscrição eSocialRegistration: type: string description: Inscrição filterLayoutStatus: description: Filtro sobre a lista de informações dos leiautes type: object properties: layout: type: integer format: int64 description: Leiaute status: type: string allOf: – #/definitions/statusLayoutType description: Status do leiaute identifier: type: string description: Identificador do leiaute environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente startReferenceDate: type: string format: date description: Data início de referência endReferenceDate: type: string format: date description: Data fim de referência startCreateDate: type: string format: date-time description: Data início de criação endCreateDate: type: string format: date-time description: Data fim de criação resume: type: string description: Resumo do leiaute company: type: string description: Empresa employee: type: string description: Colaborador size: type: integer format: int64 description: Tamanho da página minimum: 10 maximum: 100 default: 10 offset: type: integer format: int64 description: Página minimum: 0 default: 0 ordination: type: string allOf: – #/definitions/enumLayoutOrdination description: Ordenação dos leiautes layoutStatusDTO: description: DTO de informações do leiaute type: object required: – id – identifier – layout – environmentType – referenceDate – resume – status – company properties: id: type: string description: Identificador único identifier: type: string description: Identificador do leiaute layout: type: integer format: int64 description: Leiaute environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente referenceDate: type: string format: date description: Data de início resume: type: string description: Resumo do leiaute status: type: string allOf: – #/definitions/statusLayoutType description: Status do leiaute company: type: object allOf: – #/definitions/companyDTO description: Empresa employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador startCreateDate: type: string format: date-time description: Data inicial da criação layoutReturnDTO: description: DTO de dados de recibo type: object required: – id – statusEvent – createBy – createDate properties: id: type: string description: Identificador único statusEvent: type: string allOf: – #/definitions/statusEventType description: Status do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceipt: type: string description: Número do recibo retornado do governo governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo errorMessage: type: string description: Mensagem de erro no processamento ou envio do evento ao governo createBy: type: string description: Criado por createDate: type: string format: date-time description: Data de criação layoutDetailDTO: description: DTO de detalhes do leiaute type: object required: – id – identifier – layout – version – rectificationType – environmentType – emissorType – emissorVersion – referenceDate – resume – status – company – importation – xml – createBy – createDate properties: id: type: string description: Identificador único identifier: type: string description: Identificador do leiaute layout: type: integer format: int64 description: Leiaute type: string description: Versão do leiaute rectificationType: type: string allOf: – #/definitions/rectificationType description: Tipo de retificação rectificationReceipt: type: string description: Recibo retificador environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente emissorType: type: string description: Processo de emissão do evento emissorVersion: type: string description: Versão do processo de emissão referenceDate: type: string format: date description: Data de referência resume: type: string description: Resumo do leiaute status: type: string allOf: – #/definitions/statusLayoutType description: Situação do leiaute company: type: object allOf: – #/definitions/companyRegistrationDTO description: Empresa employee: type: object allOf: – #/definitions/employeeRegistrationDTO description: Colaborador importation: type: string description: Importação xml: type: string description: XML createBy: type: string description: Criado por createDate: type: string format: date description: Data de criação layoutReturn: type: array items: type: object allOf: – #/definitions/layoutReturnDTO description: Dados dos recibos eSocialDefinition: description: Definições do eSocial type: object required: – company – environmentType – eSocialGroup properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente eSocialGroup: type: string allOf: – #/definitions/eSocialGroup description: Grupo de entrada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialDefinition: type: object required: – id allOf: – #/definitions/eSocialDefinition eSocialDefinitionAutoSend: description: Envio automático de leiautes type: object required: – eSocialDefinition – layout – isAutomaticSending properties: id: type: string format: uuid description: Identificador único eSocialDefinition: type: object allOf: – #/definitions/eSocialDefinition description: Definições do eSocial layout: type: integer format: int64 description: Leiaute isAutomaticSending: type: boolean description: Envio automático createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editESocialDefinitionAutoSend: type: object required: – id allOf: – #/definitions/eSocialDefinitionAutoSend layoutStatus: description: Informações do leiaute type: object required: – identifier – layout – version – rectificationType – environmentType – emissorType – emissorVersion – origin – importation – xml – startDate – resume – situation – status – company – companyRegistrationType – companyRegistration properties: id: type: string format: uuid description: Identificador único identifier: type: string maxLength: 36 description: Identificador do leiaute layout: type: integer format: int64 description: Tipo do leiaute type: string maxLength: 15 description: Versão do leiaute rectificationType: type: integer format: int64 description: Identificação de retificação rectificationReceipt: type: string maxLength: 23 description: Recibo retificador environmentType: type: integer format: int64 description: Identificação do ambiente emissorType: type: integer format: int64 description: Processo de emissão do evento emissorVersion: type: string maxLength: 20 description: Versão do processo de emissão origin: type: string maxLength: 20 description: Origem importation: type: string description: Importação xml: type: string description: XML startDate: type: string format: date description: Data de início resume: type: string maxLength: 100 description: Resumo do leiaute situation: type: integer format: int64 description: Situação do leiaute status: type: integer format: int64 description: Status do leiaute company: type: object allOf: – #/definitions/e070emp description: Empresa companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da empresa companyRegistration: type: string maxLength: 14 description: Inscrição da empresa employee: type: object allOf: – #/definitions/employee description: Colaborador employeeRegistration: type: string maxLength: 11 description: CPF do colaborador eSocialRegistration: type: string maxLength: 30 description: Matrícula eSocial do colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: layoutReturn: description: Dados de recibo type: object required: – layoutStatus – statusEvent properties: id: type: string format: uuid description: Identificador único layoutStatus: type: object allOf: – #/definitions/layoutStatus description: Evento statusEvent: type: string allOf: – #/definitions/statusEventType description: Status do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceipt: type: string description: Número do recibo retornado do governo governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo errorMessage: type: string description: Mensagem de erro no processamento ou envio do evento ao governo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eDocsDefinition: description: Definições do eDocs type: object required: – name – url – username – password – inscription properties: id: type: string format: uuid description: Identificador único name: type: string maxLength: 200 description: Nome da definição url: type: string maxLength: 255 description: URL username: type: string maxLength: 200 description: Usuário password: type: string maxLength: 200 description: Senha inscription: type: string maxLength: 30 description: CNPJ/CPF do certificado digital createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEDocsDefinition: type: object required: – id allOf: – #/definitions/eDocsDefinition eDocsDefinitionCompany: description: Definições do eDocs da empresa type: object required: – eDocsDefinition – company properties: id: type: string format: uuid description: Identificador único eDocsDefinition: type: object allOf: – #/definitions/eDocsDefinition description: Definição do eDocs company: type: object allOf: – #/definitions/e070emp description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEDocsDefinitionCompany: type: object required: – id allOf: – #/definitions/eDocsDefinitionCompany e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – codPes – nomPes properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 14 description: CNPJ/CPF excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employee: description: Colaborador type: object required: – hireDate – code properties: id: type: string format: uuid description: Identificador único employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento code: type: integer format: int64 description: Cadastro eSocialRegistration: type: string description: Matrícula do eSocial companyTransferDate: type: string format: date description: Data de transferência deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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