2.0info: 1.7.0 time_card_general description: HCM – Espelho de ponto x-senior-domain: HCM – Espelho de ponto x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: time_card_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_clocking_event_time_evaluationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /time_card_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 /time_card_general/queries/timeCardCompetenceTotalsByStatus: post: description: Filtro para contar as assinaturas de espelho de ponto na competência por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence properties: competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/employeeCompanyFilterDTO description: Filtros responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/timeCardCompetenceTotalsByStatusResultDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/timeCardCompetenceByStatus: post: description: Listar as assinaturas de espelho de ponto dos colaborador com o status. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – page properties: competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/employeeCompanyFilterDTO description: Filtros status: type: array items: type: string allOf: – #/definitions/timeCardCompetenceByStatusItemStatus description: Status da assinatura de espelho de ponto, pode ser PENDING, ACCEPTED, REJECTED, CANCELED, NOT_SENT, EXPIRED onlyDismissed: type: boolean description: Apenas colaboraros demitidos default: false page: type: object allOf: – #/definitions/pageDTO description: Páginação orderBy: type: string description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- employee.id,\n- employee.code,\n- employee.name,\n- company.id,\n- company.code,\n- timeCardCompetence.id,\n- timeCardCompetence.status\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: employee.name+asc ou apenas employee.name\n- Descendente: employee.name+desc\n responses: 200: description: Ok schema: type: object allOf: – #/definitions/timeCardCompetenceByStatusResultDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/timeCardCompetenceByEmployee: post: description: Listar as assinaturas de espelho de ponto do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – page properties: employee: type: string description: Identificador do colaborador page: type: object allOf: – #/definitions/pageDTO description: Páginação orderBy: type: string description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- id,\n- competence, (ordenação padrão: competence+desc)\n- status,\n- expirationDate\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: competence+asc ou apenas competence\n- Descendente: competence+desc\n responses: 200: description: Ok schema: type: object allOf: – #/definitions/timeCardCompetenceByEmployeeResultDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/timeCardCompetenceDetails: post: description: Detalhes da assinatura de espelho de ponto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – timeCardCompetenceId properties: timeCardCompetenceId: type: string description: Identificador da assinatura de espelho de ponto responses: 200: description: Ok schema: type: object allOf: – #/definitions/timeCardCompetenceDetailsResultDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Detalhes da assinatura de espelho de ponto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: timeCardCompetenceId description: Identificador da assinatura de espelho de ponto in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/timeCardCompetenceDetailsResultDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/findUpdatedSignatureInfo: post: description: Busca informações atualizadas para assinatura do espelho de ponto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – competence properties: employeeId: type: string description: Identificador do colaborador competence: type: string format: date description: Competência responses: 200: description: Ok schema: type: object allOf: – #/definitions/updatedSignatureInfoDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca informações atualizadas para assinatura do espelho de ponto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador do colaborador in: query required: true type: string – name: competence description: Competência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/updatedSignatureInfoDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/employeeTimeCardCompetenceInCompetence: post: description: Espelho de ponto do colaborador na competência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – competence properties: employeeId: type: string description: Colaborador competence: type: string format: date description: competência responses: 200: description: Ok schema: type: object required: – hasTimeCardCompetence – timeCardCompetence properties: hasTimeCardCompetence: type: boolean description: Tem espelho de ponto timeCardCompetence: type: object allOf: – #/definitions/objectIdDTO description: Espelho de ponto na competência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Espelho de ponto do colaborador na competência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Colaborador in: query required: true type: string – name: competence description: competência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – hasTimeCardCompetence – timeCardCompetence properties: hasTimeCardCompetence: type: boolean description: Tem espelho de ponto timeCardCompetence: type: object allOf: – #/definitions/objectIdDTO description: Espelho de ponto na competência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_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 /time_card_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 /time_card_general/queries/exportCompanyClockingEventIndications: 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 /time_card_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 /time_card_general/queries/exportEmployeeSnapshot: 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 /time_card_general/queries/exportEmploymentRelationship: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/queries/exportEmployeeClockingEvent: 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 /time_card_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 /time_card_general/queries/exportEmployeeModule: 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 /time_card_general/queries/exportTimeCardSignatureDefinition: 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 /time_card_general/queries/exportTimeEvaluationSituationDefinition: 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 /time_card_general/queries/exportTimeEvaluationHistory: 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 /time_card_general/queries/exportTimeCardCompetence: 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 /time_card_general/queries/exportTimeCardReport: 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 /time_card_general/queries/exportTimeCardReportLog: 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 /time_card_general/queries/exportEmployeeCompetence: 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 /time_card_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 /time_card_general/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_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 /time_card_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 /time_card_general/actions/importCompanyClockingEventIndications: 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 /time_card_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 /time_card_general/actions/importEmployeeSnapshot: 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 /time_card_general/actions/importEmploymentRelationship: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/actions/importEmployeeClockingEvent: 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 /time_card_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 /time_card_general/actions/importEmployeeModule: 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 /time_card_general/actions/importTimeCardSignatureDefinition: 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 /time_card_general/actions/importTimeEvaluationSituationDefinition: 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 /time_card_general/actions/importTimeEvaluationHistory: 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 /time_card_general/actions/importTimeCardCompetence: 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 /time_card_general/actions/importTimeCardReport: 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 /time_card_general/actions/importTimeCardReportLog: 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 /time_card_general/actions/importEmployeeCompetence: 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 /time_card_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 /time_card_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 /time_card_general/events/importCompanyClockingEventIndicationsEvent: 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 /time_card_general/events/exportCompanyClockingEventIndicationsEvent: 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 /time_card_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 /time_card_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 /time_card_general/events/importEmployeeSnapshotEvent: 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 /time_card_general/events/exportEmployeeSnapshotEvent: 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 /time_card_general/events/importEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /time_card_general/events/exportEmploymentRelationshipEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /time_card_general/events/importEmployeeClockingEventEvent: 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 /time_card_general/events/exportEmployeeClockingEventEvent: 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 /time_card_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 /time_card_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 /time_card_general/events/importEmployeeModuleEvent: 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 /time_card_general/events/exportEmployeeModuleEvent: 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 /time_card_general/events/importTimeCardSignatureDefinitionEvent: 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 /time_card_general/events/exportTimeCardSignatureDefinitionEvent: 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 /time_card_general/events/importTimeEvaluationSituationDefinitionEvent: 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 /time_card_general/events/exportTimeEvaluationSituationDefinitionEvent: 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 /time_card_general/events/importTimeEvaluationHistoryEvent: 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 /time_card_general/events/exportTimeEvaluationHistoryEvent: 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 /time_card_general/events/importTimeCardCompetenceEvent: 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 /time_card_general/events/exportTimeCardCompetenceEvent: 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 /time_card_general/events/importTimeCardReportEvent: 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 /time_card_general/events/exportTimeCardReportEvent: 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 /time_card_general/events/importTimeCardReportLogEvent: 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 /time_card_general/events/exportTimeCardReportLogEvent: 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 /time_card_general/events/importEmployeeCompetenceEvent: 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 /time_card_general/events/exportEmployeeCompetenceEvent: 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 /time_card_general/entities/timeEvaluationHistory: 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/timeEvaluationHistory responses: 200: description: The created resource schema: #/definitions/timeEvaluationHistory 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/timeEvaluationHistory responses: 200: description: The created resource schema: #/definitions/timeEvaluationHistory 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/timeEvaluationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/entities/timeEvaluationHistory/{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/editTimeEvaluationHistory responses: 200: description: Ok schema: #/definitions/editTimeEvaluationHistory 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/timeEvaluationHistory responses: 200: description: Ok schema: #/definitions/timeEvaluationHistory 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/timeEvaluationHistory 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 /time_card_general/entities/timeEvaluationHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/timeEvaluationHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/entities/timeCardCompetence: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/timeCardCompetence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/entities/timeCardReport: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/timeCardReport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /time_card_general/entities/timeCardReportLog: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/timeCardReportLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno da escala: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral timeCardCompetenceStatus: type: string enum: – GENERATING – PENDING – APPROVED – REJECTED – CANCELED description: Status da assinatura do espelho de ponto na competência: * `GENERATING` – Gerando * `PENDING` – Pendente de assinatura * `APPROVED` – Assinatura aprovada * `REJECTED` – Assinatura rejeitada * `CANCELED` – Assinatura cancelada timeCardCompetenceCustomStatus: type: string enum: – EXPIRED – NOT_SENT description: Status da assinatura do espelho de ponto na competência: * `EXPIRED` – Vencido * `NOT_SENT` – Não enviado timeCardCompetenceByStatusItemStatus: type: string enum: – PENDING – APPROVED – REJECTED – CANCELED – EXPIRED – NOT_SENT timeCardReportStatus: type: string enum: – STARTED – WAITING_REPORT – REPORT_READY – REPORT_SENT_TO_GED – WAITING_SIGNATURE – READY_SIGNATURE – ACCEPTED – REJECTED – CANCELED – ERROR description: Status do relatório de espelho de ponto: * `STARTED` – Relatório de espelho de ponto gerado * `WAITING_REPORT` – Relatório de espelho de ponto aguardando geração relatório * `REPORT_READY` – Relatório de espelho de ponto pronto para assinatura * `REPORT_SENT_TO_GED` – Relatório enviado para o GED * `WAITING_SIGNATURE` – Relatório de espelho de ponto aguardando assinatura * `READY_SIGNATURE` – Relatório de espelho de ponto pronto para assinatura * `ACCEPTED` – Relatório de espelho de ponto aceito * `REJECTED` – Relatório de espelho de ponto rejeitado * `CANCELED` – Relatório de espelho de ponto cancelado * `ERROR` – Erro timeCardReportLogStatus: type: string enum: – REPORT_BUILDING – REPORT_SENT – REPORT_ACCEPTED – REPORT_REJECTED – REPORT_CANCELED – REPORT_RESENT description: Status do log do relatório de espelho de ponto: * `REPORT_BUILDING` – Relatório de espelho de ponto em construção * `REPORT_SENT` – Relatório de espelho de ponto enviado * `REPORT_ACCEPTED` – Relatório de espelho de ponto aceito * `REPORT_REJECTED` – Relatório de espelho de ponto rejeitado * `REPORT_CANCELED` – Relatório de espelho de ponto cancelado * `REPORT_RESENT` – Relatório de espelho de ponto reenviado timeEvaluationType: type: string enum: – V1 – V2 – V5 – V7 description: Tipo de apuração: * `V1` – Normal * `V2` – Dispensado do ponto * `V5` – Sem controle de ponto * `V7` – Ponto por Exceção article62CltType: type: string enum: – V1 – V2 – V3 – V4 description: Artigo 62 da CLT: * `V1` – Não se aplica * `V2` – Atividade externa especificada no inciso I * `V3` – Funções especificadas no inciso II * `V4` – Teletrabalho, previsto no inciso III 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 timeCardCompetenceByEmployeeResultDTO: description: Detalhes da assinatura de espelho de ponto type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/timeCardCompetenceByEmployeeItemDTO minimum: 1 description: Lista de assinaturas de espelho de ponto totalElements: type: integer format: int64 description: Total de itens totalPages: type: integer format: int64 description: Total de páginas timeCardCompetenceByEmployeeItemDTO: description: Item da lista de assinaturas de espelho de ponto type: object required: – id – competence – status – employee – person properties: id: type: string description: identificador da assinatura de espelho de ponto competence: type: string format: date description: Competência de espelho de ponto status: type: string allOf: – #/definitions/timeCardCompetenceStatus description: Status da assinatura de espelho de ponto expirationDate: type: string format: date description: Data de vencimento da assinatura de espelho de ponto employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador person: type: object allOf: – #/definitions/personDTO description: Pessoa timeCardReport: type: object allOf: – #/definitions/timeCardReportDTO description: Relatório atual de espelho de ponto timeCardCompetenceByStatusResultDTO: description: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/timeCardCompetenceByStatusItemDTO minimum: 1 description: Lista de assinaturas de espelho de ponto totalElements: type: integer format: int64 description: Total de itens totalPages: type: integer format: int64 description: Total de páginas timeCardCompetenceByStatusItemDTO: description: Item da lista de assinaturas de espelho de ponto type: object required: – employee – company – timeCardCompetence properties: employee: type: object allOf: – #/definitions/employeeBasicDTO description: Colaborador company: type: object allOf: – #/definitions/objectIdCodeDTO description: Empresa timeCardCompetence: type: object allOf: – #/definitions/timeCardCompetenceBasicDTO description: Identificador da competência de espelho de ponto employeeBasicDTO: description: type: object required: – id – code – person – username properties: id: type: string description: Identificador do colaborador code: type: string description: Código do colaborador person: type: object allOf: – #/definitions/personDTO description: Pessoa username: type: string description: Usuario do colaborador dismissalDate: type: string format: date description: Date de desligamento do colaborador timeCardCompetenceBasicDTO: description: type: object required: – id – status properties: id: type: string description: Identificador status: type: string allOf: – #/definitions/timeCardCompetenceByStatusItemStatus description: Status objectIdCodeDTO: description: ObjectId e código type: object required: – id – code properties: id: type: string description: Identificador code: type: string description: Código employeeDTO: description: Dados do colaborador para assinatura do espelho de ponto type: object required: – id – username properties: id: type: string description: Identificador username: type: string description: Usuário do colaborador personDTO: description: Dados da pessoa para assinatura do espelho de ponto type: object required: – id – name properties: id: type: string description: Identificador name: type: string description: Nome da pessoa timeCardReportDTO: description: Relatório de espelho de ponto type: object required: – id properties: id: type: string description: Identificador signature: type: string description: Identificador da assinatura de espelho de ponto report: type: string description: Identificador do relatório documentId: type: string description: Identificador do documento do Ged documentVersion: type: integer format: int64 description: Versão do documento do Ged message: type: string description: Mensagem do log de relatório de espelho de ponto. Ex.: motivo de rejeição objectIdDTO: description: ObjectId type: object required: – id properties: id: type: string description: Identificador pageDTO: description: Paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Offset minimum: 0 size: type: integer format: int64 description: Size minimum: 1 maximum: 50 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/healthcheckDTO description: Status employeeCompanyFilterDTO: description: type: object properties: employeeId: type: string description: Id do colaborador companyId: type: string description: Id da empresa advancedFilterId: type: string description: Filtro avançado employeeFilter: type: string description: Filtro de colaborador, like código do colaborador/nome timeCardCompetenceTotalsByStatusResultDTO: description: type: object required: – pending – approved – rejected – canceled – notSent – expired properties: pending: type: integer format: int64 description: Total de assinaturas de espelho com status PENDING approved: type: integer format: int64 description: Total de assinaturas de espelho com status APPROVED rejected: type: integer format: int64 description: Total de assinaturas de espelho com status REJECTED canceled: type: integer format: int64 description: Total de assinaturas de espelho com status CANCELED notSent: type: integer format: int64 description: Total de assinaturas de espelho com status NOT_SENT expired: type: integer format: int64 description: Total de assinaturas de espelho com status EXPIRED timeCardCompetenceDetailsResultDTO: description: Detalhes da assinatura de espelho de ponto type: object required: – id – competence – employee – expirationDate – status – history properties: id: type: string description: Identificador da assinatura de espelho de ponto competence: type: string format: date description: Competência da assinatura de espelho de ponto employee: type: object allOf: – #/definitions/employeeBasicDTO description: Identificador do colaborador expirationDate: type: string format: date description: Data de vencimento da assinatura de espelho de ponto status: type: string allOf: – #/definitions/timeCardCompetenceStatus description: Status da assinatura de espelho de ponto signatureDate: type: string format: date-time description: Data da assinatura de espelho de ponto history: type: array items: type: object allOf: – #/definitions/timeCardReportLogItemDTO minimum: 1 description: Histórico de alterações da assinatura de espelho de ponto timeCardReportLogItemDTO: description: Item do histórico de alterações da assinatura de espelho de ponto type: object required: – id – logAction – user – actionDate properties: id: type: string description: Identificador do log de relatório de espelho de ponto logAction: type: string allOf: – #/definitions/timeCardReportLogStatus description: Ação realizada no relatório de espelho de ponto message: type: string description: Mensagem do log de relatório de espelho de ponto. Ex.: motivo de rejeição user: type: string description: Usuário que realizou a ação no relatório de espelho de ponto actionDate: type: string format: date-time description: Data da ação no relatório de espelho de ponto updatedSignatureInfoDTO: description: type: object required: – timeCardCompetenceStatus – signatureId properties: timeCardCompetenceStatus: type: string allOf: – #/definitions/timeCardCompetenceStatus description: Status da assinatura do espelho de ponto signatureId: type: string description: Identificador da assinatura e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa companyClockingEventIndications: type: object allOf: – #/definitions/companyClockingEventIndications description: Assinalamentos do ponto para a 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: companyClockingEventIndications: description: Assinalamentos do ponto para a empresa type: object properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa timeCardSignatureDefinition: type: object allOf: – #/definitions/timeCardSignatureDefinition description: Definição de assinatura do espelho de ponto 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: e001pes: description: Pessoa type: object required: – nomPes properties: id: type: string format: uuid description: Identificador único nomPes: type: string maxLength: 100 description: Nome numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) 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: employeeSnapshot: description: Históricos correntes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador company: type: string format: uuid description: Empresa corrente do colaborador companyCode: type: integer format: int64 description: Código da empresa corrente do colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador companyBranchName: type: string description: Nome da filial employmentRelationship: type: string format: uuid description: Vínculo empregatício corrente do colaborador employmentRelationshipCode: type: string description: Código do vínculo empregatício corrente do colaborador employmentRelationshipContractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato vínculo empregatício corrente do colaborador jobPosition: type: string format: uuid description: Cargo corrente do colaborador jobPositionCode: type: integer format: int64 description: Código do cargo corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador positionCode: type: integer format: int64 description: Código da posição corrente do colaborador syndicate: type: string format: uuid description: Sindicato corrente do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato corrente do colaborador workshift: type: string format: uuid description: Escala corrente do colaborador workshiftCode: type: integer format: int64 description: Código da escala corrente do colaborador workshiftTimeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno do horário corrente do colaborador workshiftGroup: type: string format: uuid description: Turma da escala corrente do colaborador workshiftGroupCode: type: integer format: int64 description: Código da turma da escala corrente do colaborador costCenter: type: string format: uuid description: Centro de custo corrente do colaborador costCenterCode: type: string maxLength: 9 description: Código do centro de custo corrente do colaborador location: type: string format: uuid description: Local corrente do colaborador locationCode: type: integer format: int64 description: Código do local corrente do colaborador 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: employmentRelationship: description: Vínculo empregatício type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome x-i18n: true contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. employeeClockingEvent: description: Especialização do colaborador para o ponto type: object required: – hireCompetence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hireCompetence: type: string format: date description: Competência de admissão dismissalCompetence: type: string format: date description: Compentência de demissã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: – person – code properties: id: type: string format: uuid description: Identificador único 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 employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo empregatício code: type: integer format: int64 description: Cadastro username: type: string description: Nome do usuário 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 isEnabledOnClockingEventModule: type: boolean description: Habilitado no módulo do Ponto default: false employeeClockingEvent: type: object allOf: – #/definitions/employeeClockingEvent description: Especialização do colaborador para o ponto companyTransferDate: type: string format: date description: Data da transferência de empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Modulo do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeCardSignatureDefinition: description: Definição de assinatura do espelho de ponto type: object required: – code – description – report properties: id: type: string format: uuid description: Identificador único da definição de assinatura code: type: integer format: int64 description: Código da definição de assinatura description: type: string description: Descrição da definição de assinatura expirationDays: type: integer format: int64 description: Dias para expirar a assinatura, caso não for informado não deve bloquear minimum: 0 maximum: 365 report: type: string description: Relatório de espelho de ponto associado blockCompetence: type: boolean description: Bloqueia a competência caso o espelho de ponto não seja assinado default: false emailNotifyManagerWhenReject: type: boolean description: Enviar E-mail para notificação do gestor quando a assinatura for rejeitada default: false platformNotifyManagerWhenReject: type: boolean description: Enviar notificação na plataforma para o gestor quando a assinatura for rejeitada default: false emailNotifyEmployeeWhenCanceled: type: boolean description: Enviar E-mail para notificação do colaborador quando a assinatura for cancelada default: false platformNotifyEmployeeWhenCanceled: type: boolean description: Enviar notificação na plataforma para o colaborador quando a assinatura for cancelada default: false notificationIntervalDaysEmployee: type: integer format: int64 description: Intervalo de dias para notificação do colaborador minimum: 0 maximum: 30 emailNotifyAdminWhenReject: type: boolean description: Enviar E-mail para notificação do administrador quando a assinatura for rejeitada default: false platformNotifyAdminWhenReject: type: boolean description: Enviar notificação na plataforma para o administrador quando a assinatura for rejeitada default: false adminRole: type: string description: Papel de usuário do administrador deleted: type: boolean description: Indicativo de exclusão do registro 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: timeEvaluationSituationDefinition: description: Definição de situações da apuração type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição x-i18n: true 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: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. timeEvaluationHistory: description: Histórico de apuração type: object required: – employee – startDate – timeEvaluationType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador startDate: type: string format: date description: Início da apuração endDate: type: string format: date description: Fim da apuração timeEvaluationType: type: string allOf: – #/definitions/timeEvaluationType description: Tipo de apuração processAdjustment: type: boolean description: Participa do processo de acerto default: false clockingAdjustment: type: boolean description: Ajusta ponto default: false approveOwnClocking: type: boolean description: Aprova próprio ponto default: false article62Clt: type: string allOf: – #/definitions/article62CltType description: Artigo 62 da CLT situationDefinition: type: object allOf: – #/definitions/timeEvaluationSituationDefinition description: Definição de situações timeZone: type: string maxLength: 6 description: Fuso Horário no formato [+|-]HH:mm, exemplo: -03:00, +00:00, +15:30 enableTimeCardSignature: type: boolean description: Assina espelho do ponto default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTimeEvaluationHistory: type: object required: – id allOf: – #/definitions/timeEvaluationHistory timeCardCompetence: description: Assinatura de espelho de ponto na competência type: object required: – competence – employee – status properties: id: type: string format: uuid description: Identificador único competence: type: string format: date description: Competência employee: type: object allOf: – #/definitions/employee description: Colaborador status: type: string allOf: – #/definitions/timeCardCompetenceStatus description: Status da assinatura createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeCardReport: description: Relatório de espelho de ponto type: object required: – timeCardCompetence – status – summaryId – batch properties: id: type: string format: uuid description: Identificador único timeCardCompetence: type: object allOf: – #/definitions/timeCardCompetence description: Assinatura de espelho de ponto active: type: boolean description: Ativo default: true reportId: type: string description: Identificador do relatório documentId: type: string description: Identificador do documento do Ged documentVersion: type: integer format: int64 description: Versão do documento do Ged default: 1 signatureId: type: string description: Identificador da assinatura status: type: string allOf: – #/definitions/timeCardReportStatus description: Status do relatório expirationDate: type: string format: date description: Data de expiração do relatório message: type: string maxLength: 500 description: Mensagem do log de relatório de espelho de ponto. Ex.: motivo de rejeição summaryId: type: string description: Identificação do log de processo que gerou o relatório batch: type: string description: Batch que gerou o relatório createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeCardReportLog: description: Log do relatório de espelho de ponto type: object required: – timeCardReport – timeCardCompetence – status – userAction properties: id: type: string format: uuid description: Identificador único timeCardReport: type: object allOf: – #/definitions/timeCardReport description: Relatório de espelho de ponto timeCardCompetence: type: object allOf: – #/definitions/timeCardCompetence description: Assinatura de espelho de ponto na competência status: type: string allOf: – #/definitions/timeCardReportLogStatus description: Status do relatório userAction: type: string description: Usuário que realizou a ação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeCompetence: description: Informações do colaborador por competência atualizado a cada apuração type: object required: – employee – competence – timeTrackingStartDate – timeTrackingEndDate – paymentDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador competence: type: string format: date description: Competence timeTrackingStartDate: type: string format: date description: Inicio do período de apuração timeTrackingEndDate: type: string format: date description: Fim do período de apuração paymentDate: type: string format: date description: Dia do pagamento 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 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