2.0info: 1.13.9 export description: ARP Export Backend x-senior-domain: Armazenamento de registro de ponto x-senior-domain-path: arp x-senior-service-path: export 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/arpsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /export/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError /export/queries/getProcessPendency: post: description: Recupera uma pendência pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: identificador da pendência responses: 200: description: Ok schema: type: object required: – processPendency properties: processPendency: type: object allOf: – #/definitions/processPendencyDTO description: Pendência de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera uma pendência pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: identificador da pendência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – processPendency properties: processPendency: type: object allOf: – #/definitions/processPendencyDTO description: Pendência de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /export/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 /export/queries/exportPendency: 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 /export/queries/exportProcessPendency: 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 /export/queries/exportProcessPendencyParam: 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 /export/queries/exportEmployer: 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 /export/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 /export/queries/exportDsf: 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 /export/queries/exportClockingEvent: 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 /export/queries/exportProperties: 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 /export/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 /export/actions/findDSFByEmployeeIdAndExternalId: post: description: Busca um registro de marcação baseado no id do colaborador e no external Id tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – externalId properties: employee: type: object allOf: – #/definitions/employeeDTO description: Id do colaborador externalId: type: string description: Id externo do colaborador responses: 200: description: Ok schema: type: object required: – clockingEvent properties: clockingEvent: type: object allOf: – #/definitions/clockingEventDSFDTO description: Dados da marcação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /export/actions/forceComplementDSF: post: description: Força para completantar o Afd.\nCaso o período já foi processando para todas as empresas a pendência será retornada como finalizada e o evento de dsfComplement será enviado.\nCaso contrário se tiver ao menor uma empresa para processar retorna a pendência e o inicia o processo de complementar os dados do afd, ao final envia o evento de dsfComplement;\nCaso a data final for maior que data atual não processa\nCaso a empresa não existir não processa.\nObs.: o evento de conclusão pode chegar antes do retorno da pendência.\n\nEsse signal pode ser executado somente via mensageria, a sua requisição via API está bloqueada.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDateTime – endDateTime – employer properties: startDateTime: type: string format: date-time description: Data final de processamento endDateTime: type: string format: date-time description: Data final de processamento employer: type: array items: type: string minimum: 1 description: Lista de empresa para processar responses: 200: description: Ok schema: type: object required: – processPendency properties: processPendency: type: object allOf: – #/definitions/processPendencyDTO description: Pendência de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /export/actions/generateDSF: post: description: Faz a geração do arquivo AFD\n\nEsse action pode ser executado somente via mensageria, a sua requisição via API está bloqueada.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDateTime – endDateTime – employer properties: startDateTime: type: string format: date-time description: Data final de processamento endDateTime: type: string format: date-time description: Data final de processamento employer: type: array items: type: string minimum: 1 description: Lista de empresa para processar doSign: type: boolean description: Assinar? default: false responses: 200: description: Ok schema: type: object required: – processPendency properties: processPendency: type: object allOf: – #/definitions/processPendencyDTO description: Pendência de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /export/actions/importPendency: 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 /export/actions/importProcessPendency: 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 /export/actions/importProcessPendencyParam: 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 /export/actions/importEmployer: 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 /export/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 /export/actions/importDsf: 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 /export/actions/importClockingEvent: 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 /export/actions/importProperties: 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 /export/signals/dataCleaning: post: description: Faz a limpeza das pendências finalizadas com data superior a 30 dias. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /export/signals/complementDSF: post: description: Complementar o arquivo AFD\nEsse signal pode ser executado somente via mensageria, a sua requisição via API está bloqueada.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /export/signals/notifyTenantsWithDSFChanges: post: description: Notifica todos os tenantes com alterações (Disponível somente para o tentant da Senior) tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /export/signals/exportDataSourceFile: post: description: Exportação de arquivo afd\n\nEsse signal pode ser executado somente via mensageria, a sua requisição via API está bloqueada.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processPendecyId properties: processPendecyId: type: string description: Id da pendência para processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /export/signals/complementDSFByEmployer: post: description: Complementar o arquivo AFD filtrado por empresa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employer properties: employer: type: array items: type: string minimum: 1 description: Lista de id de empresas para completar o dsf responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /export/events/dsfComplemented: post: description: Complementar arquivo afd x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – sucess properties: id: type: string description: Id da pendência sucess: type: boolean description: Resultado do evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /export/events/readyToSign: post: description: Evento que avisa quando está pronto para assinar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – sucess properties: id: type: string description: Id da pendência sucess: type: boolean description: Resultado do evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /export/events/clockingEventDSFCreated: post: description: Evento de marcação criada no afd x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – clockingEvent properties: clockingEvent: type: array items: type: object allOf: – #/definitions/clockingEventDSFDTO minimum: 1 description: Marcação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /export/events/dsfCompleted: post: description: Evento de AFD completo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processPendencyId – sucess properties: processPendencyId: type: string description: Id da pendência de processamento sucess: type: boolean description: Finalizado com secesso error: type: string description: Mensagem em caso de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /export/events/dsfExport: post: description: Evento para notificar que o arquivo afd foi Gerado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – sucess properties: id: type: string description: Id da pendência sucess: type: boolean description: Status url: type: string description: Url do afd error: type: string description: Mensagem de erro, em caso de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /export/events/importPendencyEvent: 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 /export/events/exportPendencyEvent: 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 /export/events/importProcessPendencyEvent: 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 /export/events/exportProcessPendencyEvent: 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 /export/events/importProcessPendencyParamEvent: 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 /export/events/exportProcessPendencyParamEvent: 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 /export/events/importEmployerEvent: 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 /export/events/exportEmployerEvent: 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 /export/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 /export/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 /export/events/importDsfEvent: 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 /export/events/exportDsfEvent: 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 /export/events/importClockingEventEvent: 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 /export/events/exportClockingEventEvent: 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 /export/events/importPropertiesEvent: 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 /export/events/exportPropertiesEvent: 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 /export/entities/processPendency/{parentId}/params: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/processPendencyParam responses: 200: description: The created resources schema: type: array items: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/processPendencyParam responses: 200: description: The created resources schema: type: array items: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /export/entities/processPendency/{parentId}/params/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processPendencyParam responses: 200: description: Ok schema: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processPendencyParam responses: 200: description: Ok schema: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processPendencyParam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN pendencyStatus: description: Status pendência type: string enum: – WAITING – RUNNING pendencyType: description: Tipo de pendência type: string enum: – NSR processPendencyType: description: Tipo de processamento type: string enum: – EXPORT_FILE – COMPLEMENT_DSF filePendencyStatus: description: Status da pendência type: string enum: – UPLOAD – PENDING – SIGNED – ERROR processPendencyStatusType: description: Tipo de processamento type: string enum: – WAITING_DSF – WAITING_SIGN – READY_FOR_EXPORT – EXPORTING – FINISHED – ERROR processPendencyParamType: description: Tipo do parâmetro type: string enum: – EMPLOYER collectorType: description: Tipo do coletor type: string enum: – MOBILE_APPLICATION – BROWSER – DESKTOP_APPLICATION – ELECTRONIC_DEVICE – OTHER_ELECTRONIC_DEVICES employerType: description: Tipo de empregador type: string enum: – CNPJ – CPF dsfRecordType: description: Tipo de registro type: string enum: – EMPLOYER_UPDATE – REP_CEA_CLOCKING_EVENT – CLOCK_SETTING – EMPLOYEE_UPDATE – REP_EVENT – REP_P_CLOCKING_EVENT fileType: description: Tipo de arquivo type: string enum: – TXT – CSV – AFD userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde clockingEventDSFDTO: description: Representação de uma marcação type: object required: – id – date – time – timeZoneOffset – cpf – collectorType – online – externalId – nsr – hash – version – employer – createdDate – recordId properties: id: type: string description: Identificador date: type: string format: date description: Data time: type: string description: Hora timeZoneOffset: type: string description: Timezone cpf: type: integer format: int64 description: CPF collectorType: type: string allOf: – #/definitions/collectorType description: Tipo de coletor online: type: boolean description: Online externalId: type: string description: Identificado externo da marcação, único por colaborador nsr: type: integer format: int64 description: Número sequencial hash: type: string description: hash type: integer format: int64 description: Versão do afd employer: type: object allOf: – #/definitions/employerDSFDTO description: Empregador createdDate: type: string format: date-time description: Data de criação recordId: type: string description: Id do registro employerDSFDTO: description: Empregador type: object required: – id properties: id: type: string description: Identificador employeeDTO: description: Empregado type: object required: – id properties: id: type: string description: Identificador do colaborador processPendencyDTO: description: Representação da pendência de processo type: object required: – id – type – status – startDate – endDate – employer – sign – requestUser properties: id: type: string description: Identificador da pendência type: type: string allOf: – #/definitions/processPendencyType description: Tipo da pendência status: type: string allOf: – #/definitions/processPendencyStatusType description: Status da pendência startDate: type: string format: date-time description: Data de início endDate: type: string format: date-time description: Data final employer: type: array items: type: string minimum: 1 description: Empregadores url: type: string description: Url error: type: string description: Mensagem de erro retries: type: integer format: int64 description: Retentativas sign: type: boolean description: Se deve assinar o documento signTicket: type: string description: Ticket de assinatura requestUser: type: string maxLength: 256 description: Usuário que solicitou a assinatura pendency: description: Pendência type: object required: – id – type – status – updateTime – lastCreatedDate properties: id: type: string format: uuid description: Identificador do registro type: type: string allOf: – #/definitions/pendencyType description: Tipo status: type: string allOf: – #/definitions/pendencyStatus description: Estatus updateTime: type: string format: date-time description: Data da último alteração lastCreatedDate: type: string format: date-time description: Data da último createdDate processado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processPendency: description: Pendência de processamento type: object required: – id – type – status – startDateTime – endDateTime – retries – sign – requestUser properties: id: type: string format: uuid description: Identificador do registro type: type: string allOf: – #/definitions/processPendencyType description: Tipo status: type: string allOf: – #/definitions/processPendencyStatusType description: Estatus startDateTime: type: string format: date-time description: Data de início endDateTime: type: string format: date-time description: Data final url: type: string maxLength: 2500 description: URl error: type: string maxLength: 500 description: Mensagem de erro retries: type: integer format: int64 description: Retentativas params: type: array items: type: object allOf: – #/definitions/processPendencyParam description: Parâmetros sign: type: boolean description: Se deve assinar o documento signTicket: type: string format: uuid description: Ticket de assinatura requestUser: type: string maxLength: 256 description: Usuário que solicitou a assinatura createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processPendencyParam: description: Parâmetros de Pendência de processamento type: object required: – id – type – parameter – pending properties: id: type: string format: uuid description: Identificador do registro processPendency: type: object allOf: – #/definitions/processPendency description: Pendências de processamento type: type: string allOf: – #/definitions/processPendencyParamType description: Tipo parameter: type: string description: Parâmetro pending: type: boolean description: Pendente de processamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employer: description: Empregador type: object required: – externalId – identifier – employerType – name – registerNumberINPI – address – cpfResponsible – enabled properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo identifier: type: integer format: int64 description: Identificador employerType: type: string allOf: – #/definitions/employerType description: Tipo do empregador nationalRegister: type: integer format: int64 description: Registro nacinal name: type: string description: Nome registerNumberINPI: type: string description: Número de registro no INPI address: type: string description: Endereço cpfResponsible: type: integer format: int64 description: CPF do responsável enabled: type: boolean description: Habilitado cnoNumber: type: string description: Número de Cadastro Nacional de Obras caepf: type: string description: CAEPF createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employee: description: Empregado type: object required: – externalId – employer – cpf – name – secondaryIdentification – cpfResponsible – enabled properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo employer: type: string format: uuid description: Empregador cpf: type: integer format: int64 description: CPF name: type: string description: Nome secondaryIdentification: type: string maxLength: 4 description: Identificador secundário cpfResponsible: type: integer format: int64 description: CPF do responsável enabled: type: boolean description: Habilitado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dsf: description: Fonte de dados type: object required: – cpfResponsible – employer – recordType – recordId – recordExternalId – recordLine – version properties: id: type: string format: uuid description: Id cpfResponsible: type: integer format: int64 description: CPF do responsável employer: type: string format: uuid description: Empregador nsr: type: integer format: int64 description: NSR recordType: type: string allOf: – #/definitions/dsfRecordType description: Tipo do registro recordId: type: string format: uuid description: Id do registro recordExternalId: type: string format: uuid description: Id externo recordLine: type: string description: Linha do registro type: integer format: int64 description: Versão hash: type: string description: Hash createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: clockingEvent: description: Evento de ponto type: object required: – externalId – date – time – timeZoneOffset – cpf – collectorType – online properties: id: type: string format: uuid description: Id externalId: type: string format: uuid description: Id externo date: type: string format: date description: Data time: type: string description: Hora timeZoneOffset: type: string maxLength: 6 description: Time zone offset no formato +hh:mm ou -hh:mm cpf: type: integer format: int64 description: CPF collectorType: type: string allOf: – #/definitions/collectorType description: Tipo do coletor online: type: boolean description: On-line createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: properties: description: Propriedades type: object required: – key – value – updateDateTime properties: id: type: string format: uuid description: Identificador único key: type: string maxLength: 60 description: Chave da propriedade value: type: string maxLength: 255 description: Valor da chave updateDateTime: type: string format: date-time description: Data da última atualizaçã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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE