starter

2.0info: 4.0.0 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/getRunningDeploymentProgressStep: post: description: Retorna a etapa atual do processo de implantação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – runningSteps properties: runningSteps: type: array items: type: string allOf: – #/definitions/environmentStep minimum: 1 description: Etapa atual da implantação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a etapa atual do processo de implantação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – runningSteps properties: runningSteps: type: array items: type: string allOf: – #/definitions/environmentStep minimum: 1 description: Etapa atual da implantação 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/exportMigracaoBases: 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/actions/importMigracaoBases: 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/cloneCompanyBranchFinished: post: description: Emitido quando a duplicação de empresa/filial é finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: companies: type: array items: type: string description: Lista de empresas duplicadas branches: type: array items: type: string description: Lista de filiais duplicadas 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/events/importMigracaoBasesEvent: post: description: 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/exportMigracaoBasesEvent: post: description: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editWizard responses: 200: description: Ok schema: #/definitions/editWizard 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editE070emp responses: 200: description: Ok schema: #/definitions/editE070emp 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editE070fil responses: 200: description: Ok schema: #/definitions/editE070fil 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editE006pai responses: 200: description: Ok schema: #/definitions/editE006pai 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editE031moe responses: 200: description: Ok schema: #/definitions/editE031moe 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editE007ufs responses: 200: description: Ok schema: #/definitions/editE007ufs 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editGeneralParameters responses: 200: description: Ok schema: #/definitions/editGeneralParameters 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editCompanyDigitalCertificate responses: 200: description: Ok schema: #/definitions/editCompanyDigitalCertificate 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editCompanyDigitalCertificate responses: 200: description: Ok schema: #/definitions/editCompanyDigitalCertificate 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editBank responses: 200: description: Ok schema: #/definitions/editBank 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editBankAccount responses: 200: description: Ok schema: #/definitions/editBankAccount 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editRemittanceDefinitions responses: 200: description: Ok schema: #/definitions/editRemittanceDefinitions 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editRemittanceDefinitions responses: 200: description: Ok schema: #/definitions/editRemittanceDefinitions 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editEletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/editEletronicPaymentDefinitions 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editEletronicPaymentDefinitions responses: 200: description: Ok schema: #/definitions/editEletronicPaymentDefinitions 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editEnvironmentStepInfo responses: 200: description: Ok schema: #/definitions/editEnvironmentStepInfo 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editCompaniesBranchesDuplication responses: 200: description: Ok schema: #/definitions/editCompaniesBranchesDuplication 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/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/editMfaCode responses: 200: description: Ok schema: #/definitions/editMfaCode 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/genericError /starter/entities/migracaoBases: 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/migracaoBases responses: 200: description: The created resource schema: #/definitions/migracaoBases 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/migracaoBases responses: 200: description: The created resource schema: #/definitions/migracaoBases 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/migracaoBases 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /starter/entities/migracaoBases/{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/editMigracaoBases responses: 200: description: Ok schema: #/definitions/editMigracaoBases 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/migracaoBases responses: 200: description: Ok schema: #/definitions/migracaoBases 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/migracaoBases 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/migracaoBases/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/migracaoBases responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTipEmp: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 description: Segmento de atuação: * `V1` – Indústria * `V2` – Comércio * `V3` – Distribuidor * `V4` – Transportador-Revendedor-Retalhista (TRR) * `V5` – Extração mineral/outros * `V6` – Indústria/Transporte * `V7` – Produtor rural * `V8` – Prestador de serviço * `V9` – Atividade financeira * `V10` – Atividade imobiliária * `V11` – Cooperativa * `V12` – Sociedades seguradoras de capitalização ou entidade aberta de previdência complementar * `V13` – Distribuidor de energia elétrica * `V14` – Prestador de serviço de comunicação * `V99` – Outros enumStatusMigracaoBase: type: string enum: – AGUARDANDO – PROCESSANDO – FINALIZADO description: Situação migração base: * `AGUARDANDO` – Aguardando * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado enumTipMoeCurto: type: string enum: – VD – VH description: Tipo da moeda: * `VD` – Índice * `VH` – Hora enumTipCot: type: string enum: – VD – VM description: Tipo da cotação: * `VD` – Diária * `VM` – Mensal enumTributacaoProdutor: type: string enum: – V1 – V2 description: Tributação do produtor: * `V1` – Comercialização da sua produção * `V2` – Sobre a Folha de Pagamento enumAccountType: type: string enum: – CHECKING_ACCOUNT – SAVING_ACCOUNT description: Tipo de conta: * `CHECKING_ACCOUNT` – Conta corrente * `SAVING_ACCOUNT` – Conta poupança enumCompanyBank: type: string enum: – COMPANY – BANK description: Empresa ou banco: * `COMPANY` – Empresa * `BANK` – Banco enumAccessType: type: string enum: – POP – IMAP description: Tipo de acesso: * `POP` – POP * `IMAP` – IMAP environmentStepStatus: type: string enum: – SKIPPED – IN_PROGRESS – DONE – ERROR description: Status do passo da preparação de ambiente: * `SKIPPED` – Pulado * `IN_PROGRESS` – Em progresso * `DONE` – Finalizado * `ERROR` – Erro enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física environmentStep: type: string enum: – EDOCS_TENANT – CONFIGURED_ROLES – SARA_BOT – SCHEMAS_CREATION – SCHEMAS_INITIAL_LOAD – CREATE_DATACENTER – REPORTS_DATABASE – ENTITIES_TO_FND – ENTITIES_REPLICATION – FUNCTIONS_UPDATE – SET_DUPLICATION_IDS_TABLES – ENTITIES_DUPLICATION – PERSON_CREATION – ADMIN_USER_PERMISSIONS – ERPX_MENU description: Steps da preparação de ambiente: * `EDOCS_TENANT` – Criação do tenant no eDocs * `CONFIGURED_ROLES` – Criação dos papéis configurados * `SARA_BOT` – Criação do bot da Sara * `SCHEMAS_CREATION` – Criação dos schemas * `SCHEMAS_INITIAL_LOAD` – Carga inicial nos databases * `CREATE_DATACENTER` – Criação do Datacenter * `REPORTS_DATABASE` – Habilitação do banco de dados de relatórios * `ENTITIES_TO_FND` – Envio das empresas e filiais do Wizard para o schema erpx_fnd * `ENTITIES_REPLICATION` – Replicação das empresas e filiais do erpx_fnd para outros databases * `FUNCTIONS_UPDATE` – Atualiza as funções nos databases se necessário * `SET_DUPLICATION_IDS_TABLES` – Busca nos databases as tabelas referenciadas, salva as replicadas e cria a tabela duplication_ids * `ENTITIES_DUPLICATION` – Duplica os dados de empresa e filial * `PERSON_CREATION` – Criação e parametrização de pessoa (e001pes) por filial * `ADMIN_USER_PERMISSIONS` – Define as permissões padrões dos usuários admin (Entidades e099usu…) * `ERPX_MENU` – Criação do menu do ERPX wizardQueueStatus: type: string enum: – WAITING – RUNNING – FINISHED_SUCCESSFULLY – FINISHED_WITH_ERROR – TERMINATED_WITH_ERROR description: Status da preparação de ambiente: * `WAITING` – Aguardando * `RUNNING` – Em execução * `FINISHED_SUCCESSFULLY` – Finalizado com sucesso * `FINISHED_WITH_ERROR` – Finalizado com erro * `TERMINATED_WITH_ERROR` – Encerrado com erro schedulerJobPrimitiveType: type: string enum: – ACTION – LIST – SIGNAL description: Tipos de primitivas chamadas pelo agendamento: * `ACTION` – Ação * `LIST` – Lista * `SIGNAL` – Evento userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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: editWizard: type: object required: – id allOf: – #/definitions/wizard 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: editE070emp: type: object required: – id allOf: – #/definitions/e070emp 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: editE070fil: type: object required: – id allOf: – #/definitions/e070fil 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: editE006pai: type: object required: – id allOf: – #/definitions/e006pai 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: editE031moe: type: object required: – id allOf: – #/definitions/e031moe 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: editE007ufs: type: object required: – id allOf: – #/definitions/e007ufs 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: editGeneralParameters: type: object required: – id allOf: – #/definitions/generalParameters 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: editCompanyDigitalCertificate: type: object required: – id allOf: – #/definitions/companyDigitalCertificate 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: editBank: type: object required: – id allOf: – #/definitions/bank 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: editBankAccount: type: object required: – id allOf: – #/definitions/bankAccount 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: editRemittanceDefinitions: type: object required: – id allOf: – #/definitions/remittanceDefinitions 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: editEletronicPaymentDefinitions: type: object required: – id allOf: – #/definitions/eletronicPaymentDefinitions 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: editEnvironmentStepInfo: type: object required: – id allOf: – #/definitions/environmentStepInfo 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: editCompaniesBranchesDuplication: type: object required: – id allOf: – #/definitions/companiesBranchesDuplication 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: editMfaCode: type: object required: – id allOf: – #/definitions/mfaCode migracaoBases: description: Migração de bases type: object required: – dominio – servico – primitiva – status properties: id: type: string format: uuid description: Id dominio: type: string maxLength: 50 description: Domínio servico: type: string maxLength: 50 description: Serviço primitiva: type: string maxLength: 100 description: Primitiva status: type: string allOf: – #/definitions/enumStatusMigracaoBase description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editMigracaoBases: type: object required: – id allOf: – #/definitions/migracaoBases 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage