2.0info: 2.19.0 HCM – Esocial Manager Notificator description: HCM – Esocial Manager Notificator x-senior-domain: HCM – Esocial Manager Notificator x-senior-domain-path: hcm_esocial_manager x-senior-service-path: notificator contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_esocial_managersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /notificator/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 /notificator/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 /notificator/queries/exportLayoutStatus: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/queries/exportLayoutReturn: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/queries/exportLayoutReturnTotalizer: 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 /notificator/queries/exportEDocsDefinition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/queries/exportEDocsDefinitionCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/queries/exportEmployeeContributionsEvent5001: 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 /notificator/queries/exportSocialSecurityContribution5001: 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 /notificator/queries/exportInssEstablishmentIdentification5001: 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 /notificator/queries/exportInssEmployeeInformation5001: 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 /notificator/queries/exportInssDetailContribution5001: 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 /notificator/queries/exportThirdPartyContribution5001: 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 /notificator/queries/exportDetailReferencePeriodContribution5001: 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 /notificator/queries/exportPisEstablishmentIdentification5001: 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 /notificator/queries/exportPisEmployeeInformation5001: 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 /notificator/queries/exportPisDetailBase5001: 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 /notificator/queries/exportEmployeeGuaranteeFundEvent5003: 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 /notificator/queries/exportEstablishmentIdentification5003: 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 /notificator/queries/exportLocationIdentification5003: 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 /notificator/queries/exportEmployeeInformation5003: 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 /notificator/queries/exportGuaranteeFundDetail5003: 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 /notificator/queries/exportEmployeePayrollLoan5003: 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 /notificator/queries/exportCompanyContributionsEvent5011: 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 /notificator/queries/exportSimplesNacionalTaxRegimeInformation5011: 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 /notificator/queries/exportEstablishmentIdentification5011: 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 /notificator/queries/exportInssLocationIdentification5011: 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 /notificator/queries/exportInssEsocialCategoryContribution5011: 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 /notificator/queries/exportInssMonthlyDetailContribution5011: 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 /notificator/queries/exportInssThirteenthSalaryDetailContribution5011: 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 /notificator/queries/exportEstablishmentSocialSecurityContribution5011: 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 /notificator/queries/exportPisBase5011: 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 /notificator/queries/exportCompanySocialSecurityContribution5011: 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 /notificator/queries/exportCompanyIncomeTaxEvent5012: 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 /notificator/queries/exportIrrfMonthlyRevenueCode5012: 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 /notificator/queries/exportCompanyGuaranteeFundEvent5013: 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 /notificator/queries/exportEstablishmentIdentification5013: 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 /notificator/queries/exportLocationIdentification5013: 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 /notificator/queries/exportGuaranteeFundDetail5013: 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 /notificator/queries/exportEmployeeIncomeTaxEvent5002: 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 /notificator/queries/exportPayrollInformation5002: 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 /notificator/queries/exportIrrfDetail5002: 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 /notificator/queries/exportIrrfMonthlyRevenueCode5002: 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 /notificator/queries/exportIncomeTaxComplementaryInformation5002: 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 /notificator/queries/exportDependentIdentification5002: 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 /notificator/queries/exportRevenueCodeInformation5002: 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 /notificator/queries/exportDependentDeductibleIncome5002: 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 /notificator/queries/exportAlimonyBeneficiaries5002: 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 /notificator/queries/exportSupplementaryPensionPlan5002: 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 /notificator/queries/exportHealthPlanInformation5002: 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 /notificator/queries/exportHealthPlanDependentInformation5002: 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 /notificator/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 /notificator/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 /notificator/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 /notificator/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 /notificator/actions/manualReceipt: post: description: API para informar o recibo do eSocial manualmente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – layoutId – receipt properties: layoutId: type: string maxLength: 36 description: Id do layout receipt: type: string maxLength: 255 description: Recibo do eSocial responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/manualReturn: post: description: API para testar retornos do eDocs manualmente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – xml properties: xml: type: string description: XML do retorno do eDocs codificado em Base64 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/retrieveEsocialEvents: post: description: Retorna os eventos do eSocial que ainda não foram enviados ao governo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companySubscriptionType – companySubscriptionNumber – environmentType properties: companySubscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição da empresa companySubscriptionNumber: type: string maxLength: 15 description: Número de inscrição da empresa environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente do eSocial layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de evento do eSocial eventStatus: type: string allOf: – #/definitions/eventStatus description: Status do evento do eSocial responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da ação, indicando se ocorreu sucesso ou erro esocialEvent: type: array items: type: object allOf: – #/definitions/esocialEventDTO description: Eventos do eSocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/updateStatusEsocialEvents: post: description: Atualiza o status dos eventos do eSocial que estão sendo enviados ao governo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – statusEsocialEvent properties: statusEsocialEvent: type: array items: type: object allOf: – #/definitions/statusEsocialEventDTO minimum: 1 description: Status do evento do eSocial responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno da atualização dos status dos eventos do eSocial. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/importLayoutStatus: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/importLayoutReturn: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/importLayoutReturnTotalizer: 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 /notificator/actions/importEDocsDefinition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/importEDocsDefinitionCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notificator/actions/importEmployeeContributionsEvent5001: 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 /notificator/actions/importSocialSecurityContribution5001: 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 /notificator/actions/importInssEstablishmentIdentification5001: 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 /notificator/actions/importInssEmployeeInformation5001: 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 /notificator/actions/importInssDetailContribution5001: 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 /notificator/actions/importThirdPartyContribution5001: 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 /notificator/actions/importDetailReferencePeriodContribution5001: 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 /notificator/actions/importPisEstablishmentIdentification5001: 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 /notificator/actions/importPisEmployeeInformation5001: 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 /notificator/actions/importPisDetailBase5001: 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 /notificator/actions/importEmployeeGuaranteeFundEvent5003: 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 /notificator/actions/importEstablishmentIdentification5003: 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 /notificator/actions/importLocationIdentification5003: 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 /notificator/actions/importEmployeeInformation5003: 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 /notificator/actions/importGuaranteeFundDetail5003: 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 /notificator/actions/importEmployeePayrollLoan5003: 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 /notificator/actions/importCompanyContributionsEvent5011: 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 /notificator/actions/importSimplesNacionalTaxRegimeInformation5011: 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 /notificator/actions/importEstablishmentIdentification5011: 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 /notificator/actions/importInssLocationIdentification5011: 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 /notificator/actions/importInssEsocialCategoryContribution5011: 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 /notificator/actions/importInssMonthlyDetailContribution5011: 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 /notificator/actions/importInssThirteenthSalaryDetailContribution5011: 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 /notificator/actions/importEstablishmentSocialSecurityContribution5011: 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 /notificator/actions/importPisBase5011: 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 /notificator/actions/importCompanySocialSecurityContribution5011: 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 /notificator/actions/importCompanyIncomeTaxEvent5012: 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 /notificator/actions/importIrrfMonthlyRevenueCode5012: 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 /notificator/actions/importCompanyGuaranteeFundEvent5013: 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 /notificator/actions/importEstablishmentIdentification5013: 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 /notificator/actions/importLocationIdentification5013: 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 /notificator/actions/importGuaranteeFundDetail5013: 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 /notificator/actions/importEmployeeIncomeTaxEvent5002: 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 /notificator/actions/importPayrollInformation5002: 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 /notificator/actions/importIrrfDetail5002: 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 /notificator/actions/importIrrfMonthlyRevenueCode5002: 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 /notificator/actions/importIncomeTaxComplementaryInformation5002: 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 /notificator/actions/importDependentIdentification5002: 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 /notificator/actions/importRevenueCodeInformation5002: 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 /notificator/actions/importDependentDeductibleIncome5002: 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 /notificator/actions/importAlimonyBeneficiaries5002: 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 /notificator/actions/importSupplementaryPensionPlan5002: 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 /notificator/actions/importHealthPlanInformation5002: 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 /notificator/actions/importHealthPlanDependentInformation5002: 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 /notificator/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 /notificator/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 /notificator/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 /notificator/signals/sendToGovernment: post: description: Realiza a publicação dos leiautes do eSocial. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layoutId properties: layoutId: type: array items: type: string minimum: 1 description: Identificador do leiaute responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notificator/signals/receiveToGovernment: post: description: Realiza a consulta da situação dos leiautes do eSocial no eDocs. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – company properties: company: type: array items: type: string minimum: 1 description: Empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notificator/signals/scheduleCompany: post: description: Realiza a ativação de agendamento para rotinas do eDocs tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenant – requestTime properties: tenant: type: string description: Tenant enableCompanies: type: array items: type: string description: Empresas para habilitar agendamento disableCompanies: type: array items: type: string description: Empresas para desabilitar agendamento requestTime: type: string format: date-time description: Hora da solicitação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notificator/signals/scheduleReceiveToGovernment: post: description: Realiza o agendamento da consulta da situaçao dos documentos vinculados ao eDocs tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notificator/events/receiptLayout: post: description: Evento que informa que um recibo foi adicionao ao leiaute x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – layout – startDate – status – origin – identifier – version – company properties: id: type: string maxLength: 36 description: Id do recibo layout: type: integer format: int64 description: Layout do recibo startDate: type: string format: date description: Data de início status: type: integer format: int64 description: Status do recibo origin: type: string maxLength: 20 description: Origem do recibo identifier: type: string maxLength: 36 description: Identificador do recibo type: string maxLength: 15 description: Versão do recibo company: type: string maxLength: 36 description: Empresa reference: type: string description: Colaborador isAdmissionExclusion: type: boolean description: Admissão do colaborador foi excluída isDismissalExclusion: type: boolean description: Desligamento do colaborador foi excluído responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/importLayoutStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/exportLayoutStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/importLayoutReturnEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/exportLayoutReturnEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/importLayoutReturnTotalizerEvent: 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 /notificator/events/exportLayoutReturnTotalizerEvent: 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 /notificator/events/importEDocsDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/exportEDocsDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/importEDocsDefinitionCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/exportEDocsDefinitionCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /notificator/events/importEmployeeContributionsEvent5001Event: 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 /notificator/events/exportEmployeeContributionsEvent5001Event: 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 /notificator/events/importSocialSecurityContribution5001Event: 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 /notificator/events/exportSocialSecurityContribution5001Event: 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 /notificator/events/importInssEstablishmentIdentification5001Event: 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 /notificator/events/exportInssEstablishmentIdentification5001Event: 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 /notificator/events/importInssEmployeeInformation5001Event: 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 /notificator/events/exportInssEmployeeInformation5001Event: 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 /notificator/events/importInssDetailContribution5001Event: 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 /notificator/events/exportInssDetailContribution5001Event: 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 /notificator/events/importThirdPartyContribution5001Event: 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 /notificator/events/exportThirdPartyContribution5001Event: 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 /notificator/events/importDetailReferencePeriodContribution5001Event: 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 /notificator/events/exportDetailReferencePeriodContribution5001Event: 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 /notificator/events/importPisEstablishmentIdentification5001Event: 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 /notificator/events/exportPisEstablishmentIdentification5001Event: 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 /notificator/events/importPisEmployeeInformation5001Event: 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 /notificator/events/exportPisEmployeeInformation5001Event: 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 /notificator/events/importPisDetailBase5001Event: 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 /notificator/events/exportPisDetailBase5001Event: 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 /notificator/events/importEmployeeGuaranteeFundEvent5003Event: 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 /notificator/events/exportEmployeeGuaranteeFundEvent5003Event: 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 /notificator/events/importEstablishmentIdentification5003Event: 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 /notificator/events/exportEstablishmentIdentification5003Event: 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 /notificator/events/importLocationIdentification5003Event: 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 /notificator/events/exportLocationIdentification5003Event: 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 /notificator/events/importEmployeeInformation5003Event: 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 /notificator/events/exportEmployeeInformation5003Event: 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 /notificator/events/importGuaranteeFundDetail5003Event: 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 /notificator/events/exportGuaranteeFundDetail5003Event: 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 /notificator/events/importEmployeePayrollLoan5003Event: 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 /notificator/events/exportEmployeePayrollLoan5003Event: 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 /notificator/events/importCompanyContributionsEvent5011Event: 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 /notificator/events/exportCompanyContributionsEvent5011Event: 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 /notificator/events/importSimplesNacionalTaxRegimeInformation5011Event: 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 /notificator/events/exportSimplesNacionalTaxRegimeInformation5011Event: 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 /notificator/events/importEstablishmentIdentification5011Event: 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 /notificator/events/exportEstablishmentIdentification5011Event: 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 /notificator/events/importInssLocationIdentification5011Event: 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 /notificator/events/exportInssLocationIdentification5011Event: 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 /notificator/events/importInssEsocialCategoryContribution5011Event: 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 /notificator/events/exportInssEsocialCategoryContribution5011Event: 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 /notificator/events/importInssMonthlyDetailContribution5011Event: 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 /notificator/events/exportInssMonthlyDetailContribution5011Event: 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 /notificator/events/importInssThirteenthSalaryDetailContribution5011Event: 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 /notificator/events/exportInssThirteenthSalaryDetailContribution5011Event: 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 /notificator/events/importEstablishmentSocialSecurityContribution5011Event: 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 /notificator/events/exportEstablishmentSocialSecurityContribution5011Event: 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 /notificator/events/importPisBase5011Event: 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 /notificator/events/exportPisBase5011Event: 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 /notificator/events/importCompanySocialSecurityContribution5011Event: 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 /notificator/events/exportCompanySocialSecurityContribution5011Event: 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 /notificator/events/importCompanyIncomeTaxEvent5012Event: 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 /notificator/events/exportCompanyIncomeTaxEvent5012Event: 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 /notificator/events/importIrrfMonthlyRevenueCode5012Event: 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 /notificator/events/exportIrrfMonthlyRevenueCode5012Event: 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 /notificator/events/importCompanyGuaranteeFundEvent5013Event: 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 /notificator/events/exportCompanyGuaranteeFundEvent5013Event: 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 /notificator/events/importEstablishmentIdentification5013Event: 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 /notificator/events/exportEstablishmentIdentification5013Event: 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 /notificator/events/importLocationIdentification5013Event: 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 /notificator/events/exportLocationIdentification5013Event: 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 /notificator/events/importGuaranteeFundDetail5013Event: 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 /notificator/events/exportGuaranteeFundDetail5013Event: 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 /notificator/events/importEmployeeIncomeTaxEvent5002Event: 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 /notificator/events/exportEmployeeIncomeTaxEvent5002Event: 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 /notificator/events/importPayrollInformation5002Event: 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 /notificator/events/exportPayrollInformation5002Event: 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 /notificator/events/importIrrfDetail5002Event: 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 /notificator/events/exportIrrfDetail5002Event: 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 /notificator/events/importIrrfMonthlyRevenueCode5002Event: 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 /notificator/events/exportIrrfMonthlyRevenueCode5002Event: 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 /notificator/events/importIncomeTaxComplementaryInformation5002Event: 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 /notificator/events/exportIncomeTaxComplementaryInformation5002Event: 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 /notificator/events/importDependentIdentification5002Event: 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 /notificator/events/exportDependentIdentification5002Event: 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 /notificator/events/importRevenueCodeInformation5002Event: 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 /notificator/events/exportRevenueCodeInformation5002Event: 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 /notificator/events/importDependentDeductibleIncome5002Event: 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 /notificator/events/exportDependentDeductibleIncome5002Event: 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 /notificator/events/importAlimonyBeneficiaries5002Event: 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 /notificator/events/exportAlimonyBeneficiaries5002Event: 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 /notificator/events/importSupplementaryPensionPlan5002Event: 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 /notificator/events/exportSupplementaryPensionPlan5002Event: 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 /notificator/events/importHealthPlanInformation5002Event: 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 /notificator/events/exportHealthPlanInformation5002Event: 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 /notificator/events/importHealthPlanDependentInformation5002Event: 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 /notificator/events/exportHealthPlanDependentInformation5002Event: 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 /notificator/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 /notificator/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 /notificator/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 /notificator/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 /notificator/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 /notificator/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 definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim subscriptionType: type: string enum: – CNPJ description: Tipo de inscrição.: * `CNPJ` – 1 – CNPJ. environmentType: type: string enum: – PRODUCTION – RESTRICTED_PRODUCTION description: Tipo de identificação do ambiente.: * `PRODUCTION` – 1 – Produção. * `RESTRICTED_PRODUCTION` – 2 – Produção restrita. layoutType: type: string enum: – S2200 – S2205 – S2206 – S3000 description: Tipo do layout do eSocial.: * `S2200` – S-2200 – Cadastramento Inicial do Vínculo e Admissão/Ingresso de Trabalhador * `S2205` – S-2205 – Alteração de Dados Cadastrais do Trabalhador * `S2206` – S-2206 – Alteração de contrato de trabalho * `S3000` – S-3000 – Exclusão de eventos. eventStatus: type: string enum: – SENDING_TO_GOVERNMENT – WAITING_GOVERNMENT_RETURN description: Status do evento do eSocial: * `SENDING_TO_GOVERNMENT` – Enviando evento para o governo * `WAITING_GOVERNMENT_RETURN` – Aguardando retorno. statusEventType: type: string enum: – PROCESSING – WAITING_GOVERNMENT_RETURN – GOVERNMENT_RETURN – ERROR – MANUAL_RECEIPT description: Status do evento do eSocial: * `PROCESSING` – Processando * `WAITING_GOVERNMENT_RETURN` – Aguardando retorno * `GOVERNMENT_RETURN` – Retorno do governo * `ERROR` – Erro * `MANUAL_RECEIPT` – Informado manualmente governmentReturnType: type: string enum: – RECEIPT_RETURNED – MESSAGE_RETURNED description: Tipo de retorno do governo: * `RECEIPT_RETURNED` – Número do recibo retornado * `MESSAGE_RETURNED` – Mensagem retornada userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: Check executado type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status resultBaseData: description: Retorno base para os endpoints. type: object required: – ok properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. default: esocialEventDTO: description: Evento do eSocial type: object required: – eventId – layoutType – xml – statusType properties: eventId: type: string maxLength: 36 description: ID do evento do eSocial layoutType: type: string allOf: – #/definitions/layoutType description: Tipo de leiaute do eSocial xml: type: string description: XML do evento do eSocial. statusType: type: string allOf: – #/definitions/eventStatus description: Status do evento do eSocial statusEsocialEventDTO: description: Informações do layout no governo type: object required: – eventId – statusEvent properties: eventId: type: string maxLength: 36 description: ID do evento do eSocial statusEvent: type: string allOf: – #/definitions/statusEventType description: Status do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceipt: type: string description: Número do recibo retornado do governo governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo errorMessage: type: string description: Mensagem de erro no processamento ou envio do evento ao governo layoutsPendingToSendDTO: description: type: object required: – id – identifier – layout – environmentType – resume – companyId – companyCode – companyName – xml properties: id: type: string description: ID do layout identifier: type: string description: Identificador do leiaute layout: type: string description: Evento eSocial environmentType: type: string description: Tipo de ambiente resume: type: string description: Resumo do leiaute companyId: type: string description: Empresa vinculada ao layout companyCode: type: string description: Código da empresa companyName: type: string description: Nome da empresa xml: type: string description: Xml do leiaute layoutsToRequestOnEDocsDTO: description: Leiautes para consultar no eDocs type: object required: – layoutId – identifier – companyId properties: layoutId: type: string description: Id do layout identifier: type: string description: Identificador do leiaute companyId: type: string description: Empresa layoutStatus: description: Informações do leiaute type: object required: – identifier – layout – version – rectificationType – environmentType – emissorType – emissorVersion – origin – importation – xml – startDate – resume – situation – status – leaveSubmissionType – company – companyRegistrationType – companyRegistration properties: id: type: string format: uuid description: Identificador único identifier: type: string maxLength: 36 description: Identificador do leiaute layout: type: integer format: int64 description: Tipo do leiaute type: string maxLength: 15 description: Versão do leiaute rectificationType: type: integer format: int64 description: Identificação de retificação rectificationReceipt: type: string maxLength: 23 description: Recibo retificador environmentType: type: integer format: int64 description: Identificação do ambiente emissorType: type: integer format: int64 description: Processo de emissão do evento emissorVersion: type: string maxLength: 20 description: Versão do processo de emissão origin: type: string maxLength: 20 description: Origem importation: type: string description: Importação xml: type: string description: XML reference: type: string description: Referência para o leiute startDate: type: string format: date description: Data de início resume: type: string maxLength: 100 description: Resumo do leiaute situation: type: integer format: int64 description: Situação do leiaute status: type: integer format: int64 description: Status do leiaute annualCalculationIndicator: type: boolean description: Indicativo de apuração anual default: false supplementaryLaborAgreementIndicator: type: boolean description: Indicativo de dissídio default: false leaveSubmissionType: type: integer format: int64 description: Tipo de envio do afastamento company: type: object allOf: – #/definitions/e070emp description: Empresa companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da empresa companyRegistration: type: string maxLength: 14 description: Inscrição da empresa employee: type: object allOf: – #/definitions/employee description: Colaborador employeeRegistration: type: string maxLength: 11 description: CPF do colaborador eSocialRegistration: type: string maxLength: 30 description: Matrícula eSocial do colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: layoutReturn: description: Dados de recibo type: object required: – layoutStatus – statusEvent properties: id: type: string format: uuid description: Identificador único layoutStatus: type: object allOf: – #/definitions/layoutStatus description: Evento statusEvent: type: string allOf: – #/definitions/statusEventType description: Status do evento do eSocial governmentReturnType: type: string allOf: – #/definitions/governmentReturnType description: Tipo de retorno do governo governmentReceipt: type: string description: Número do recibo retornado do governo governmentMessage: type: string description: Mensagens ou críticas retornadas do governo rawGovernmentReturn: type: string description: Retorno do governo errorMessage: type: string description: Mensagem de erro no processamento ou envio do evento ao governo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: layoutReturnTotalizer: description: Leiaute de retorno – Totalizador type: object required: – layoutReturn – layout – xml properties: id: type: string format: uuid description: Identificador único layoutReturn: type: object allOf: – #/definitions/layoutReturn description: Dados de recibo leiaute origem layout: type: integer format: int64 description: Leiaute de retorno xml: type: string description: XML createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eDocsDefinition: description: Definições do eDocs type: object required: – name – url – username – password – inscription properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome da configuração url: type: string description: URL username: type: string description: Usuário password: type: string description: Senha inscription: type: string description: CNPJ/CPF do certificado digital createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eDocsDefinitionCompany: description: Definições do eDocs da empresa type: object required: – eDocsDefinition – company properties: id: type: string format: uuid description: Identificador único eDocsDefinition: type: object allOf: – #/definitions/eDocsDefinition description: Definição do eDocs company: type: object allOf: – #/definitions/e070emp description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeContributionsEvent5001: description: S-5001 – Informações das contribuições sociais por trabalhador type: object required: – layoutReturnTotalizer properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtBasesTrab taxClassificationType: type: integer format: int64 description: Classificação tributária do contribuinte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: socialSecurityContribution5001: description: S-5001 – Cálculo da contribuição previdenciária do segurado type: object required: – employeeContributionsEvent5001 – inssRevenueCode properties: id: type: string format: uuid description: Identificador único employeeContributionsEvent5001: type: object allOf: – #/definitions/employeeContributionsEvent5001 description: Informações das contribuições sociais por trabalhador inssRevenueCode: type: integer format: int64 description: Código de receita contributionAmount: type: number format: double description: Valor da contribuição do segurado default: 0.0 discountedAmount: type: number format: double description: Valor efetivamente descontado do segurado default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssEstablishmentIdentification5001: description: S-5001 – Identificação do estabelecimento ou obra e lotação tributária – INSS type: object required: – employeeContributionsEvent5001 – registrationType – registrationNumber – locationCode properties: id: type: string format: uuid description: Identificador único employeeContributionsEvent5001: type: object allOf: – #/definitions/employeeContributionsEvent5001 description: Informações das contribuições sociais por trabalhador registrationType: type: integer format: int64 description: Tipo de inscrição registrationNumber: type: string maxLength: 14 description: Número de inscrição locationCode: type: string maxLength: 30 description: Código da lotação tributária createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssEmployeeInformation5001: description: S-5001 – Informações de matrícula e categoria do colaborador – INSS type: object required: – inssEstablishmentIdentification5001 – esocialCategory properties: id: type: string format: uuid description: Identificador único inssEstablishmentIdentification5001: type: object allOf: – #/definitions/inssEstablishmentIdentification5001 description: Identificação do estabelecimento ou obra e lotação esocialRegistration: type: string maxLength: 30 description: Matrícula eSocial esocialCategory: type: integer format: int64 description: Categoria eSocial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssDetailContribution5001: description: S-5001 – Bases de cálculo, descontos e deduções – INSS type: object required: – inssEmployeeInformation5001 – thirteenthSalaryIncidence – inssValueType properties: id: type: string format: uuid description: Identificador único inssEmployeeInformation5001: type: object allOf: – #/definitions/inssEmployeeInformation5001 description: Informações de matrícula e categoria do colaborador thirteenthSalaryIncidence: type: boolean description: Indicativo de 13º salário inssValueType: type: integer format: int64 description: Tipo de valor amount: type: number format: double description: Valor da base de cálculo, dedução ou desconto default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: thirdPartyContribution5001: description: S-5001 – Cálculo das contribuições sociais devidas a outras entidades e fundos type: object required: – inssEmployeeInformation5001 – inssRevenueCode properties: id: type: string format: uuid description: Identificador único inssEmployeeInformation5001: type: object allOf: – #/definitions/inssEmployeeInformation5001 description: Informações de matrícula e categoria do colaborador inssRevenueCode: type: integer format: int64 description: Código de receita contributionAmount: type: number format: double description: Valor da contribuição devida a outras entidades default: 0.0 discountedAmount: type: number format: double description: Valor efetivamente descontado do segurado default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: detailReferencePeriodContribution5001: description: S-5001 – Remuneração por período de referência type: object required: – inssEmployeeInformation5001 – referenceCompetence – thirteenthSalaryIncidence – inssValueType properties: id: type: string format: uuid description: Identificador único inssEmployeeInformation5001: type: object allOf: – #/definitions/inssEmployeeInformation5001 description: Informações de matrícula e categoria do colaborador referenceCompetence: type: string format: date description: Período de referência thirteenthSalaryIncidence: type: boolean description: Indicativo de 13º salário inssValueType: type: integer format: int64 description: Tipo de valor amount: type: number format: double description: Valor da base de cálculo, dedução ou desconto default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pisEstablishmentIdentification5001: description: S-5001 – Identificação do estabelecimento ou obra – PIS type: object required: – employeeContributionsEvent5001 – registrationType – registrationNumber properties: id: type: string format: uuid description: Identificador único employeeContributionsEvent5001: type: object allOf: – #/definitions/employeeContributionsEvent5001 description: Informações das contribuições sociais por trabalhador registrationType: type: integer format: int64 description: Tipo de inscrição registrationNumber: type: string maxLength: 14 description: Número de inscrição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pisEmployeeInformation5001: description: S-5001 – Informações de matrícula e categoria do colaborador – PIS type: object required: – pisEstablishmentIdentification5001 – esocialCategory properties: id: type: string format: uuid description: Identificador único pisEstablishmentIdentification5001: type: object allOf: – #/definitions/pisEstablishmentIdentification5001 description: Identificação do estabelecimento ou obra esocialRegistration: type: string maxLength: 30 description: Matrícula eSocial esocialCategory: type: integer format: int64 description: Categoria eSocial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pisDetailBase5001: description: S-5001 – Bases de cálculo – PIS type: object required: – pisEmployeeInformation5001 – thirteenthSalaryIncidence – pisValueType properties: id: type: string format: uuid description: Identificador único pisEmployeeInformation5001: type: object allOf: – #/definitions/pisEmployeeInformation5001 description: Informações de matrícula e categoria do colaborador thirteenthSalaryIncidence: type: boolean description: Indicativo de 13º salário pisValueType: type: integer format: int64 description: Tipo de valor amount: type: number format: double description: Valor da base de cálculo, dedução ou desconto default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeGuaranteeFundEvent5003: description: S-5003 – Informações do FGTS por trabalhador type: object required: – layoutReturnTotalizer – eventId properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtBasesFGTS dueDate: type: string format: date description: Data de vencimento do FGTS taxClassificationType: type: integer format: int64 description: Classificação tributária do contribuinte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: establishmentIdentification5003: description: S-5003 – Identificação do estabelecimento ou obra type: object required: – employeeGuaranteeFundEvent5003 properties: id: type: string format: uuid description: Identificador único employeeGuaranteeFundEvent5003: type: object allOf: – #/definitions/employeeGuaranteeFundEvent5003 description: Informações do FGTS por trabalhador registrationType: type: integer format: int64 description: Tipo de inscrição registrationNumber: type: string maxLength: 14 description: Número de inscrição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: locationIdentification5003: description: S-5003 – Identificação da lotação tributária type: object required: – establishmentIdentification5003 properties: id: type: string format: uuid description: Identificador único establishmentIdentification5003: type: object allOf: – #/definitions/establishmentIdentification5003 description: Identificação do estabelecimento locationCode: type: string maxLength: 30 description: Código da lotação tributária companyLinkedLocationType: type: integer format: int64 description: Tipo de lotação registrationType: type: integer format: int64 description: Tipo de inscrição da lotação registrationNumber: type: string maxLength: 14 description: Número de inscrição da lotação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeInformation5003: description: S-5003 – Informações relativas à matrícula e categoria do trabalhador type: object required: – locationIdentification5003 properties: id: type: string format: uuid description: Identificador único locationIdentification5003: type: object allOf: – #/definitions/locationIdentification5003 description: Identificação da lotação tributária esocialRegistration: type: string maxLength: 30 description: Matrícula eSocial esocialCategory: type: integer format: int64 description: Categoria eSocial default: 0 originEsocialCategory: type: integer format: int64 description: Categoria de origem workScheduleType: type: integer format: int64 description: Tipo de regime trabalhista successorCompanyCompensation: type: string maxLength: 1 description: Remuneração pela empresa sucessora dismissalDate: type: string format: date description: Data de desligamento dismissalType: type: integer format: int64 description: Motivo do desligamento terminationDate: type: string format: date description: Data do término terminationType: type: integer format: int64 description: Motivo do término do TSVE createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: guaranteeFundDetail5003: description: S-5003 – Informações sobre bases de cálculo e valores do FGTS type: object required: – employeeInformation5003 – fgtsIncidenceIndicator properties: id: type: string format: uuid description: Identificador único employeeInformation5003: type: object allOf: – #/definitions/employeeInformation5003 description: Informações do trabalhador fgtsValueType: type: integer format: int64 description: Tipo de valor default: 0 fgtsIncidenceIndicator: type: integer format: int64 description: Indicativo de incidência de FGTS base: type: number format: double description: Base de cálculo do FGTS default: 0.0 amount: type: number format: double description: Valor do FGTS a ser depositado default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeePayrollLoan5003: description: S-5003 – Informações relativas ao desconto do eConsignado type: object required: – employeeInformation5003 – financialInstitution – contractNumber properties: id: type: string format: uuid description: Identificador único employeeInformation5003: type: object allOf: – #/definitions/employeeInformation5003 description: Informações do trabalhador financialInstitution: type: string maxLength: 3 description: Instituição financeira contractNumber: type: string maxLength: 15 description: Número do contrato amount: type: number format: double description: Valor do desconto default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyContributionsEvent5011: description: S-5011 – Informações das contribuições sociais consolidadas por contribuinte type: object required: – layoutReturnTotalizer – eventId – indicatorContributionExistence – taxClassificationType properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtCS indicatorContributionExistence: type: integer format: int64 description: Indicativo de existência de bases e contribuições sociais discountedAmount: type: number format: double description: Valor efetivamente descontado do segurado default: 0.0 contributionAmount: type: number format: double description: Valor da contribuição do segurado default: 0.0 taxClassificationType: type: integer format: int64 description: Classificação tributária do contribuinte cooperativeIndicator: type: integer format: int64 description: Indicativo de cooperativa default: 0 constructionCompanyIndicator: type: integer format: int64 description: Indicativo de construtora default: 0 replacementContributionIndicator: type: integer format: int64 description: Indicativo de substituição da contribuição patronal reductionPercentage: type: number format: double description: Percentual de redução da contribuição default: 0.0 socialSecurityContributionPercentage: type: integer format: int64 description: Percentual de contribuição social pisTaxationIndicator: type: string maxLength: 1 description: Indicativo de tributação sobre folha de pagamento – PIS/PASEP createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: simplesNacionalTaxRegimeInformation5011: description: S-5011 – Informações de empresas tributadas pelo simples nacional type: object required: – companyContributionsEvent5011 properties: id: type: string format: uuid description: Identificador único companyContributionsEvent5011: type: object allOf: – #/definitions/companyContributionsEvent5011 description: Informações das contribuições sociais consolidadas monthlyContributionFactor: type: number format: double description: Fator a ser utilizado para cálculo da contribuição patronal do mês default: 0.0 thirteenthSalaryContributionFactor: type: number format: double description: Fator a ser utilizado para cálculo da contribuição patronal do 13º salário default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: establishmentIdentification5011: description: S-5011 – Identificação do estabelecimento e lotação tributária type: object required: – companyContributionsEvent5011 – registrationType – registrationNumber properties: id: type: string format: uuid description: Identificador único companyContributionsEvent5011: type: object allOf: – #/definitions/companyContributionsEvent5011 description: Informações das contribuições sociais consolidadas registrationType: type: integer format: int64 description: Tipo de inscrição registrationNumber: type: string maxLength: 14 description: Número de inscrição cnae: type: integer format: int64 description: Código CNAE default: 0 registrationNumberConstructionCompany: type: string maxLength: 14 description: CNPJ da empresa responsável pela inscrição no CNO ratRate: type: integer format: int64 description: Alíquota RAT default: 0 fapFactor: type: number format: double description: Fator Acidentário de Prevenção – FAP default: 0.0 adjustedRatRate: type: number format: double description: Alíquota RAT após ajuste pelo FAP default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssLocationIdentification5011: description: S-5011 – Identificação da lotação tributária – INSS type: object required: – establishmentIdentification5011 – locationCode properties: id: type: string format: uuid description: Identificador único establishmentIdentification5011: type: object allOf: – #/definitions/establishmentIdentification5011 description: Identificação do estabelecimento e lotação tributária locationCode: type: string maxLength: 30 description: Código da lotação tributária fpas: type: integer format: int64 description: Código FPAS default: 0 thirdPartyCode: type: integer format: int64 description: Código de terceiros default: 0 thirdPartySuspensionCode: type: integer format: int64 description: Código de terceiros suspenso default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssEsocialCategoryContribution5011: description: S-5011 – Bases de cálculo contribuição previdenciária por categoria eSocial type: object required: – inssLocationIdentification5011 properties: id: type: string format: uuid description: Identificador único inssLocationIdentification5011: type: object allOf: – #/definitions/inssLocationIdentification5011 description: Identificação da lotação tributária contributionIncidenceType: type: integer format: int64 description: Tipo de incidência para fins de apuração da contribuição previdenciária default: 0 esocialCategory: type: integer format: int64 description: Categoria eSocial default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssMonthlyDetailContribution5011: description: S-5011 – Valores de bases, contribuição previdenciária e deduções – Mensal type: object required: – inssEsocialCategoryContribution5011 properties: id: type: string format: uuid description: Identificador único inssEsocialCategoryContribution5011: type: object allOf: – #/definitions/inssEsocialCategoryContribution5011 description: Bases de cálculo por categoria inssValueType: type: integer format: int64 description: Tipo de valor default: 0 amount: type: number format: double description: Valor da base de cálculo, dedução ou desconto default: 0.0 sestCalculatedAmount: type: number format: double description: Valor calculado – SEST default: 0.0 senatCalculatedAmount: type: number format: double description: Valor calculado – SENAT default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inssThirteenthSalaryDetailContribution5011: description: S-5011 – Valores de bases, contribuição preivdenciária e deduções – 13º salário type: object required: – inssEsocialCategoryContribution5011 properties: id: type: string format: uuid description: Identificador único inssEsocialCategoryContribution5011: type: object allOf: – #/definitions/inssEsocialCategoryContribution5011 description: Bases de cálculo por categoria inssValueType: type: integer format: int64 description: Tipo de valor default: 0 amount: type: number format: double description: Valor da base de cálculo, dedução ou desconto default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: establishmentSocialSecurityContribution5011: description: S-5011 – Contribuição previdenciária consolidada por estabelecimento e CR type: object required: – establishmentIdentification5011 properties: id: type: string format: uuid description: Identificador único establishmentIdentification5011: type: object allOf: – #/definitions/establishmentIdentification5011 description: Identificação do estabelecimento e lotação tributária inssRevenueCode: type: integer format: int64 description: Código de receita default: 0 contributionAmount: type: number format: double description: Valor da contribuição previdenciária default: 0.0 suspendedAmount: type: number format: double description: Valor da contribuição suspensa default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pisBase5011: description: S-5011 – Bases de cálculo – PIS type: object required: – establishmentIdentification5011 properties: id: type: string format: uuid description: Identificador único establishmentIdentification5011: type: object allOf: – #/definitions/establishmentIdentification5011 description: Identificação do estabelecimento e lotação tributária amount: type: number format: double description: Base de cálculo – PIS/PASEP default: 0.0 suspendedAmount: type: number format: double description: Base de cálculo suspensa – PIS/PASEP default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companySocialSecurityContribution5011: description: S-5011 – Contribuição previdenciária consolidada por CR type: object required: – companyContributionsEvent5011 properties: id: type: string format: uuid description: Identificador único companyContributionsEvent5011: type: object allOf: – #/definitions/companyContributionsEvent5011 description: Informações das contribuições sociais consolidadas inssRevenueCode: type: integer format: int64 description: Código de receita default: 0 contributionAmount: type: number format: double description: Valor da contribuição previdenciária default: 0.0 suspendedAmount: type: number format: double description: Valor da contribuição suspensa default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyIncomeTaxEvent5012: description: S-5012 – Imposto de renda retido na fonte consolidado por contribuinte type: object required: – layoutReturnTotalizer – eventId properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtIrrf indicatorContributionExistence: type: integer format: int64 description: Indicador de existência de informação default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: irrfMonthlyRevenueCode5012: description: S-5012 – Informações consolidadas por código de receita mensal type: object required: – companyIncomeTaxEvent5012 – irrfRevenueCode properties: id: type: string format: uuid description: Identificador único companyIncomeTaxEvent5012: type: object allOf: – #/definitions/companyIncomeTaxEvent5012 description: Imposto de renda retido na fonte consolidado por contribuinte irrfRevenueCode: type: integer format: int64 description: Código de receita IRRF amount: type: number format: double description: Valor default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyGuaranteeFundEvent5013: description: S-5013 – Informações do FGTS consolidadas por contribuinte type: object required: – layoutReturnTotalizer – eventId properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtFGTS indicatorContributionExistence: type: integer format: int64 description: Indicativo de existência de valores de FGTS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: establishmentIdentification5013: description: S-5013 – Identificação do estabelecimento ou obra type: object required: – companyGuaranteeFundEvent5013 properties: id: type: string format: uuid description: Identificador único companyGuaranteeFundEvent5013: type: object allOf: – #/definitions/companyGuaranteeFundEvent5013 description: Informações do FGTS consolidadas por contribuinte registrationType: type: integer format: int64 description: Tipo de inscrição registrationNumber: type: string maxLength: 14 description: Número de inscrição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: locationIdentification5013: description: S-5013 – Identificação da lotação tributária type: object required: – establishmentIdentification5013 properties: id: type: string format: uuid description: Identificador único establishmentIdentification5013: type: object allOf: – #/definitions/establishmentIdentification5013 description: Identificação do estabelecimento ou obra locationCode: type: string maxLength: 30 description: Código da lotação tributária companyLinkedLocationType: type: integer format: int64 description: Tipo de lotação registrationType: type: integer format: int64 description: Tipo de inscrição da lotação registrationNumber: type: string maxLength: 14 description: Número de inscrição da lotação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: guaranteeFundDetail5013: description: S-5013 – Informações sobre bases de cálculo e valores do FGTS type: object required: – locationIdentification5013 – fgtsIncidenceIndicator properties: id: type: string format: uuid description: Identificador único locationIdentification5013: type: object allOf: – #/definitions/locationIdentification5013 description: Identificação da lotação tributária fgtsValueType: type: integer format: int64 description: Tipo de valor default: 0 fgtsIncidenceIndicator: type: integer format: int64 description: Indicativo de incidência de FGTS base: type: number format: double description: Base de cálculo do FGTS default: 0.0 amount: type: number format: double description: Valor do FGTS default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeIncomeTaxEvent5002: description: S-5002 – Imposto de renda retido na fonte por trabalhador type: object required: – layoutReturnTotalizer – eventId properties: id: type: string format: uuid description: Identificador único layoutReturnTotalizer: type: object allOf: – #/definitions/layoutReturnTotalizer description: Leiaute de retorno – Totalizador eventId: type: string maxLength: 36 description: Identificação do evento evtIrrfBenef createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: payrollInformation5002: description: S-5002 – Informações do demonstrativo de valores devidos type: object required: – employeeIncomeTaxEvent5002 – referencePeriod – paymentDate properties: id: type: string format: uuid description: Identificador único employeeIncomeTaxEvent5002: type: object allOf: – #/definitions/employeeIncomeTaxEvent5002 description: IRRF por trabalhador referencePeriod: type: string format: date description: Período de referência paymentDate: type: string format: date description: Data de pagamento esocialCategory: type: integer format: int64 description: Categoria eSocial default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: irrfDetail5002: description: S-5002 – Detalhamento dos valores de IRRF type: object required: – payrollInformation5002 properties: id: type: string format: uuid description: Identificador único payrollInformation5002: type: object allOf: – #/definitions/payrollInformation5002 description: Informações do demonstrativo de valores devidos irrfValueType: type: integer format: int64 description: Tipo de valor de IRRF default: 0 amount: type: number format: double description: Valor default: 0.0 incomeDescription: type: string maxLength: 100 description: Descrição do rendimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: irrfMonthlyRevenueCode5002: description: S-5002 – Totalização dos rendimentos tributáveis, deduções e isenções – Mensal type: object required: – employeeIncomeTaxEvent5002 – irrfRevenueCode properties: id: type: string format: uuid description: Identificador único employeeIncomeTaxEvent5002: type: object allOf: – #/definitions/employeeIncomeTaxEvent5002 description: Imposto de renda retido na fonte por trabalhador irrfRevenueCode: type: integer format: int64 description: Código de receita IRRF incomeTaxType: type: integer format: int64 description: Tipo de rendimento do imposto de renda default: 0 amount: type: number format: double description: Valor default: 0.0 incomeDescription: type: string description: Descrição do rendimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: incomeTaxComplementaryInformation5002: description: S-5002 – Informações complementares type: object required: – employeeIncomeTaxEvent5002 properties: id: type: string format: uuid description: Identificador único employeeIncomeTaxEvent5002: type: object allOf: – #/definitions/employeeIncomeTaxEvent5002 description: Imposto de renda retido na fonte por trabalhador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentIdentification5002: description: S-5002 – Identificação de dependentes type: object required: – incomeTaxComplementaryInformation5002 – registration properties: id: type: string format: uuid description: Identificador único incomeTaxComplementaryInformation5002: type: object allOf: – #/definitions/incomeTaxComplementaryInformation5002 description: Informações complementares registration: type: string maxLength: 11 description: CPF do dependente incomeTaxDeductible: type: string maxLength: 1 description: Dependente para fins de dedução de IR birthDate: type: string format: date description: Data de nascimento name: type: string maxLength: 70 description: Nome do dependente dependencyType: type: integer format: int64 description: Tipo de dependência description: type: string maxLength: 100 description: Descrição do dependente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: revenueCodeInformation5002: description: S-5002 – Informações por código de receita type: object required: – incomeTaxComplementaryInformation5002 – irrfRevenueCode properties: id: type: string format: uuid description: Identificador único incomeTaxComplementaryInformation5002: type: object allOf: – #/definitions/incomeTaxComplementaryInformation5002 description: Informações complementares irrfRevenueCode: type: integer format: int64 description: Código de receita IRRF createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentDeductibleIncome5002: description: S-5002 – Dedução de dependentes por tipo de rendimento type: object required: – revenueCodeInformation5002 – registration properties: id: type: string format: uuid description: Identificador único revenueCodeInformation5002: type: object allOf: – #/definitions/revenueCodeInformation5002 description: Informações por código de receita irrfDeductionIncomeType: type: integer format: int64 description: Tipo de rendimento para dedução IRRF default: 0 registration: type: string maxLength: 11 description: CPF do dependente amount: type: number format: double description: Valor da dedução default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: alimonyBeneficiaries5002: description: S-5002 – Beneficiários de pensão alimentícia type: object required: – revenueCodeInformation5002 – registration properties: id: type: string format: uuid description: Identificador único revenueCodeInformation5002: type: object allOf: – #/definitions/revenueCodeInformation5002 description: Informações por código de receita irrfAlimonyIncomeType: type: integer format: int64 description: Tipo de rendimento para pensão alimentícia IRRF default: 0 registration: type: string maxLength: 11 description: CPF do beneficiário amount: type: number format: double description: Valor da pensão alimentícia default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: supplementaryPensionPlan5002: description: S-5002 – Previdência complementar type: object required: – revenueCodeInformation5002 – entityRegistration properties: id: type: string format: uuid description: Identificador único revenueCodeInformation5002: type: object allOf: – #/definitions/revenueCodeInformation5002 description: Informações por código de receita irrfSupplementaryPensionType: type: integer format: int64 description: Tipo de previdência complementar IRRF default: 0 entityRegistration: type: string maxLength: 14 description: CNPJ da entidade de previdência monthlyAmount: type: number format: double description: Valor mensal default: 0.0 thirteenthSalaryAmount: type: number format: double description: Valor 13º salário default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: healthPlanInformation5002: description: S-5002 – Informações de plano de saúde type: object required: – incomeTaxComplementaryInformation5002 – healthInsuranceProviderRegistration properties: id: type: string format: uuid description: Identificador único incomeTaxComplementaryInformation5002: type: object allOf: – #/definitions/incomeTaxComplementaryInformation5002 description: Informações complementares healthInsuranceProviderRegistration: type: string maxLength: 14 description: CNPJ da operadora nationalHealthAgencyRegistration: type: string maxLength: 6 description: Registro ANS holderAmount: type: number format: double description: Valor titular default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: healthPlanDependentInformation5002: description: S-5002 – Informações de dependentes no plano de saúde type: object required: – healthPlanInformation5002 – dependentRegistration properties: id: type: string format: uuid description: Identificador único healthPlanInformation5002: type: object allOf: – #/definitions/healthPlanInformation5002 description: Informações de plano de saúde dependentRegistration: type: string maxLength: 11 description: CPF do dependente amount: type: number format: double description: Valor dependente default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – codPes – nomPes properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 14 description: CNPJ/CPF excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employee: description: Colaborador type: object required: – hireDate – code properties: id: type: string format: uuid description: Identificador único employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento code: type: integer format: int64 description: Cadastro eSocialRegistration: type: string description: Matrícula do eSocial companyTransferDate: type: string format: date description: Data de transferência deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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