Mais pesquisados:Customização, Tutorial, Documentação

starter

54 views 0 11/11/2020 Atualizado em 15/08/2024 integrador

starter
 3.16.2 

[ Base URL: platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/erpx_fnd ]
https://s3.amazonaws.com/br-com-senior-ecossistema-api/erpx_fnd_starter.swagger.yaml

Serviço responsável pelo start do tenant

Send email to Senior X Platform

Queries

POST​/starter​/queries​/healthcheck
PRIVATE
POST​/starter​/queries​/getReceitaInfoByCnpj
PRIVATE
POST​/starter​/queries​/getCustomerCode
PRIVATE
POST​/starter​/queries​/edocsHealthcheck
PRIVATE
POST​/starter​/queries​/getDeploymentProgress
PRIVATE
POST​/starter​/queries​/getRunningDeploymentProgressStep
PRIVATE
POST​/starter​/queries​/getMetadata
PRIVATE
POST​/starter​/queries​/exportWizard
PRIVATE
POST​/starter​/queries​/exportE070emp
PRIVATE
POST​/starter​/queries​/exportE070fil
PRIVATE
POST​/starter​/queries​/exportE006pai
PRIVATE
POST​/starter​/queries​/exportE031moe
PRIVATE
POST​/starter​/queries​/exportE007ufs
PRIVATE
POST​/starter​/queries​/exportGeneralParameters
PRIVATE
POST​/starter​/queries​/exportCompanyDigitalCertificate
PRIVATE
POST​/starter​/queries​/exportBank
PRIVATE
POST​/starter​/queries​/exportBankAccount
PRIVATE
POST​/starter​/queries​/exportRemittanceDefinitions
PRIVATE
POST​/starter​/queries​/exportEletronicPaymentDefinitions
PRIVATE
POST​/starter​/queries​/exportEnvironmentStepInfo
PRIVATE
POST​/starter​/queries​/exportCompaniesBranchesDuplication
PRIVATE
POST​/starter​/queries​/exportMfaCode
PRIVATE
POST​/starter​/queries​/exportMigracaoBases
PRIVATE
POST​/starter​/queries​/getDependencies
PRIVATE

Actions

POST​/starter​/actions​/migrateSchema
PRIVATE
POST​/starter​/actions​/forceMigrateSchema
PRIVATE
POST​/starter​/actions​/createAnalytics
PRIVATE
POST​/starter​/actions​/retrieveUploadUrl
PRIVATE
POST​/starter​/actions​/saveCompanyCertificateFile
PRIVATE
POST​/starter​/actions​/getCompanyCertificate
PRIVATE
POST​/starter​/actions​/finishRegistration
PRIVATE
POST​/starter​/actions​/startPrepareEnvironmentForTenant
PRIVATE
POST​/starter​/actions​/sendMfaCodeToAdminEmail
PRIVATE
POST​/starter​/actions​/validateMfaCode
PRIVATE
POST​/starter​/actions​/updateDbFunctions
PRIVATE
POST​/starter​/actions​/resendFinishEmailAndNotification
PRIVATE
POST​/starter​/actions​/recriateJobOnScheduler
PRIVATE
POST​/starter​/actions​/restartWizardQueue
PRIVATE
POST​/starter​/actions​/resetUserParameters
PRIVATE
POST​/starter​/actions​/odata
PRIVATE
POST​/starter​/actions​/importWizard
PRIVATE
POST​/starter​/actions​/importE070emp
PRIVATE
POST​/starter​/actions​/importE070fil
PRIVATE
POST​/starter​/actions​/importE006pai
PRIVATE
POST​/starter​/actions​/importE031moe
PRIVATE
POST​/starter​/actions​/importE007ufs
PRIVATE
POST​/starter​/actions​/importGeneralParameters
PRIVATE
POST​/starter​/actions​/importCompanyDigitalCertificate
PRIVATE
POST​/starter​/actions​/importBank
PRIVATE
POST​/starter​/actions​/importBankAccount
PRIVATE
POST​/starter​/actions​/importRemittanceDefinitions
PRIVATE
POST​/starter​/actions​/importEletronicPaymentDefinitions
PRIVATE
POST​/starter​/actions​/importEnvironmentStepInfo
PRIVATE
POST​/starter​/actions​/importCompaniesBranchesDuplication
PRIVATE
POST​/starter​/actions​/importMfaCode
PRIVATE
POST​/starter​/actions​/importMigracaoBases
PRIVATE

Signals

Events

POST​/starter​/events​/registrationFinished
POST​/starter​/events​/environmentPreparationFinished
POST​/starter​/events​/executeParallelStep
POST​/starter​/events​/initialLoadDefaultBaseFinished
POST​/starter​/events​/cloneCompanyBranchFinished
POST​/starter​/events​/importWizardEvent
POST​/starter​/events​/exportWizardEvent
POST​/starter​/events​/importE070empEvent
POST​/starter​/events​/exportE070empEvent
POST​/starter​/events​/importE070filEvent
POST​/starter​/events​/exportE070filEvent
POST​/starter​/events​/importE006paiEvent
POST​/starter​/events​/exportE006paiEvent
POST​/starter​/events​/importE031moeEvent
POST​/starter​/events​/exportE031moeEvent
POST​/starter​/events​/importE007ufsEvent
POST​/starter​/events​/exportE007ufsEvent
POST​/starter​/events​/importGeneralParametersEvent
POST​/starter​/events​/exportGeneralParametersEvent
POST​/starter​/events​/importCompanyDigitalCertificateEvent
POST​/starter​/events​/exportCompanyDigitalCertificateEvent
POST​/starter​/events​/importBankEvent
POST​/starter​/events​/exportBankEvent
POST​/starter​/events​/importBankAccountEvent
POST​/starter​/events​/exportBankAccountEvent
POST​/starter​/events​/importRemittanceDefinitionsEvent
POST​/starter​/events​/exportRemittanceDefinitionsEvent
POST​/starter​/events​/importEletronicPaymentDefinitionsEvent
POST​/starter​/events​/exportEletronicPaymentDefinitionsEvent
POST​/starter​/events​/importEnvironmentStepInfoEvent
POST​/starter​/events​/exportEnvironmentStepInfoEvent
POST​/starter​/events​/importCompaniesBranchesDuplicationEvent
POST​/starter​/events​/exportCompaniesBranchesDuplicationEvent
POST​/starter​/events​/importMfaCodeEvent
POST​/starter​/events​/exportMfaCodeEvent
POST​/starter​/events​/importMigracaoBasesEvent
POST​/starter​/events​/exportMigracaoBasesEvent

CRUD

POST​/starter​/entities​/wizard
PRIVATE
PUT​/starter​/entities​/wizard​/{id}
PRIVATE
PATCH​/starter​/entities​/wizard​/{id}
PRIVATE
GET​/starter​/entities​/wizard​/{id}
PRIVATE
DELETE​/starter​/entities​/wizard​/{id}
PRIVATE
POST​/starter​/entities​/e070emp
PRIVATE
PUT​/starter​/entities​/e070emp​/{id}
PRIVATE
PATCH​/starter​/entities​/e070emp​/{id}
PRIVATE
GET​/starter​/entities​/e070emp​/{id}
PRIVATE
DELETE​/starter​/entities​/e070emp​/{id}
PRIVATE
POST​/starter​/entities​/e070fil
PRIVATE
PUT​/starter​/entities​/e070fil​/{id}
PRIVATE
PATCH​/starter​/entities​/e070fil​/{id}
PRIVATE
GET​/starter​/entities​/e070fil​/{id}
PRIVATE
DELETE​/starter​/entities​/e070fil​/{id}
PRIVATE
POST​/starter​/entities​/e006pai
PRIVATE
PUT​/starter​/entities​/e006pai​/{id}
PRIVATE
PATCH​/starter​/entities​/e006pai​/{id}
PRIVATE
GET​/starter​/entities​/e006pai​/{id}
PRIVATE
DELETE​/starter​/entities​/e006pai​/{id}
PRIVATE
POST​/starter​/entities​/e031moe
PRIVATE
PUT​/starter​/entities​/e031moe​/{id}
PRIVATE
PATCH​/starter​/entities​/e031moe​/{id}
PRIVATE
GET​/starter​/entities​/e031moe​/{id}
PRIVATE
DELETE​/starter​/entities​/e031moe​/{id}
PRIVATE
POST​/starter​/entities​/e007ufs
PRIVATE
PUT​/starter​/entities​/e007ufs​/{id}
PRIVATE
PATCH​/starter​/entities​/e007ufs​/{id}
PRIVATE
GET​/starter​/entities​/e007ufs​/{id}
PRIVATE
DELETE​/starter​/entities​/e007ufs​/{id}
PRIVATE
POST​/starter​/entities​/generalParameters
PRIVATE
PUT​/starter​/entities​/generalParameters​/{id}
PRIVATE
PATCH​/starter​/entities​/generalParameters​/{id}
PRIVATE
GET​/starter​/entities​/generalParameters​/{id}
PRIVATE
DELETE​/starter​/entities​/generalParameters​/{id}
PRIVATE
POST​/starter​/entities​/companyDigitalCertificate
PRIVATE
PUT​/starter​/entities​/companyDigitalCertificate​/{id}
PRIVATE
PATCH​/starter​/entities​/companyDigitalCertificate​/{id}
PRIVATE
GET​/starter​/entities​/companyDigitalCertificate​/{id}
PRIVATE
DELETE​/starter​/entities​/companyDigitalCertificate​/{id}
PRIVATE
POST​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate
PRIVATE
PATCH​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate
PRIVATE
GET​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate
PRIVATE
PUT​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate​/{id}
PRIVATE
PATCH​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate​/{id}
PRIVATE
GET​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate​/{id}
PRIVATE
DELETE​/starter​/entities​/e070emp​/{parentId}​/companyDigitalCertificate​/{id}
PRIVATE
POST​/starter​/entities​/bank
PRIVATE
PUT​/starter​/entities​/bank​/{id}
PRIVATE
PATCH​/starter​/entities​/bank​/{id}
PRIVATE
GET​/starter​/entities​/bank​/{id}
PRIVATE
DELETE​/starter​/entities​/bank​/{id}
PRIVATE
POST​/starter​/entities​/bankAccount
PRIVATE
PUT​/starter​/entities​/bankAccount​/{id}
PRIVATE
PATCH​/starter​/entities​/bankAccount​/{id}
PRIVATE
GET​/starter​/entities​/bankAccount​/{id}
PRIVATE
DELETE​/starter​/entities​/bankAccount​/{id}
PRIVATE
POST​/starter​/entities​/remittanceDefinitions
PRIVATE
PUT​/starter​/entities​/remittanceDefinitions​/{id}
PRIVATE
PATCH​/starter​/entities​/remittanceDefinitions​/{id}
PRIVATE
GET​/starter​/entities​/remittanceDefinitions​/{id}
PRIVATE
DELETE​/starter​/entities​/remittanceDefinitions​/{id}
PRIVATE
POST​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions
PRIVATE
PATCH​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions
PRIVATE
GET​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions
PRIVATE
PUT​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions​/{id}
PRIVATE
PATCH​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions​/{id}
PRIVATE
GET​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions​/{id}
PRIVATE
DELETE​/starter​/entities​/bankAccount​/{parentId}​/remittanceDefinitions​/{id}
PRIVATE
POST​/starter​/entities​/eletronicPaymentDefinitions
PRIVATE
PUT​/starter​/entities​/eletronicPaymentDefinitions​/{id}
PRIVATE
PATCH​/starter​/entities​/eletronicPaymentDefinitions​/{id}
PRIVATE
GET​/starter​/entities​/eletronicPaymentDefinitions​/{id}
PRIVATE
DELETE​/starter​/entities​/eletronicPaymentDefinitions​/{id}
PRIVATE
POST​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions
PRIVATE
PATCH​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions
PRIVATE
GET​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions
PRIVATE
PUT​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions​/{id}
PRIVATE
PATCH​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions​/{id}
PRIVATE
GET​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions​/{id}
PRIVATE
DELETE​/starter​/entities​/bankAccount​/{parentId}​/eletronicPaymentDefinitions​/{id}
PRIVATE
POST​/starter​/entities​/environmentStepInfo
PRIVATE
PUT​/starter​/entities​/environmentStepInfo​/{id}
PRIVATE
PATCH​/starter​/entities​/environmentStepInfo​/{id}
PRIVATE
GET​/starter​/entities​/environmentStepInfo​/{id}
PRIVATE
DELETE​/starter​/entities​/environmentStepInfo​/{id}
PRIVATE
POST​/starter​/entities​/companiesBranchesDuplication
PRIVATE
PUT​/starter​/entities​/companiesBranchesDuplication​/{id}
PRIVATE
PATCH​/starter​/entities​/companiesBranchesDuplication​/{id}
PRIVATE
GET​/starter​/entities​/companiesBranchesDuplication​/{id}
PRIVATE
DELETE​/starter​/entities​/companiesBranchesDuplication​/{id}
PRIVATE
POST​/starter​/entities​/mfaCode
PRIVATE
PUT​/starter​/entities​/mfaCode​/{id}
PRIVATE
PATCH​/starter​/entities​/mfaCode​/{id}
PRIVATE
GET​/starter​/entities​/mfaCode​/{id}
PRIVATE
DELETE​/starter​/entities​/mfaCode​/{id}
PRIVATE
POST​/starter​/entities​/migracaoBases
PRIVATE
PUT​/starter​/entities​/migracaoBases​/{id}
PRIVATE
PATCH​/starter​/entities​/migracaoBases​/{id}
PRIVATE
GET​/starter​/entities​/migracaoBases​/{id}
PRIVATE
DELETE​/starter​/entities​/migracaoBases​/{id}
PRIVATE

Bulk

POST​/starter​/entities​/wizard​/bulk
POST​/starter​/entities​/e070emp​/bulk
POST​/starter​/entities​/e070fil​/bulk
POST​/starter​/entities​/e006pai​/bulk
POST​/starter​/entities​/e031moe​/bulk
POST​/starter​/entities​/e007ufs​/bulk
POST​/starter​/entities​/generalParameters​/bulk
POST​/starter​/entities​/companyDigitalCertificate​/bulk
POST​/starter​/entities​/bank​/bulk
POST​/starter​/entities​/bankAccount​/bulk
POST​/starter​/entities​/remittanceDefinitions​/bulk
POST​/starter​/entities​/eletronicPaymentDefinitions​/bulk
POST​/starter​/entities​/environmentStepInfo​/bulk
POST​/starter​/entities​/companiesBranchesDuplication​/bulk
POST​/starter​/entities​/mfaCode​/bulk
POST​/starter​/entities​/migracaoBases​/bulk

Models

upDown
enumTipEmp
enumStatusMigracaoBase
enumTipMoeCurto
enumTipCot
enumTributacaoProdutor
enumAccountType
enumCompanyBank
enumAccessType
environmentStepStatus
enumJurFis
environmentStep
wizardQueueStatus
schedulerJobPrimitiveType
userNotificationKind
userNotificationPriority
eventEmailFormat
fieldType
fileFormat
hookFunction
eventType
errorStrategy
status
errorType
wizard
editWizard
e070emp
editE070emp
e070fil
editE070fil
e006pai
editE006pai
e031moe
editE031moe
e007ufs
editE007ufs
generalParameters
editGeneralParameters
companyDigitalCertificate
editCompanyDigitalCertificate
bank
editBank
bankAccount
editBankAccount
remittanceDefinitions
editRemittanceDefinitions
eletronicPaymentDefinitions
editEletronicPaymentDefinitions
environmentStepInfo
editEnvironmentStepInfo
companiesBranchesDuplication
editCompaniesBranchesDuplication
mfaCode
editMfaCode
migracaoBases
editMigracaoBases
checkData
role
roleDomainServices
duplicateCompany
duplicateBranch
duplicateCompaniesBranches
deploymentStepProgress
deploymentDatabaseDuplicationProgress
schedulerPeriod
receitaInfo
notifyUserEventPayload
emailNotifyUserEventPayload
pushNotifyUserEventPayload
blobReference
basicErrorPayload
importError
fielddto
hookdto
layoutdto
importReport
exportEventStatus
importEventStatus
exportConfig
importConfig
dependency
genericError
Error
2.0info: 3.9.2 starter description: Serviço responsável pelo start do tenant x-senior-domain: erpx_fnd x-senior-domain-path: erpx_fnd x-senior-service-path: starter 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/erpx_fndsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /starter/queries/healthcheck: post: description: Query for healthcheck – SRE tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for healthcheck – SRE tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/queries/getReceitaInfoByCnpj: post: description: Retorna os dados da Receita Federal pelo CNPJ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ responses: 200: description: Ok schema: type: object properties: receitaInfo: type: object allOf: – #/definitions/receitaInfo description: Informações da Receita Federal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados da Receita Federal pelo CNPJ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpj description: CNPJ in: query required: true type: string responses: 200: description: Ok schema: type: object properties: receitaInfo: type: object allOf: – #/definitions/receitaInfo description: Informações da Receita Federal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/queries/getCustomerCode: post: description: Retorna o número do cliente na plataforma com base no tenant logado tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: integrationCode: type: string description: Número do cliente na plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número do cliente na plataforma com base no tenant logado tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: integrationCode: type: string description: Número do cliente na plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/queries/edocsHealthcheck: post: description: Verifica a disponibilidade do banco e do gerenciador do eDocs tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica a disponibilidade do banco e do gerenciador do eDocs tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/queries/getDeploymentProgress: post: description: Retorna o progresso das etapas do processo de implantação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – queueStatus – deploymentStepProgress – databaseDuplicationProgress properties: queueStatus: type: string allOf: – #/definitions/wizardQueueStatus description: Status da fila de preparação de ambiente deploymentStepProgress: type: array items: type: object allOf: – #/definitions/deploymentStepProgress minimum: 1 description: Etapas de implantação databaseDuplicationProgress: type: array items: type: object allOf: – #/definitions/deploymentDatabaseDuplicationProgress minimum: 1 description: Progresso da duplicação de empresas e filiais por domínio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o progresso das etapas do processo de implantação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – queueStatus – deploymentStepProgress – databaseDuplicationProgress properties: queueStatus: type: string allOf: – #/definitions/wizardQueueStatus description: Status da fila de preparação de ambiente deploymentStepProgress: type: array items: type: object allOf: – #/definitions/deploymentStepProgress minimum: 1 description: Etapas de implantação databaseDuplicationProgress: type: array items: type: object allOf: – #/definitions/deploymentDatabaseDuplicationProgress minimum: 1 description: Progresso da duplicação de empresas e filiais por domínio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/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 /starter/queries/exportWizard: 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 /starter/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 /starter/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 /starter/queries/exportE006pai: 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 /starter/queries/exportE031moe: 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 /starter/queries/exportE007ufs: 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 /starter/queries/exportGeneralParameters: 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 /starter/queries/exportCompanyDigitalCertificate: 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 /starter/queries/exportBank: 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 /starter/queries/exportBankAccount: 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 /starter/queries/exportRemittanceDefinitions: 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 /starter/queries/exportEletronicPaymentDefinitions: 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 /starter/queries/exportEnvironmentStepInfo: 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 /starter/queries/exportCompaniesBranchesDuplication: 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 /starter/queries/exportMfaCode: 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 /starter/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 /starter/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/createAnalytics: post: description: Cria os datasets, analytics manualmente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: receitaCompanies: type: boolean description: Create receita companies dataset default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/retrieveUploadUrl: post: description: Retorna a Url para upload do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: id: type: string description: Id (caso não seja passado nenhum id será gerado um aleatório) fileName: type: string description: Nome do arquivo anexo responses: 200: description: Ok schema: type: object required: – id – fileUrl – fileName – fileVersion properties: id: type: string description: Id do arquivo fileUrl: type: string description: URL para upload do arquivo fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/saveCompanyCertificateFile: post: description: Persiste as informações do Certificado Digital no banco e commita o arquivo na AWS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e070empId – fileName – fileVersion – password properties: e070empId: type: string description: Empresa fileName: type: string description: Nome do Arquivo fileVersion: type: string description: Versão do Arquivo password: type: string description: Senha responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/getCompanyCertificate: post: description: Retorna o link para o download e senha do Certificado Digital da empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyCode properties: companyCode: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object required: – downloadLink – password properties: downloadLink: type: string description: Link para download do Certificado password: type: string description: Senha do Certificado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/finishRegistration: post: description: Finaliza o cadastro no wizard e envia o evento registrationFinished tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/startPrepareEnvironmentForTenant: post: description: Inicia a preparação de ambiente para o tenant passado no payload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/sendMfaCodeToAdminEmail: post: description: Envia o código MFA para o e-mail do administrador do tenant tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – email properties: email: type: string description: E-mail do administrador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/validateMfaCode: post: description: Valida o código MFA enviado para o e-mail do administrador do tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Código responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/updateDbFunctions: post: description: Atualiza as funções nos databases a partir dos arquivos em ../resources/db/functions tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/resendFinishEmailAndNotification: post: description: Reenvia o e-mail e notificação de finalização de preparação do ambiente tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/recriateJobOnScheduler: post: description: Recupera um agendamento na plataforma e recria com as configurações de repetição informadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service – primitive – period properties: domain: type: string description: Domínio configurada service: type: string description: Serviço configurada primitive: type: string description: Nome da primitiva configurada period: type: object allOf: – #/definitions/schedulerPeriod description: Configurações de período no formato do serviço de agendamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/restartWizardQueue: post: description: Reinicia a fila de preparações de ambiente tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/actions/resetUserParameters: post: description: Define as configurações padrões de usuário x empresa para todos os usuários admins tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userCode – companyId properties: userCode: type: string description: Código do usuário (conforme padrão e099usu) companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/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 /starter/actions/importWizard: 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 /starter/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 /starter/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 /starter/actions/importE006pai: 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 /starter/actions/importE031moe: 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 /starter/actions/importE007ufs: 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 /starter/actions/importGeneralParameters: 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 /starter/actions/importCompanyDigitalCertificate: 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 /starter/actions/importBank: 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 /starter/actions/importBankAccount: 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 /starter/actions/importRemittanceDefinitions: 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 /starter/actions/importEletronicPaymentDefinitions: 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 /starter/actions/importEnvironmentStepInfo: 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 /starter/actions/importCompaniesBranchesDuplication: 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 /starter/actions/importMfaCode: 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 /starter/signals/createConfiguredRoles: post: description: Cria papéis no ERPX com as permissões configuradas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/startPrepareEnvironment: post: description: Inicia a preparação do ambiente tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/duplicateApartCompaniesBranches: post: description: Duplica empresas e filiais à parte tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – mfaCode – companiesBranchesData properties: mfaCode: type: string description: Codigo de segurança companiesBranchesData: type: array items: type: object allOf: – #/definitions/duplicateCompaniesBranches minimum: 1 description: Dados de empresas e filiais responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/reprocessStep: post: description: Reprocessa um step da preparação de ambiente tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – step properties: step: type: string allOf: – #/definitions/environmentStep description: Step responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/createDefaultRoles: post: description: Criar os papéis e permissões padrões tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/cloneCompany: post: description: Duplica empresa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – mfaCode – e070empOriginId – e070filOriginId – companyCode – documentNumber – companyName – companyTradeName – companyCountryId – companyCurrencyId – suggestFieldsDatalake properties: mfaCode: type: string description: Codigo de segurança e070empOriginId: type: string description: Id da empresa de origem e070filOriginId: type: string description: Id da filial de origem companyCode: type: integer format: int64 description: Código da nova empresa documentNumber: type: string description: CPF/ CNPJ da nova empresa companyName: type: string description: Nome da nova empresa companyTradeName: type: string description: Nome fantasia da nova empresa companyCountryId: type: string description: País da nova empresa companyCurrencyId: type: string description: Moeda usada na nova empresa stateRegistrationNumber: type: string description: Inscrição estadual da nova empresa municipalRegistrationNumber: type: string description: Inscrição municipal da nova empresa suggestFieldsDatalake: type: boolean description: Indica se deve sugerir os campos via Datalake responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/signals/cloneBranch: post: description: Duplica filial tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – mfaCode – e070empOriginId – e070filOriginId – e070empDestinationId – branchCode – documentNumber – branchName – branchTradeName – suggestFieldsDatalake properties: mfaCode: type: string description: Codigo de segurança e070empOriginId: type: string description: Id da empresa de origem e070filOriginId: type: string description: Id da filial de origem e070empDestinationId: type: string description: Código da empresa de destino branchCode: type: integer format: int64 description: Código da nova filial documentNumber: type: string description: CPF/ CNPJ da nova filial branchName: type: string description: Nome da nova filial branchTradeName: type: string description: Nome fantasia da nova filial stateRegistrationNumber: type: string description: Inscrição estadual da nova filial municipalRegistrationNumber: type: string description: Inscrição municipal da nova filial suggestFieldsDatalake: type: boolean description: Indica se deve sugerir os campos via Datalake responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /starter/events/registrationFinished: post: description: Notifica quando o tenant finalizou as configurações de implantação x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenant – customerCode properties: tenant: type: string description: Domínio do Tenant customerCode: type: string description: Código interno do ERP responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /starter/events/environmentPreparationFinished: post: description: Notifica quando o tenant finalizou a preparação de ambiente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /starter/events/executeParallelStep: post: description: Evento que o próprio starter escuta para iniciar os steps paralelos da preparação de ambiente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – step properties: step: type: string allOf: – #/definitions/environmentStep description: Step responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /starter/events/initialLoadDefaultBaseFinished: post: description: Evento informando a realizaçao da carga de um domínio x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: Domínio service: type: string description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /starter/events/importWizardEvent: 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 /starter/events/exportWizardEvent: 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 /starter/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 /starter/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 /starter/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 /starter/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 /starter/events/importE006paiEvent: 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 /starter/events/exportE006paiEvent: 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 /starter/events/importE031moeEvent: 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 /starter/events/exportE031moeEvent: 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 /starter/events/importE007ufsEvent: 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 /starter/events/exportE007ufsEvent: 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 /starter/events/importGeneralParametersEvent: 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 /starter/events/exportGeneralParametersEvent: 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 /starter/events/importCompanyDigitalCertificateEvent: 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 /starter/events/exportCompanyDigitalCertificateEvent: 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 /starter/events/importBankEvent: 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 /starter/events/exportBankEvent: 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 /starter/events/importBankAccountEvent: 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 /starter/events/exportBankAccountEvent: 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 /starter/events/importRemittanceDefinitionsEvent: 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 /starter/events/exportRemittanceDefinitionsEvent: 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 /starter/events/importEletronicPaymentDefinitionsEvent: 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 /starter/events/exportEletronicPaymentDefinitionsEvent: 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 /starter/events/importEnvironmentStepInfoEvent: 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 /starter/events/exportEnvironmentStepInfoEvent: 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 /starter/events/importCompaniesBranchesDuplicationEvent: 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 /starter/events/exportCompaniesBranchesDuplicationEvent: 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 /starter/events/importMfaCodeEvent: 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 /starter/events/exportMfaCodeEvent: 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 /starter/entities/wizard: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wizard responses: 200: description: The created resource schema: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wizard responses: 200: description: The created resource schema: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/wizard/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wizard responses: 200: description: Ok schema: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wizard responses: 200: description: Ok schema: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wizard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/wizard/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wizard responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070emp: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070emp/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070emp responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070emp responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070emp/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070emp responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070fil: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070fil responses: 200: description: The created resource schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070fil responses: 200: description: The created resource schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070fil/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070fil responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070fil responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070fil/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070fil responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e006pai: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e006pai responses: 200: description: The created resource schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e006pai responses: 200: description: The created resource schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e006pai/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e006pai responses: 200: description: Ok schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e006pai responses: 200: description: Ok schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e006pai/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e006pai responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e031moe: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e031moe responses: 200: description: The created resource schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e031moe responses: 200: description: The created resource schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e031moe/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e031moe/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e031moe responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e007ufs: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e007ufs/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e007ufs responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e007ufs responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e007ufs/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e007ufs responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/generalParameters: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalParameters responses: 200: description: The created resource schema: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalParameters responses: 200: description: The created resource schema: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/generalParameters/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalParameters responses: 200: description: Ok schema: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalParameters responses: 200: description: Ok schema: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/generalParameters 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/generalParameters/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generalParameters responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companyDigitalCertificate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyDigitalCertificate responses: 200: description: The created resource schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyDigitalCertificate responses: 200: description: The created resource schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companyDigitalCertificate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyDigitalCertificate responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyDigitalCertificate responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070emp/{parentId}/companyDigitalCertificate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyDigitalCertificate responses: 200: description: The created resource schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyDigitalCertificate responses: 200: description: The created resource schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/e070emp/{parentId}/companyDigitalCertificate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyDigitalCertificate responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyDigitalCertificate responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyDigitalCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companyDigitalCertificate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyDigitalCertificate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bank: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bank/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bank/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bankAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/remittanceDefinitions: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/remittanceDefinitions responses: 200: description: The created resource schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/remittanceDefinitions responses: 200: description: The created resource schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/remittanceDefinitions/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/remittanceDefinitions responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/remittanceDefinitions responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/{parentId}/remittanceDefinitions: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/remittanceDefinitions responses: 200: description: The created resource schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/remittanceDefinitions responses: 200: description: The created resource schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/{parentId}/remittanceDefinitions/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/remittanceDefinitions responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/remittanceDefinitions responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/remittanceDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/remittanceDefinitions/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/remittanceDefinitions responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/eletronicPaymentDefinitions: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eletronicPaymentDefinitions responses: 200: description: The created resource schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eletronicPaymentDefinitions responses: 200: description: The created resource schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/eletronicPaymentDefinitions/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/{parentId}/eletronicPaymentDefinitions: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eletronicPaymentDefinitions responses: 200: description: The created resource schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eletronicPaymentDefinitions responses: 200: description: The created resource schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/bankAccount/{parentId}/eletronicPaymentDefinitions/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eletronicPaymentDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/eletronicPaymentDefinitions/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eletronicPaymentDefinitions responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/environmentStepInfo: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/environmentStepInfo responses: 200: description: The created resource schema: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/environmentStepInfo responses: 200: description: The created resource schema: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/environmentStepInfo/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/environmentStepInfo responses: 200: description: Ok schema: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/environmentStepInfo responses: 200: description: Ok schema: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/environmentStepInfo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/environmentStepInfo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companiesBranchesDuplication: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companiesBranchesDuplication responses: 200: description: The created resource schema: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companiesBranchesDuplication responses: 200: description: The created resource schema: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companiesBranchesDuplication/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companiesBranchesDuplication responses: 200: description: Ok schema: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companiesBranchesDuplication responses: 200: description: Ok schema: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companiesBranchesDuplication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/companiesBranchesDuplication/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companiesBranchesDuplication responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/mfaCode: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mfaCode responses: 200: description: The created resource schema: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mfaCode responses: 200: description: The created resource schema: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/mfaCode/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mfaCode responses: 200: description: Ok schema: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mfaCode responses: 200: description: Ok schema: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mfaCode 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/mfaCode/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mfaCode responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTipEmp: description: Segmento de atuação type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumTipMoeCurto: description: Tipo da moeda type: string enum: – VD – VH enumTipCot: description: Tipo da cotação type: string enum: – VD – VM enumAccountType: description: Tipo de conta type: string enum: – CHECKING_ACCOUNT – SAVING_ACCOUNT enumCompanyBank: description: Empresa ou banco type: string enum: – COMPANY – BANK enumAccessType: description: Tipo de acesso type: string enum: – POP – IMAP environmentStepStatus: description: Status do passo da preparação de ambiente type: string enum: – SKIPPED – IN_PROGRESS – DONE – ERROR enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF environmentStep: description: Steps da preparação de ambiente type: string enum: – EDOCS_TENANT – CONFIGURED_ROLES – SARA_BOT – SCHEMAS_CREATION – SCHEMAS_INITIAL_LOAD – REPORTS_DATABASE – ENTITIES_TO_FND – ENTITIES_REPLICATION – FUNCTIONS_UPDATE – SET_DUPLICATION_IDS_TABLES – ENTITIES_DUPLICATION – PERSON_CREATION – ADMIN_USER_PERMISSIONS – ERPX_MENU wizardQueueStatus: description: Status da preparação de ambiente type: string enum: – WAITING – RUNNING – FINISHED_SUCCESSFULLY – TERMINATED_WITH_ERROR schedulerJobPrimitiveType: description: Tipos de primitivas chamadas pelo agendamento type: string enum: – ACTION – LIST – SIGNAL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR wizard: description: Wizard de implantação type: object required: – processFinished properties: id: type: string format: uuid description: Id processFinished: type: boolean description: Processo finalizado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp – e006pai properties: id: type: string format: uuid description: Id codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 100 description: Nome fantasia usaAgr: type: boolean description: Utiliza agrupamento filial e006pai: type: object allOf: – #/definitions/e006pai description: País e031moe: type: object allOf: – #/definitions/e031moe description: Moeda companyDigitalCertificate: type: object allOf: – #/definitions/companyDigitalCertificate description: Certificado digital da empresa usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Nome fantasia tipEmp: type: string allOf: – #/definitions/enumTipEmp description: Segmento de atuação tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal filMat: type: boolean description: Filial matriz postalCodeFil: type: string maxLength: 20 description: Código Postal endFil: type: string maxLength: 100 description: Endereço nenFil: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiFil: type: string maxLength: 75 description: Bairro e008rai: type: string format: uuid description: Código cidade ISS numFon: type: string maxLength: 20 description: Telefone intNet: type: string maxLength: 100 description: E-mail e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e006pai: description: País type: object properties: id: type: string format: uuid description: Id codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome e031moe: type: object allOf: – #/definitions/e031moe description: Moeda excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e031moe: description: Moeda type: object required: – codMoe – desMoe – sigMoe – tipMoe – tipCot properties: id: type: string format: uuid description: Id codMoe: type: string maxLength: 3 description: Código moeda desMoe: type: string maxLength: 30 description: Descrição sigMoe: type: string maxLength: 5 description: Sigla tipMoe: type: string allOf: – #/definitions/enumTipMoeCurto description: Tipo moeda tipCot: type: string allOf: – #/definitions/enumTipCot description: Tipo cotação excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: generalParameters: description: Parâmetros gerais type: object required: – customerCode properties: id: type: string format: uuid description: Id customerCode: type: string description: Código do cliente comments: type: string maxLength: 3000 description: Observações usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: companyDigitalCertificate: description: Certificado digital da empresa type: object required: – fileName – fileVersion – password properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo password: type: string description: Senha usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: bank: description: Banco type: object required: – code – name properties: id: type: string format: uuid description: Id code: type: string maxLength: 5 description: Código do banco name: type: string description: Nome do banco usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: bankAccount: description: Conta bancária type: object required: – bank – accountType – agency – accountNumber – charge – performRemittance – eletronicPayment – importBankStatement properties: id: type: string format: uuid description: Id bank: type: object allOf: – #/definitions/bank description: Banco accountType: type: string allOf: – #/definitions/enumAccountType description: Tipo de conta agency: type: integer format: int64 description: Agência accountNumber: type: integer format: int64 description: Número da conta charge: type: boolean description: Cobrança performRemittance: type: boolean description: Realiza remessa eletronicPayment: type: boolean description: Pagamento eletrônico importBankStatement: type: boolean description: Importar extrato remittanceDefinitions: type: object allOf: – #/definitions/remittanceDefinitions description: Definições de remessa eletronicPaymentDefinitions: type: object allOf: – #/definitions/eletronicPaymentDefinitions description: Definições de pagamento eletrônico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: remittanceDefinitions: description: Definições de remessa type: object required: – bank – agency – checkingAccount – agreementNumber – responsibleContract – cnabModel – issuedSlips – issuedMessage properties: id: type: string format: uuid description: Id bank: type: object allOf: – #/definitions/bank description: Banco agency: type: integer format: int64 description: Agência checkingAccount: type: integer format: int64 description: Conta Corrente agreementNumber: type: integer format: int64 description: Número de convênio com o banco responsibleContract: type: string description: Contato responsável cnabModel: type: boolean description: Modelo de CNAB issuedSlips: type: string allOf: – #/definitions/enumCompanyBank description: Boletos impressos pela empresa ou banco issuedMessage: type: string description: Mensagem Impressa no boleto interestPercentage: type: number format: double description: Percentual de juros bankAccount: type: object allOf: – #/definitions/bankAccount description: Conta bancária usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: eletronicPaymentDefinitions: description: Definições de pagamento eletrônico type: object required: – bank – agency – checkingAccount – agreementNumber – responsibleContract – cnabModel – filesDirectory properties: id: type: string format: uuid description: Id bank: type: object allOf: – #/definitions/bank description: Banco agency: type: integer format: int64 description: Agência checkingAccount: type: integer format: int64 description: Conta Corrente agreementNumber: type: integer format: int64 description: Número de convênio com o banco responsibleContract: type: string description: Contato responsável cnabModel: type: string description: Modelo de CNAB filesDirectory: type: string description: Diretório de arquivos para retorno e remessa bankAccount: type: object allOf: – #/definitions/bankAccount description: Conta bancária usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: environmentStepInfo: description: Steps sequenciais da preparação de ambiente type: object required: – step properties: id: type: string format: uuid description: Id step: type: string allOf: – #/definitions/environmentStep description: Step status: type: string allOf: – #/definitions/environmentStepStatus description: Status errorMessage: type: string maxLength: 1000 description: Mensagem do erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: companiesBranchesDuplication: description: Progresso da duplicação de empresas e filiais type: object required: – databaseDomain properties: id: type: string format: uuid description: Id databaseDomain: type: string description: Domínio do database companyReplicationTables: type: string maxLength: 500 description: Tabelas ligadas à empresa que replicam branchReplicationTables: type: string maxLength: 500 description: Tabelas ligadas à filial que replicam status: type: string allOf: – #/definitions/environmentStepStatus description: Status errorMessage: type: string maxLength: 1000 description: Mensagem de erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: mfaCode: description: Código MFA type: object required: – adminEmail – code – expiration properties: id: type: string format: uuid description: Id adminEmail: type: string description: E-mail do administrador code: type: string maxLength: 6 description: Código expiration: type: string format: date-time description: Validade usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck role: description: Papel type: object required: – name – domainsServices properties: name: type: string description: Nome domainsServices: type: array items: type: object allOf: – #/definitions/roleDomainServices minimum: 1 description: Domínios e serviços roleDomainServices: description: Domínio e serviços do papel configurado type: object required: – domain properties: domain: type: string description: Domínio services: type: array items: type: string description: Serviços (se não for passado nenhum serviço será dado permissão a todos os serviços do domínio) duplicateCompany: description: Ids de empresas para duplicação type: object required: – e070empModelId – e070empNewId properties: e070empModelId: type: string description: Id da empresa modelo e070empNewId: type: string description: Id da empresa que receberá a duplicação duplicateBranch: description: Ids de filiais para duplicação type: object required: – e070filModelId – e070filNewId properties: e070filModelId: type: string description: Id da filial modelo e070filNewId: type: string description: Id da filial que receberá a duplicação duplicateCompaniesBranches: description: Ids das empresas e filiais para duplicação type: object required: – branchData properties: companyData: type: object allOf: – #/definitions/duplicateCompany description: Dados de empresa (opcional) branchData: type: object allOf: – #/definitions/duplicateBranch description: Dados de filial deploymentStepProgress: description: Progresso da implantação type: object properties: errorMessage: type: string description: Mensagem de erro caso ocorra em um dos steps environmentStepStatus: type: string allOf: – #/definitions/environmentStepStatus description: Status da criação dos schemas environmentStep: type: string allOf: – #/definitions/environmentStep description: Step da preparação do ambiente deploymentDatabaseDuplicationProgress: description: Progresso da duplicação de empresas e filiais do domínio type: object required: – databaseDomain properties: databaseDomain: type: string description: Domínio do database status: type: string allOf: – #/definitions/environmentStepStatus description: Status errorMessage: type: string description: Mensagem de erro schedulerPeriod: description: Período de repetição do agendamento. Cada campo é opcional, e sua presença define se é diário, mensal, etc.\nCada campo oferece suporte à expressão Cron, portanto, a repetição é possível usando a sintaxe /{n}. type: object properties: repetitions: type: integer format: int64 description: Quantas vezes este período deve se repetir. Este valor é ignorado se for informado fim. end: type: string format: date-time description: Quando acabar esse período. Se informado, desconsidera o valor de repetições. minute: type: string description: O minuto da hora (0 – 59), o padrão é 0 hour: type: string description: A hora do dia (0 – 23), o padrão é 0 dayOfMonth: type: string description: Dia do mês, para tornar este mensal month: type: string description: Mês do ano (1 – 12) dayOfWeek: type: string description: Em que dia da semana deve ser executado (0 – 6, 0 é domingo) receitaInfo: description: Informações da Receita Federal type: object required: – name – tradeName – country – state properties: name: type: string description: Razão social tradeName: type: string description: Nome fantasia country: type: object allOf: – #/definitions/e006pai description: País com moeda postalCode: type: string description: Código Postal address: type: string description: Endereço addressNumber: type: string description: Número complement: type: string description: Complemento neighborhood: type: string description: Bairro cityCode: type: string description: Código cidade ISS state: type: object allOf: – #/definitions/e007ufs description: Estado phone: type: string description: Telefone email: type: string description: E-mail notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação