• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/hcm_tax_conference (HCM - Tax Conference Processor)/HCM – Tax Conference Processor (processor)
Mais pesquisados:Customização, Tutorial, Documentação

HCM – Tax Conference Processor (processor)

14 views 0 09/11/2026 Atualizado em 12/11/2026 integrador

2.0info: 2.7.0 HCM – Tax Conference Processor description: HCM – Tax Conference Processor x-senior-domain: HCM – Tax Conference Processor x-senior-domain-path: hcm_tax_conference x-senior-service-path: processor 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_tax_conferencesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /processor/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/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 /processor/queries/exportPendencyCalculateBatch: 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 /processor/queries/exportTaxPendency: 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 /processor/queries/exportEmployeeTaxConference: 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 /processor/queries/exportEmployeeInssConference: 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 /processor/queries/exportEmployeeInssBase: 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 /processor/queries/exportEmployeeInssDetail: 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 /processor/queries/exportEmployeePisBase: 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 /processor/queries/exportEmployeePisDetail: 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 /processor/queries/exportEmployeeIrrfDetail: 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 /processor/queries/exportEmployeeIrrfDetailIncomeDescription: 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 /processor/queries/exportCompanyIrrfDetail: 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 /processor/queries/exportIrrfValueTypeGroup: 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 /processor/queries/exportIrrfOriginPaymentType: 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 /processor/queries/exportEmployeeInssRevenueCode: 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 /processor/queries/exportEmployeePisRevenueCode: 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 /processor/queries/exportEmployeeIrrfMonthlyRevenueCode: 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 /processor/queries/exportEmployeeIncomeTaxDescription: 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 /processor/queries/exportCompanyBranchInssRevenueCode: 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 /processor/queries/exportCompanyInssRevenueCode: 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 /processor/queries/exportCompanyBranchPisRevenueCode: 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 /processor/queries/exportCompanyPisRevenueCode: 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 /processor/queries/exportCompanyIrrfMonthlyRevenueCode: 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 /processor/queries/exportEmployeeFgtsConference: 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 /processor/queries/exportEmployeePayrollLoanConference: 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 /processor/queries/exportEmployeeFgtsBase: 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 /processor/queries/exportEmployeeFgtsDetail: 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 /processor/queries/exportLocationFgtsConference: 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 /processor/queries/exportLocationFgtsDetail: 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 /processor/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 /processor/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 /processor/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 /processor/queries/exportE070fil: 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 /processor/queries/exportCompanyLinkedLocation: 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 /processor/queries/exportEmployeeIrrfDependentDeduction: 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 /processor/queries/exportEmployeeIrrfAlimony: 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 /processor/queries/exportEmployeeIrrfDependentIdentification: 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 /processor/queries/exportEmployeeIrrfHealthPlanHolder: 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 /processor/queries/exportEmployeeIrrfHealthPlanDependent: 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 /processor/queries/exportEmployeeIrrfHealthPlanContract: 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 /processor/queries/exportEmployeeIrrfComplementaryPension: 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 /processor/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 /processor/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 /processor/actions/calculateSynthetic: post: description: Inicia o cálculo sintético dos impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – taxCalculationIndicator – generationType properties: company: type: array items: type: string description: Empresa competence: type: string format: date description: Competência taxCalculationIndicator: type: string allOf: – #/definitions/taxCalculationIndicator description: Indicativo de apuração generationType: type: string allOf: – #/definitions/generationType description: Tipo de geração responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador da geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/undoSoftExclude: post: description: Desfaz a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/actions/importPendencyCalculateBatch: 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 /processor/actions/importTaxPendency: 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 /processor/actions/importEmployeeTaxConference: 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 /processor/actions/importEmployeeInssConference: 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 /processor/actions/importEmployeeInssBase: 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 /processor/actions/importEmployeeInssDetail: 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 /processor/actions/importEmployeePisBase: 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 /processor/actions/importEmployeePisDetail: 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 /processor/actions/importEmployeeIrrfDetail: 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 /processor/actions/importEmployeeIrrfDetailIncomeDescription: 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 /processor/actions/importCompanyIrrfDetail: 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 /processor/actions/importIrrfValueTypeGroup: 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 /processor/actions/importIrrfOriginPaymentType: 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 /processor/actions/importEmployeeInssRevenueCode: 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 /processor/actions/importEmployeePisRevenueCode: 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 /processor/actions/importEmployeeIrrfMonthlyRevenueCode: 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 /processor/actions/importEmployeeIncomeTaxDescription: 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 /processor/actions/importCompanyBranchInssRevenueCode: 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 /processor/actions/importCompanyInssRevenueCode: 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 /processor/actions/importCompanyBranchPisRevenueCode: 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 /processor/actions/importCompanyPisRevenueCode: 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 /processor/actions/importCompanyIrrfMonthlyRevenueCode: 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 /processor/actions/importEmployeeFgtsConference: 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 /processor/actions/importEmployeePayrollLoanConference: 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 /processor/actions/importEmployeeFgtsBase: 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 /processor/actions/importEmployeeFgtsDetail: 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 /processor/actions/importLocationFgtsConference: 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 /processor/actions/importLocationFgtsDetail: 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 /processor/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 /processor/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 /processor/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 /processor/actions/importE070fil: 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 /processor/actions/importCompanyLinkedLocation: 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 /processor/actions/importEmployeeIrrfDependentDeduction: 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 /processor/actions/importEmployeeIrrfAlimony: 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 /processor/actions/importEmployeeIrrfDependentIdentification: 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 /processor/actions/importEmployeeIrrfHealthPlanHolder: 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 /processor/actions/importEmployeeIrrfHealthPlanDependent: 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 /processor/actions/importEmployeeIrrfHealthPlanContract: 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 /processor/actions/importEmployeeIrrfComplementaryPension: 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 /processor/signals/createBatches: post: description: Inicia a criação dos lotes para o cálculo dos impostos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – annualCalculationIndicator – fgtsTerminationCollection – competenceCalculation properties: processId: type: string description: Identificador da geração company: type: array items: type: string description: Empresa annualCalculationIndicator: type: boolean description: Indicativo de apuração mensal fgtsTerminationCollection: type: boolean description: Recolhimento do FGTS na rescisão competenceCalculation: type: string format: date description: Competência de apuração calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/calculateBatch: post: description: Inicia o cálculo dos imposto em lotes tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – annualCalculationIndicator – competenceCalculation – batchSequence – companyInformation – totalCompanies properties: processId: type: string description: Identificador da geração annualCalculationIndicator: type: boolean description: Indicativo de apuração mensal competenceCalculation: type: string format: date description: Competência de apuração batchSequence: type: integer format: int64 description: Sequencial do lote companyInformation: type: object allOf: – #/definitions/companyInformationDTO description: Informações da empresa totalCompanies: type: integer format: int64 description: Empresas processadas minimum: 0 calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/signals/finishedProcess: post: description: Finaliza o processo de cálculo dos impostos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType – processTypeDescription – startDate – startedBy – unit properties: processId: type: string description: Identificador único do processo processType: type: string description: Tipo de processo processTypeDescription: type: string description: Descrição do tipo do Processo. startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados default: 0 processed: type: integer format: int64 description: Quantidade total de registros processados processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro default: 0 successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso default: 0 unprocessed: type: integer format: int64 description: Quantidade de registros não processados default: 0 startedBy: type: string description: Usuário que iniciou o processo unit: type: string description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) cancelledBy: type: string description: Usuário que cancelou o processo cancellationDate: type: string format: date-time description: Data de cancelamento do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /processor/events/taxCalculationProvisionConsolidationFinished: post: description: Consolidação fiscal da Provisão de Férias ou de 13º Salário finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /processor/events/finishEmployeeCalculateBatch: post: description: Cálculo de código de receita dos colaboradores finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: errorMessage: type: string description: Mensagem de erro calculationParameters: type: string description: Parâmetros do cálculo serializados em JSON responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /processor/events/accountingTaxCalculationBatchFinished: post: description: Notifica a conclusão do cálculo de tributos para o fluxo de contabilização x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – companyId – competence – postingDate – batchDescription properties: processId: type: string maxLength: 36 description: Identificador do processo batchId: type: string maxLength: 36 description: Identificador do lote companyId: type: string maxLength: 36 description: Identificador da empresa competence: type: string format: date description: Competência calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo postingDate: type: string format: date description: Data de lançamento batchDescription: type: string description: Descrição do lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /processor/events/importPendencyCalculateBatchEvent: 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 /processor/events/exportPendencyCalculateBatchEvent: 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 /processor/events/importTaxPendencyEvent: 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 /processor/events/exportTaxPendencyEvent: 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 /processor/events/importEmployeeTaxConferenceEvent: 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 /processor/events/exportEmployeeTaxConferenceEvent: 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 /processor/events/importEmployeeInssConferenceEvent: 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 /processor/events/exportEmployeeInssConferenceEvent: 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 /processor/events/importEmployeeInssBaseEvent: 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 /processor/events/exportEmployeeInssBaseEvent: 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 /processor/events/importEmployeeInssDetailEvent: 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 /processor/events/exportEmployeeInssDetailEvent: 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 /processor/events/importEmployeePisBaseEvent: 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 /processor/events/exportEmployeePisBaseEvent: 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 /processor/events/importEmployeePisDetailEvent: 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 /processor/events/exportEmployeePisDetailEvent: 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 /processor/events/importEmployeeIrrfDetailEvent: 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 /processor/events/exportEmployeeIrrfDetailEvent: 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 /processor/events/importEmployeeIrrfDetailIncomeDescriptionEvent: 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 /processor/events/exportEmployeeIrrfDetailIncomeDescriptionEvent: 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 /processor/events/importCompanyIrrfDetailEvent: 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 /processor/events/exportCompanyIrrfDetailEvent: 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 /processor/events/importIrrfValueTypeGroupEvent: 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 /processor/events/exportIrrfValueTypeGroupEvent: 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 /processor/events/importIrrfOriginPaymentTypeEvent: 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 /processor/events/exportIrrfOriginPaymentTypeEvent: 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 /processor/events/importEmployeeInssRevenueCodeEvent: 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 /processor/events/exportEmployeeInssRevenueCodeEvent: 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 /processor/events/importEmployeePisRevenueCodeEvent: 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 /processor/events/exportEmployeePisRevenueCodeEvent: 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 /processor/events/importEmployeeIrrfMonthlyRevenueCodeEvent: 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 /processor/events/exportEmployeeIrrfMonthlyRevenueCodeEvent: 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 /processor/events/importEmployeeIncomeTaxDescriptionEvent: 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 /processor/events/exportEmployeeIncomeTaxDescriptionEvent: 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 /processor/events/importCompanyBranchInssRevenueCodeEvent: 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 /processor/events/exportCompanyBranchInssRevenueCodeEvent: 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 /processor/events/importCompanyInssRevenueCodeEvent: 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 /processor/events/exportCompanyInssRevenueCodeEvent: 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 /processor/events/importCompanyBranchPisRevenueCodeEvent: 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 /processor/events/exportCompanyBranchPisRevenueCodeEvent: 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 /processor/events/importCompanyPisRevenueCodeEvent: 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 /processor/events/exportCompanyPisRevenueCodeEvent: 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 /processor/events/importCompanyIrrfMonthlyRevenueCodeEvent: 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 /processor/events/exportCompanyIrrfMonthlyRevenueCodeEvent: 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 /processor/events/importEmployeeFgtsConferenceEvent: 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 /processor/events/exportEmployeeFgtsConferenceEvent: 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 /processor/events/importEmployeePayrollLoanConferenceEvent: 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 /processor/events/exportEmployeePayrollLoanConferenceEvent: 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 /processor/events/importEmployeeFgtsBaseEvent: 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 /processor/events/exportEmployeeFgtsBaseEvent: 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 /processor/events/importEmployeeFgtsDetailEvent: 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 /processor/events/exportEmployeeFgtsDetailEvent: 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 /processor/events/importLocationFgtsConferenceEvent: 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 /processor/events/exportLocationFgtsConferenceEvent: 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 /processor/events/importLocationFgtsDetailEvent: 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 /processor/events/exportLocationFgtsDetailEvent: 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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/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 /processor/events/importE070filEvent: 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 /processor/events/exportE070filEvent: 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 /processor/events/importCompanyLinkedLocationEvent: 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 /processor/events/exportCompanyLinkedLocationEvent: 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 /processor/events/importEmployeeIrrfDependentDeductionEvent: 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 /processor/events/exportEmployeeIrrfDependentDeductionEvent: 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 /processor/events/importEmployeeIrrfAlimonyEvent: 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 /processor/events/exportEmployeeIrrfAlimonyEvent: 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 /processor/events/importEmployeeIrrfDependentIdentificationEvent: 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 /processor/events/exportEmployeeIrrfDependentIdentificationEvent: 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 /processor/events/importEmployeeIrrfHealthPlanHolderEvent: 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 /processor/events/exportEmployeeIrrfHealthPlanHolderEvent: 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 /processor/events/importEmployeeIrrfHealthPlanDependentEvent: 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 /processor/events/exportEmployeeIrrfHealthPlanDependentEvent: 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 /processor/events/importEmployeeIrrfHealthPlanContractEvent: 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 /processor/events/exportEmployeeIrrfHealthPlanContractEvent: 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 /processor/events/importEmployeeIrrfComplementaryPensionEvent: 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 /processor/events/exportEmployeeIrrfComplementaryPensionEvent: 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 /processor/entities/employeeTaxConference: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeTaxConference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeInssConference: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeInssConference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeePisBase: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeePisBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeIrrfDetail: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeIrrfDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/irrfValueTypeGroup: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/irrfValueTypeGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/irrfOriginPaymentType: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/irrfOriginPaymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeIrrfMonthlyRevenueCode: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeIrrfMonthlyRevenueCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeFgtsConference: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeFgtsConference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeFgtsBase: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeFgtsBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/locationFgtsConference: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/locationFgtsConference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /processor/entities/employeeIrrfHealthPlanHolder: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeIrrfHealthPlanHolder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: pendencySituation: type: string enum: – PENDING – PROCESSING description: Status da pendência: * `PENDING` – Pendente * `PROCESSING` – Processando taxType: type: string enum: – INSS – IRRF – PIS – FGTS description: Tipo de imposto: * `INSS` – INSS – Instituto Nacional do Seguro Social * `IRRF` – IRRF – Imposto de Renda Retido na Fonte * `PIS` – PIS – Programa de Integração Social * `FGTS` – FGTS – Fundo de Garantia do Tempo de Serviço taxPendencyType: type: string enum: – INSS_PIS – IRRF – FGTS description: Tipo de imposto: * `INSS_PIS` – Instituto Nacional do Seguro Social e Programa de Integração Social * `IRRF` – Imposto de Renda Retido na Fonte * `FGTS` – Fundo de Garantia do Tempo de Serviço taxCalculationIndicator: type: string enum: – MONTHLY – ANNUAL description: Indicativo de apuração da conferência de impostos: * `MONTHLY` – Mensal * `ANNUAL` – Anual generationType: type: string enum: – ONLY_FGTS_TERMINATION_COLLECTION – ALL_TAXES description: Tipo de geração: * `ONLY_FGTS_TERMINATION_COLLECTION` – Somente FGTS com recolhimento na rescisão * `ALL_TAXES` – Todos os impostos eSocialDismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 description: Tipo de desligamento eSocial: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Rescisão com justa causa, por iniciativa do empregador * `V2` – 2 – Rescisão sem justa causa, por iniciativa do empregador * `V3` – 3 – Rescisão antecipada do contrato a termo por iniciativa do empregador * `V4` – 4 – Rescisão antecipada do contrato a termo por iniciativa do empregado * `V5` – 5 – Rescisão por culpa recíproca * `V6` – 6 – Rescisão por término do contrato a termo * `V7` – 7 – Rescisão do contrato de trabalho por iniciativa do empregado * `V8` – 8 – Rescisão do contrato de trabalho por interesse do(a) empregado(a), nas hipóteses previstas nos arts. 394 e 483, § 1º, da CLT * `V9` – 9 – Rescisão por opção do empregado em virtude de falecimento do empregador individual ou empregador doméstico * `V10` – 10 – Rescisão por falecimento do empregado * `V11` – 11 – Transferência de empregado para empresa do mesmo grupo empresarial que tenha assumido os encargos trabalhistas, sem que tenha havido rescisão do contrato de trabalho * `V12` – 12 – Transferência de empregado da empresa consorciada para o consórcio que tenha assumido os encargos trabalhistas, e vice-versa, sem que tenha havido rescisão do contrato de trabalho * `V13` – 13 – Transferência de empregado de empresa ou consórcio, para outra empresa ou consórcio que tenha assumido os encargos trabalhistas por motivo de sucessão (fusão, cisão ou incorporação), sem que tenha havido rescisão do contrato de trabalho * `V14` – 14 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades ou falecimento do empregador individual ou empregador doméstico sem continuação da atividade * `V15` – 15 – Rescisão do contrato de aprendizagem por desempenho insuficiente, inadaptação ou ausência injustificada do aprendiz à escola que implique perda do ano letivo (Válido até 18/07/2021) * `V16` – 16 – Declaração de nulidade do contrato de trabalho por infringência ao inciso II do art. 37 da Constituição Federal, quando mantido o direito ao salário * `V17` – 17 – Rescisão indireta do contrato de trabalho * `V18` – 18 – Aposentadoria compulsória (Válido até 18/07/2021) * `V19` – 19 – Aposentadoria por idade (Válido até 18/07/2021) * `V20` – 20 – Aposentadoria por idade e tempo de contribuição (Válido até 18/07/2021) * `V21` – 21 – Reforma militar * `V22` – 22 – Reserva militar * `V23` – 23 – Exoneração * `V24` – 24 – Demissão * `V25` – 25 – Vacância de cargo efetivo * `V26` – 26 – Rescisão do contrato de trabalho por paralisação temporária ou definitiva da empresa, estabelecimento ou parte das atividades motivada por atos de autoridade municipal, estadual ou federal * `V27` – 27 – Rescisão por motivo de força maior * `V28` – 28 – Término da cessão/requisição (Válido até 18/07/2021) * `V29` – 29 – Redistribuição * `V30` – 30 – Mudança de regime trabalhista * `V31` – 31 – Reversão de reintegração * `V32` – 32 – Extravio de militar * `V33` – 33 – Rescisão por acordo entre as partes (art. 484-A da CLT) * `V34` – 34 – Transferência de titularidade do empregado doméstico para outro representante da mesma unidade familiar * `V35` – 35 – Extinção do contrato de trabalho intermitente (Válido até 30/06/2018) * `V37` – 37 – Remoção, em caso de alteração do órgão declarante * `V38` – 38 – Aposentadoria, exceto por invalidez * `V39` – 39 – Aposentadoria de servidor estatutário, por invalidez * `V40` – 40 – Término do exercício do mandato eletivo * `V41` – 41 – Rescisão do contrato de aprendizagem por desempenho insuficiente ou inadaptação do aprendiz * `V42` – 42 – Rescisão do contrato de aprendizagem por ausência injustificada do aprendiz à escola que implique perda do ano letivo * `V43` – 43 – Transferência de empregado de empresa considerada inapta por inexistência de fato * `V44` – 44 – Agrupamento contratual * `V45` – 45 – Exclusão de militar das Forças Armadas do serviço ativo, com efeitos financeiros * `V46` – 46 – Exclusão de militar das Forças Armadas do serviço ativo, sem efeitos financeiros * `V47` – 47 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades * `V48` – 48 – Falecimento do empregador individual sem continuação da atividade * `V49` – 49 – Falecimento do empregador doméstico sem continuação da atividade dismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V99 description: Tipo de desligamento: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Exoneração do diretor não empregado sem justa causa, por deliberação da assembleia, dos sócios cotistas ou da autoridade competente * `V2` – 2 – Término de mandato do diretor não empregado que não tenha sido reconduzido ao cargo * `V3` – 3 – Exoneração a pedido de diretor não empregado * `V4` – 4 – Exoneração do diretor não empregado por culpa recíproca ou força maior * `V5` – 5 – Morte do diretor não empregado * `V6` – 6 – Exoneração do diretor não empregado por falência, encerramento ou supressão de parte da empresa * `V7` – 7 – Mudança de CPF * `V99` – 99 – Outros fgtsOriginType: type: string enum: – MONTHLY – MONTHLY_PREVIOUS_PERIODS – DISMISSAL – DISMISSAL_PREVIOUS_PERIODS description: Tipo de origem: * `MONTHLY` – Mensal * `MONTHLY_PREVIOUS_PERIODS` – Mensal – Períodos anteriores – dissídio * `DISMISSAL` – Rescisão * `DISMISSAL_PREVIOUS_PERIODS` – Rescisão – Períodos anteriores – dissídio companyLinkedLocationType: type: string enum: – V01 – V03 – V04 – V90 – V91 contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim employeeCompanyDTO: description: type: object required: – employeeId – companyId properties: employeeId: type: string description: Identificador do colaborador companyId: type: string description: Identificador da empresa companyInformationDTO: description: Informações da empresa para conferência de impostos type: object required: – id – totalCompanyBatches properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome totalCompanyBatches: type: integer format: int64 description: Quantidade de lotes da empresa pendencyCalculateBatch: description: type: object required: – id – processId – annualCalculationIndicator – competence – batchSequence – company – createdBy – createdDate properties: id: type: string format: uuid description: Identificador da pendência processId: type: string format: uuid description: Identificador do processo annualCalculationIndicator: type: boolean description: Indicativo de décimo terceiro competence: type: string format: date description: Competência da pendência batchSequence: type: integer format: int64 description: Sequencia do lote company: type: string format: uuid description: Identificador da empresa createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação taxPendency: description: Pendência de impostos type: object required: – id – company – employee – annualCalculationIndicator – taxPendencyType – fgtsTerminationCollection – competence – status – taxInformation properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa employee: type: object allOf: – #/definitions/employee description: Colaborador annualCalculationIndicator: type: boolean description: Indicativo de décimo terceiro taxPendencyType: type: string allOf: – #/definitions/taxPendencyType description: Tipo de imposto da pendência fgtsTerminationCollection: type: boolean description: Recolhimento do FGTS na rescisão competence: type: string format: date description: Competence da pendência status: type: integer format: int64 description: Situação da pendência taxInformation: type: string maxLength: 100 description: Informações dos impostos a serem calculados processId: type: string format: uuid description: Identificador do processo lastError: type: string maxLength: 255 description: Erro na última execução createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeTaxConference: description: Conferência impostos por colaborador type: object required: – competenceCalculation – company – employee – taxType – employeeRegistration properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employee: type: object allOf: – #/definitions/employee description: Colaborador taxType: type: string allOf: – #/definitions/taxType description: Tipo de imposto employeeRegistration: type: string maxLength: 11 description: CPF do colaborador esocialCategory: type: integer format: int64 description: Categoria esocial default: 0 esocialRegistration: type: string maxLength: 30 description: Matrícula esocial contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato do colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeInssConference: description: Conferência INSS por colaborador type: object required: – employeeTaxConference – companyBranch – companyLinkedLocation – companyRegistration – locationCode properties: id: type: string format: uuid description: Identificador único employeeTaxConference: type: object allOf: – #/definitions/employeeTaxConference description: Conferência impostos por colaborador companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyLinkedLocation: type: object allOf: – #/definitions/companyLinkedLocation description: Localização companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da filial maximum: 9 default: 0 companyRegistration: type: string maxLength: 14 description: Número de inscrição da filial locationCode: type: string maxLength: 30 description: Código da lotação no esocial calculationDefinitionCodes: type: string maxLength: 200 description: Códigos de cálculo welfarePolicyType: type: string description: Regime previdenciário specialRetirement: type: string description: Grau de exposição agentes nocivos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeInssBase: description: Base INSS por colaborador type: object required: – employeeInssConference properties: id: type: string format: uuid description: Identificador único employeeInssConference: type: object allOf: – #/definitions/employeeInssConference description: Conferência INSS por colaborador base: type: number format: double description: Base de cálculo default: 0.0 suspendedBase: type: number format: double description: Base de cálculo suspensa default: 0.0 concurrentSimplesBase: type: number format: double description: Base de cálculo – Simples concomitante default: 0.0 liableBase: type: number format: double description: Base de cálculo – Onerada default: 0.0 reliefBase: type: number format: double description: Base de cálculo – Desonerada default: 0.0 thirteenthSalaryBase: type: number format: double description: Base de cálculo – 13º salário – Lei 14.973/2024 default: 0.0 withheldAmount: type: number format: double description: Valor retido default: 0.0 familySalary: type: number format: double description: Salário família default: 0.0 maternityPay: type: number format: double description: Salário maternidade default: 0.0 sestValue: type: number format: double description: Valor SEST default: 0.0 senatValue: type: number format: double description: Valor 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: employeeInssDetail: description: Tipo de valor INSS por colaborador type: object required: – employeeInssBase properties: id: type: string format: uuid description: Identificador único employeeInssBase: type: object allOf: – #/definitions/employeeInssBase description: Conferência INSS thirteenthSalaryIncidence: type: boolean description: Incidência 13º salário default: false inssValueType: type: integer format: int64 description: Tipo de valor maximum: 99 default: 0 amount: type: number format: double description: Valor base cálculo, dedução ou desconto contribuição social 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: employeePisBase: description: Base PIS por Colaborador type: object required: – employeeTaxConference – companyBranch – companyRegistration properties: id: type: string format: uuid description: Identificador único employeeTaxConference: type: object allOf: – #/definitions/employeeTaxConference description: Conferência impostos por colaborador companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da filial maximum: 9 default: 0 companyRegistration: type: string maxLength: 14 description: Número de inscrição da filial calculationDefinitionCodes: type: string maxLength: 200 description: Códigos de cálculo base: type: number format: double description: Base de cálculo default: 0.0 suspendedBase: type: number format: double description: Base de cálculo 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: employeePisDetail: description: Tipo de Valor PIS por Colaborador type: object required: – employeePisBase properties: id: type: string format: uuid description: Identificador único employeePisBase: type: object allOf: – #/definitions/employeePisBase description: Base PIS por Colaborador thirteenthSalaryIncidence: type: boolean description: Incidência 13º salário default: false pisValueType: type: integer format: int64 description: Tipo de valor maximum: 99 default: 0 amount: type: number format: double description: Valor base cálculo, dedução ou desconto contribuição social 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: employeeIrrfDetail: description: Tipo de valor IRRF por colaborador type: object required: – employeeTaxConference – companyBranch – paymentDate – irrfValueTypeGroup – irrfOriginPaymentType properties: id: type: string format: uuid description: Identificador único employeeTaxConference: type: object allOf: – #/definitions/employeeTaxConference description: Conferência impostos por colaborador companyBranch: type: object allOf: – #/definitions/e070fil description: Filial paymentDate: type: string format: date description: Data de pagamento irrfValueType: type: integer format: int64 description: Tipo de valor IRRF maximum: 9999 default: 0 irrfValueTypeGroup: type: object allOf: – #/definitions/irrfValueTypeGroup description: Grupo de tipo de valor IRRF irrfOriginPaymentType: type: object allOf: – #/definitions/irrfOriginPaymentType description: Tipo origem pagamento IRRF accumulatedIncomeReceived: type: boolean description: Rendimento referente RRA default: false calculationDefinitionCodes: type: string maxLength: 100 description: Códigos de cálculo amount: type: number format: double description: Valor do rendimento tributável, dedução, isenção e retenção de tributos 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: employeeIrrfDetailIncomeDescription: description: Descrição do rendimento IRRF por tipo type: object required: – employeeIrrfDetail properties: id: type: string format: uuid description: Identificador único employeeIrrfDetail: type: object allOf: – #/definitions/employeeIrrfDetail description: Tipo de valor IRRF por colaborador description: type: string maxLength: 100 description: Descrição do rendimento não tributável ou isento do IRRF amount: type: string description: Valor da descrição do rendimento (nulo em conferências anteriores) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyIrrfDetail: description: Tipo de valor IRRF por empresa type: object required: – competenceCalculation – company – irrfValueTypeGroup properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa irrfValueType: type: integer format: int64 description: Tipo de valor IRRF maximum: 9999 default: 0 irrfValueTypeGroup: type: object allOf: – #/definitions/irrfValueTypeGroup description: Grupo de tipo de valor IRRF amount: type: number format: double description: Valor do rendimento tributável, dedução, isenção e retenção de tributos 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: irrfValueTypeGroup: description: Grupo de tipo de valor do IRRF type: object required: – code – description properties: code: type: integer format: int64 description: Código description: type: string description: Descrição irrfOriginPaymentType: description: Tipo de origem de pagamento de IRRF type: object required: – code – description properties: code: type: integer format: int64 description: Código description: type: string description: Descrição employeeInssRevenueCode: description: Código de Receita INSS por Colaborador type: object required: – competenceCalculation – company – companyBranch – companyLinkedLocation – employee – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyLinkedLocation: type: object allOf: – #/definitions/companyLinkedLocation description: Localização vinculada employee: type: object allOf: – #/definitions/employee description: Colaborador revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 percentage: type: number format: double description: Alíquota default: 0.0 base: type: number format: double description: Base de cálculo default: 0.0 amount: type: number format: double description: Valor aproximado default: 0.0 suspendedBase: type: number format: double description: Base de cálculo suspensa default: 0.0 suspendedAmount: type: number format: double description: Valor suspenso aproximado default: 0.0 concurrentSimplesBase: type: number format: double description: Base de cálculo – Simples concomitante default: 0.0 liableBase: type: number format: double description: Base de cálculo – Onerada default: 0.0 reliefBase: type: number format: double description: Base de cálculo – Desonerada default: 0.0 thirteenthSalaryBase: type: number format: double description: Base de cálculo – 13º salário – Lei 14.973/2024 default: 0.0 reliefPercentage: type: number format: double description: Alíquota de desoneraçã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: employeePisRevenueCode: description: Código de Receita PIS por Colaborador type: object required: – competenceCalculation – company – companyBranch – employee – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial employee: type: object allOf: – #/definitions/employee description: Colaborador revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 base: type: number format: double description: Base de cálculo default: 0.0 suspendedBase: type: number format: double description: Base de cálculo 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: employeeIrrfMonthlyRevenueCode: description: Código de Receita IRRF por CPF – Mensal type: object required: – competenceCalculation – company – employeeRegistration – revenueCode – incomeTaxType properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 incomeTaxType: type: integer format: int64 description: Tipo de rendimento do imposto de renda maximum: 99 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: employeeIncomeTaxDescription: description: Descrição dos Rendimentos IRRF por CPF type: object required: – employeeIrrfMonthlyRevenueCode properties: id: type: string format: uuid description: Identificador único employeeIrrfMonthlyRevenueCode: type: object allOf: – #/definitions/employeeIrrfMonthlyRevenueCode description: Código de receita IRRF por CPF – Mensal description: type: string maxLength: 100 description: Descrição do rendimento não tributável ou isento do IRRF amount: type: string description: Valor da descrição do rendimento (nulo em conferências anteriores) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyBranchInssRevenueCode: description: Código de Receita INSS por Filial type: object required: – competenceCalculation – company – companyBranch – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 percentage: type: number format: double description: Alíquota default: 0.0 base: type: number format: double description: Base de cálculo default: 0.0 amount: type: number format: double description: Valor default: 0.0 suspendedBase: type: number format: double description: Base de cálculo suspensa default: 0.0 suspendedAmount: type: number format: double description: Valor suspenso default: 0.0 concurrentSimplesBase: type: number format: double description: Base de cálculo – Simples concomitante default: 0.0 liableBase: type: number format: double description: Base de cálculo – Onerada default: 0.0 reliefBase: type: number format: double description: Base de cálculo – Desonerada default: 0.0 thirteenthSalaryBase: type: number format: double description: Base de cálculo – 13º salário – Lei 14.973/2024 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: companyInssRevenueCode: description: Código de Receita INSS por Empresa type: object required: – competenceCalculation – company – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 percentage: type: number format: double description: Alíquota default: 0.0 base: type: number format: double description: Base de cálculo default: 0.0 amount: type: number format: double description: Valor default: 0.0 suspendedBase: type: number format: double description: Base de cálculo suspensa default: 0.0 suspendedAmount: type: number format: double description: Valor suspenso default: 0.0 concurrentSimplesBase: type: number format: double description: Base de cálculo – Simples concomitante default: 0.0 liableBase: type: number format: double description: Base de cálculo – Onerada default: 0.0 reliefBase: type: number format: double description: Base de cálculo – Desonerada default: 0.0 thirteenthSalaryBase: type: number format: double description: Base de cálculo – 13º salário – Lei 14.973/2024 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: companyBranchPisRevenueCode: description: Código de Receita PIS por Filial type: object required: – competenceCalculation – company – companyBranch – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 base: type: number format: double description: Base de cálculo default: 0.0 suspendedBase: type: number format: double description: Base de cálculo 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: companyPisRevenueCode: description: Código de Receita PIS por Empresa type: object required: – competenceCalculation – company – revenueCode properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 base: type: number format: double description: Base de cálculo default: 0.0 suspendedBase: type: number format: double description: Base de cálculo 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: companyIrrfMonthlyRevenueCode: description: Código de Receita IRRF por Empresa – Mensal type: object required: – competenceCalculation – company – revenueCode properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 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: employeeFgtsConference: description: Conferência FGTS por colaborador type: object required: – employeeTaxConference – companyBranch – companyLinkedLocation – companyRegistration – locationCode properties: id: type: string format: uuid description: Identificador único employeeTaxConference: type: object allOf: – #/definitions/employeeTaxConference description: Conferência impostos por colaborador companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyLinkedLocation: type: object allOf: – #/definitions/companyLinkedLocation description: Localização companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da filial maximum: 9 default: 0 companyRegistration: type: string maxLength: 14 description: Número de inscrição da filial locationCode: type: string maxLength: 30 description: Código da lotação no eSocial workScheduleType: type: integer format: int64 description: Tipo de regime trabalhista default: 1 successorCompanyCompensation: type: string description: Remuneração pela empresa sucessora default: N dismissalDate: type: string format: date description: Data de demissão fgtsTerminationCollection: type: boolean description: Recolhimento do FGTS na rescisão default: false eSocialDismissalType: type: string allOf: – #/definitions/eSocialDismissalType description: Motivo do desligamento eSocial dismissalType: type: string allOf: – #/definitions/dismissalType 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: employeePayrollLoanConference: description: eConsignado – Desconto calculado na folha type: object required: – employeeFgtsConference – financialInstitutionCode – contractNumber – fgtsCollectionType properties: id: type: string format: uuid description: Identificador único employeeFgtsConference: type: object allOf: – #/definitions/employeeFgtsConference description: Conferência de FGTS por colaborador financialInstitutionCode: type: integer format: int64 description: Código da instituição financeira maximum: 999 contractNumber: type: string maxLength: 15 description: Número do contrato discountedValue: type: string description: Valor descontado na folha default: 0.0 fgtsCollectionType: type: string allOf: – #/definitions/fgtsOriginType description: Tipo de recolhimento do FGTS em que o valor descontado entra (mensal ou rescisório) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeFgtsBase: description: Base FGTS por colaborador type: object required: – employeeFgtsConference – fgtsOriginType properties: id: type: string format: uuid description: Identificador único employeeFgtsConference: type: object allOf: – #/definitions/employeeFgtsConference description: Conferência FGTS por colaborador fgtsOriginType: type: string allOf: – #/definitions/fgtsOriginType description: Tipo de origem calculationDefinitionCodes: type: string maxLength: 200 description: Códigos de cálculo base: type: number format: double description: Base de cálculo default: 0.0 withheldAmount: type: number format: double description: Valor retido default: 0.0 thirteenthSalaryBase: type: number format: double description: Base de cálculo – 13º salário default: 0.0 thirteenthSalaryWithheldAmount: type: number format: double description: Valor retido – 13º salário default: 0.0 compensatedBase: type: number format: double description: Base de cálculo aviso indenizado default: 0.0 compensatedWithheldAmount: type: number format: double description: Valor retido aviso indenizado 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: employeeFgtsDetail: description: Tipo de valor FGTS por colaborador type: object required: – employeeFgtsBase – fgtsValueType – fgtsIncidenceIndicator properties: id: type: string format: uuid description: Identificador único employeeFgtsBase: type: object allOf: – #/definitions/employeeFgtsBase description: Base FGTS por colaborador fgtsValueType: type: integer format: int64 description: Tipo de valor fgtsIncidenceIndicator: type: integer format: int64 description: Indicativo de incidência base: type: number format: double description: Base de cálculo default: 0.0 percentage: type: number format: double description: Alíquota default: 0.0 amount: type: number format: double description: Valor de 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: locationFgtsConference: description: Conferência FGTS por lotação tributária type: object required: – competenceCalculation – company – companyBranch – companyRegistration – companyLinkedLocation properties: id: type: string format: uuid description: Identificador único annualCalculationIndicator: type: boolean description: Indicação de cálculo anual default: false competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa companyBranch: type: object allOf: – #/definitions/e070fil description: Filial companyRegistrationType: type: integer format: int64 description: Tipo de inscrição da filial maximum: 9 default: 0 companyRegistration: type: string maxLength: 14 description: Número de inscrição da filial companyLinkedLocation: type: object allOf: – #/definitions/companyLinkedLocation description: Localização locationCode: type: string maxLength: 30 description: Código da lotação no eSocial companyLinkedLocationType: type: string allOf: – #/definitions/companyLinkedLocationType description: Tipo da lotação locationRegistrationType: type: integer format: int64 description: Tipo de inscrição da lotação maximum: 9 default: 0 locationRegistration: 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: locationFgtsDetail: description: Tipo de valor FGTS por lotação type: object required: – locationFgtsConference – fgtsValueType – fgtsIncidenceIndicator properties: id: type: string format: uuid description: Identificador único locationFgtsConference: type: object allOf: – #/definitions/locationFgtsConference description: Conferência FGTS por lotação tributária fgtsValueType: type: integer format: int64 description: Tipo de valor fgtsIncidenceIndicator: type: integer format: int64 description: Indicativo de incidência base: type: number format: double description: Base de cálculo default: 0.0 percentage: type: number format: double description: Alíquota default: 0.0 amount: type: number format: double description: Valor de 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: 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: – code properties: id: type: string format: uuid description: Identificador único person: type: object allOf: – #/definitions/e001pes description: Pessoa code: type: integer format: int64 description: Cadastro employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou 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 contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato de vínculo empregatício createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – codFil – nomFil properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome da filial 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: companyLinkedLocation: description: Localização vinculada da empresa type: object required: – code – name properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa code: type: integer format: int64 description: Código name: type: string description: Nome x-i18n: true 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. employeeIrrfDependentDeduction: description: Dedução de dependentes – IRRF type: object required: – id – competenceCalculation – company – employeeRegistration – revenueCode – irrfDeductionIncomeType – dependentRegistration properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador revenueCode: type: integer format: int64 description: Código de receita minimum: 0 maximum: 999999 irrfDeductionIncomeType: type: integer format: int64 description: Tipo de rendimento da dedução do IRRF minimum: 0 maximum: 99 dependentRegistration: type: string maxLength: 11 description: CPF do dependente deductionAmount: 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: employeeIrrfAlimony: description: Pensão alimentícia – IRRF type: object required: – id – competenceCalculation – company – employeeRegistration – revenueCode – irrfAlimonyIncomeType – dependentRegistration properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador revenueCode: type: integer format: int64 description: Código de receita minimum: 0 maximum: 999999 irrfAlimonyIncomeType: type: integer format: int64 description: Tipo de rendimento da pensão alimentícia minimum: 0 maximum: 99 dependentRegistration: type: string maxLength: 11 description: CPF do dependente alimonyAmount: 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: employeeIrrfDependentIdentification: description: Identificação de dependentes – IRRF type: object required: – id – competenceCalculation – company – employeeRegistration – dependentRegistration – birthDate – name properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador dependentRegistration: type: string maxLength: 11 description: CPF do dependente birthDate: type: string format: date description: Data de nascimento name: type: string maxLength: 80 description: Nome isIrrfDependent: type: boolean description: Dependente de IRRF default: false isAlimonyDependent: type: boolean description: Dependente de pensão alimentícia default: false isHealthPlanDependent: type: boolean description: Dependente de plano de saúde default: false isFamilySalaryDependent: type: boolean description: Dependente de salário família default: false dependentType: type: string description: Tipo de dependente dependencyDescription: type: string maxLength: 100 description: Descrição da dependência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeIrrfHealthPlanHolder: description: Plano de saúde – Titular – IRRF type: object required: – id – competenceCalculation – company – employeeRegistration – providerRegistration – ansProviderRegistration properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador providerRegistration: type: string maxLength: 14 description: CNPJ da operadora de plano de saúde ansProviderRegistration: type: string maxLength: 6 description: Registro ANS da operadora de plano de saúde amount: type: string 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: employeeIrrfHealthPlanDependent: description: Plano de saúde – Dependente – IRRF type: object required: – id – employeeIrrfHealthPlanHolder – dependentRegistration – amount properties: id: type: string format: uuid description: Identificador único employeeIrrfHealthPlanHolder: type: object allOf: – #/definitions/employeeIrrfHealthPlanHolder description: Informações do cálculo de plano de saúde do titular dependentRegistration: type: string maxLength: 11 description: CPF do dependente amount: type: string description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeIrrfHealthPlanContract: description: Plano de saúde – Contrato – IRRF type: object required: – id – employeeIrrfHealthPlanHolder – employee – amount properties: id: type: string format: uuid description: Identificador único employeeIrrfHealthPlanHolder: type: object allOf: – #/definitions/employeeIrrfHealthPlanHolder description: Informações do cálculo de plano de saúde do titular employee: type: object allOf: – #/definitions/employee description: Colaborador (contrato que pagou o plano) dependentRegistration: type: string maxLength: 11 description: CPF do dependente (nulo para o titular) amount: type: string description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeIrrfComplementaryPension: description: Previdência complementar – IRRF type: object required: – id – competenceCalculation – company – employeeRegistration – revenueCode – complementaryPensionType – complementaryPensionRegistration properties: id: type: string format: uuid description: Identificador único competenceCalculation: type: string format: date description: Competência de apuração company: type: object allOf: – #/definitions/e070emp description: Empresa employeeRegistration: type: string maxLength: 11 description: CPF do colaborador revenueCode: type: integer format: int64 description: Código de receita maximum: 999999 complementaryPensionType: type: integer format: int64 description: Tipo da previdência complementar complementaryPensionRegistration: type: string maxLength: 14 description: CNPJ da empresa complementar paymentDeductionValue: type: number format: double description: Dedução mensal default: 0.0 thirteenthSalaryDeductionValue: type: number format: double description: Dedução 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação