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

matriz

54 views 0 27/02/2020 Atualizado em 09/09/2024 integrador

2.0info: 6.24.0 matriz description: Matriz x-senior-domain: erpx_cpl_imp x-senior-domain-path: erpx_cpl_imp x-senior-service-path: matriz 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_cpl_impsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /matriz/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/queries/obterStatusAtualizacaoMatrizTotais: post: description: Consulta o andamento da atualização da matriz por perfil e imposto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresa: type: array items: type: string description: Empresa filial: type: array items: type: string description: Filial codigo: type: string description: Código do Perfil tributário descricao: type: string description: Descrição do perfil tributário regimeTributario: type: array items: type: string allOf: – #/definitions/enumRegime description: Regime tributário segmento: type: array items: type: string description: Segmento situacao: type: array items: type: string allOf: – #/definitions/enumSituacao description: Situação do perfil tributário perfilTributarioId: type: array items: type: string description: Id do perfil tributário responses: 200: description: Ok schema: type: object properties: perfilTributario: type: array items: type: object allOf: – #/definitions/recStatusAtualizacaoPerfilTributario description: Perfis tributários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/queries/historicoParametrizacaoListagem: post: description: Query para listar histórico de andamento das parametrizações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: parametroId: type: string description: Identificação da parametrização da regra tributário imposto: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Definição do imposto que a regra pertence offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros responses: 200: description: Ok schema: type: object required: – historicoParametrizacao properties: historicoParametrizacao: type: array items: type: object allOf: – #/definitions/recHistoricoParametrizacao minimum: 1 description: Lista de histórico de parametrização totalPages: type: integer format: int64 description: Pages totalElements: type: integer format: int64 description: Total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/queries/historicoParametrizacao: post: description: Query para listar histórico da parametrização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – request properties: request: type: object allOf: – #/definitions/recFiltroHistoricoParametrizacaoInput description: Filtrar por responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/recFiltroHistoricoParametrizacaoOutput minimum: 1 description: Listagem totalPages: type: integer format: int64 description: Pages totalElements: type: integer format: int64 description: Total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/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 /matriz/queries/exportComposicaoBaseCalculo: 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 /matriz/queries/exportNcm: 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 /matriz/queries/exportE027eqi: 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 /matriz/queries/exportOrigemDestino: 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 /matriz/queries/exportOperacoes: 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 /matriz/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 /matriz/queries/exportE075der: 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 /matriz/queries/exportPerfilTributario: 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 /matriz/queries/exportMatrizSolicitante: 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 /matriz/queries/exportMatrizRegistros: 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 /matriz/queries/exportMatrizSolicitanteLotes: 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 /matriz/queries/exportPerfilTributarioFilial: 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 /matriz/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 /matriz/queries/exportPerfilTributarioSegmento: 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 /matriz/queries/exportSegmento: 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 /matriz/queries/exportHisParametro: 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 /matriz/queries/exportHisParametroEspecializacao: 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 /matriz/queries/exportHisParametroStatus: 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 /matriz/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 /matriz/actions/gerarMatriz: post: description: Gerar matriz de impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id perfil tributário impostos: type: array items: type: string allOf: – #/definitions/enumImpostos description: Lista de impostos a serem gerados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/resetMatriz: post: description: Reset matriz de impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id perfil tributário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/perfilTributarioUpdated: post: description: Perfil Tributario Updated tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id perfil tributário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/removerParametroEspecificoMatriz: post: description: Remover um parametro especifico da matriz tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idParametro – imposto properties: idParametro: type: string description: Id Parametro imposto: type: string allOf: – #/definitions/enumImpostos description: Imposto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/obterStatusAtualizacaoMatrizDetalhado: post: description: Obter status de atualização da matriz detalhado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresa: type: array items: type: string description: Empresa filial: type: array items: type: string description: Filial codigo: type: string description: Código descricao: type: string description: Descrição regimeTributario: type: array items: type: string allOf: – #/definitions/enumRegime description: Regime tributário segmento: type: array items: type: string description: Segmento situacao: type: array items: type: string allOf: – #/definitions/enumSituacao description: Situação perfilTributarioId: type: array items: type: string description: Id perfil tributário impostoPerfil: type: array items: type: string allOf: – #/definitions/enumImpostos description: Imposto do perfil responses: 200: description: Ok schema: type: object properties: perfilTributario: type: array items: type: object allOf: – #/definitions/perfilTributarioData description: Perfil tributário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/reprocessarRegistroMatriz: post: description: Reprocessar registro da matriz tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – registroId – perfilId – impostoPerfilTributario properties: registroId: type: string description: Id do registro perfilId: type: string description: Id do perfil impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto responses: 200: description: Ok schema: type: object required: – mensagem properties: mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/registroMatrizIncluir: post: description: Incluir um registro na matriz de impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – loteId – impostoPerfilTributario – pagina properties: matrizRegistroId: type: string description: Id da matriz de registros loteId: type: string description: Id do lote de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário pagina: type: integer format: int64 description: Pagina isRetentativa: type: boolean description: É retentativa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/registroMatrizRemover: post: description: Remover um registro da matriz de impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – loteId – impostoPerfilTributario – pagina properties: matrizRegistroId: type: string description: Id da matriz de registros loteId: type: string description: Id do lote de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário pagina: type: integer format: int64 description: Pagina isRetentativa: type: boolean description: É retentativa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/actions/registroMatrizMarcarParaExcluir: post: description: Marcar um registro para ser excluído da matriz de impostos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – loteId – impostoPerfilTributario – pagina properties: matrizRegistroId: type: string description: Id da matriz de registros loteId: type: string description: Id do lote de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário pagina: type: integer format: int64 description: Pagina isRetentativa: type: boolean description: É retentativa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/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 /matriz/actions/importComposicaoBaseCalculo: 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 /matriz/actions/importNcm: 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 /matriz/actions/importE027eqi: 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 /matriz/actions/importOrigemDestino: 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 /matriz/actions/importOperacoes: 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 /matriz/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 /matriz/actions/importE075der: 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 /matriz/actions/importPerfilTributario: 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 /matriz/actions/importMatrizSolicitante: 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 /matriz/actions/importMatrizRegistros: 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 /matriz/actions/importMatrizSolicitanteLotes: 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 /matriz/actions/importPerfilTributarioFilial: 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 /matriz/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 /matriz/actions/importPerfilTributarioSegmento: 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 /matriz/actions/importSegmento: 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 /matriz/actions/importHisParametro: 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 /matriz/actions/importHisParametroEspecializacao: 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 /matriz/actions/importHisParametroStatus: 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 /matriz/signals/gerarMatrizImposto: post: description: Gerar matriz para imposto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tipoImposto – idsParametro properties: tipoImposto: type: string description: Tipo imposto idsParametro: type: array items: type: string minimum: 1 description: Lista de idsParametro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /matriz/signals/updatedSituacaoPerfil: post: description: Inicia o processo quando alterada a situação do perfil tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idPerfilTributario – situacaoPerfil properties: idPerfilTributario: type: string description: Id perfil tributário situacaoPerfil: type: string allOf: – #/definitions/enumSituacao description: Situação perfil responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /matriz/events/filaProcessamentoMatrizImpostos: post: description: Evento ao colocar um registro na fila de processamento da matriz de impostos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – impostoPerfilTributario properties: matrizRegistroId: type: string description: Id da matriz de registros matrizSolicitanteId: type: string description: Matriz solicitante Id impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário matrizSolicitante: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Matriz solicitante dataProcessamentoCalculo: type: string format: date-time description: Data de processamento do cálculo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/processarRegistroMatriz: post: description: Evento ao processar um registro da fila de processamento da matriz de impostos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – impostoPerfilTributario properties: matrizRegistroId: type: string description: Id da matriz de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário dataProcessamentoCalculo: type: string format: date-time description: Data de processamento do cálculo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/registroMatrizAtualizada: post: description: Evento ao finalizar o processamento da matriz de impostos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – impostoPerfilTributario properties: matrizRegistroId: type: string description: Id da matriz de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário dataProcessamentoCalculo: type: string format: date-time description: Data de processamento do cálculo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/parametroCenarioStatusMatriz: post: description: Evento para quando a situação do registro no perfil for alterada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – perfiltributarioId – registroId – impostoPerfilTributario – parametroCenario – dataExecucao – totalRegraTributaria – totalRegraTributariaAtualizando properties: perfiltributarioId: type: string description: Id do perfil tributário registroId: type: string description: Id do registro impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário parametroCenario: type: string allOf: – #/definitions/enumParametroCenario description: Status do cenario da parametrização dataExecucao: type: string format: date-time description: Data de execução totalRegraTributaria: type: integer format: int64 description: Total regra tributaria totalRegraTributariaAtualizando: type: integer format: int64 description: Total regra tributaria atualizando responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/proximaEtapaProcessoMatriz: post: description: Evento ao marcar um registro para ser excluído da matriz de impostos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId – impostoPerfilTributario – processoAtualizarMatriz properties: matrizRegistroId: type: string description: Id da matriz de registros impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário processoAtualizarMatriz: type: string allOf: – #/definitions/enumProcessoAtualizarMatriz description: Etapa processo atualização matriz lote: type: integer format: int64 description: Lote inclusao totalPaginasAdicionar: type: integer format: int64 description: Total de registros para adicionar totalPaginasRemover: type: integer format: int64 description: Total de registros para remover totalRegistrosPagina: type: integer format: int64 description: Total de registros definidos por página dataProcessamentoCalculo: type: string format: date-time description: Data de processamento do cálculo numeroRetentativas: type: integer format: int64 description: Numero de retentativas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/matrizProcessamentoErro: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId properties: matrizRegistroId: type: string description: Id da matriz de registros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/verificarProcessosPendentes: post: description: 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 /matriz/events/reprocessarMatrizComErro: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matrizRegistroId properties: matrizRegistroId: type: string description: Id da Matriz Registro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /matriz/events/importComposicaoBaseCalculoEvent: post: description: 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 /matriz/events/exportComposicaoBaseCalculoEvent: post: description: 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 /matriz/events/importNcmEvent: post: description: 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 /matriz/events/exportNcmEvent: post: description: 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 /matriz/events/importE027eqiEvent: post: description: 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 /matriz/events/exportE027eqiEvent: post: description: 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 /matriz/events/importOrigemDestinoEvent: post: description: 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 /matriz/events/exportOrigemDestinoEvent: post: description: 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 /matriz/events/importOperacoesEvent: post: description: 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 /matriz/events/exportOperacoesEvent: post: description: 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 /matriz/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 /matriz/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 /matriz/events/importE075derEvent: post: description: 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 /matriz/events/exportE075derEvent: post: description: 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 /matriz/events/importPerfilTributarioEvent: post: description: 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 /matriz/events/exportPerfilTributarioEvent: post: description: 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 /matriz/events/importMatrizSolicitanteEvent: post: description: 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 /matriz/events/exportMatrizSolicitanteEvent: post: description: 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 /matriz/events/importMatrizRegistrosEvent: post: description: 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 /matriz/events/exportMatrizRegistrosEvent: post: description: 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 /matriz/events/importMatrizSolicitanteLotesEvent: post: description: 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 /matriz/events/exportMatrizSolicitanteLotesEvent: post: description: 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 /matriz/events/importPerfilTributarioFilialEvent: post: description: 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 /matriz/events/exportPerfilTributarioFilialEvent: post: description: 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 /matriz/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 /matriz/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 /matriz/events/importPerfilTributarioSegmentoEvent: post: description: 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 /matriz/events/exportPerfilTributarioSegmentoEvent: post: description: 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 /matriz/events/importSegmentoEvent: post: description: 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 /matriz/events/exportSegmentoEvent: post: description: 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 /matriz/events/importHisParametroEvent: post: description: 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 /matriz/events/exportHisParametroEvent: post: description: 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 /matriz/events/importHisParametroEspecializacaoEvent: post: description: 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 /matriz/events/exportHisParametroEspecializacaoEvent: post: description: 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 /matriz/events/importHisParametroStatusEvent: post: description: 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 /matriz/events/exportHisParametroStatusEvent: post: description: 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 /matriz/entities/e027eqi: 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/e027eqi responses: 200: description: The created resource schema: #/definitions/e027eqi 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/e027eqi responses: 200: description: The created resource schema: #/definitions/e027eqi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e027eqi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/e027eqi/{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/e027eqi responses: 200: description: Ok schema: #/definitions/e027eqi 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/e027eqi responses: 200: description: Ok schema: #/definitions/e027eqi 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/e027eqi 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 /matriz/entities/e027eqi/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e027eqi responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/origemDestino: 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/origemDestino responses: 200: description: The created resource schema: #/definitions/origemDestino 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/origemDestino responses: 200: description: The created resource schema: #/definitions/origemDestino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/origemDestino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/origemDestino/{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/origemDestino responses: 200: description: Ok schema: #/definitions/origemDestino 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/origemDestino responses: 200: description: Ok schema: #/definitions/origemDestino 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/origemDestino 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 /matriz/entities/origemDestino/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/origemDestino responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/e007ufs: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/e007ufs/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e007ufs responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e007ufs responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/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 /matriz/entities/e075der: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/e075der/{id}: 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/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/perfilTributarioFilial: 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/perfilTributarioFilial responses: 200: description: The created resource schema: #/definitions/perfilTributarioFilial 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/perfilTributarioFilial responses: 200: description: The created resource schema: #/definitions/perfilTributarioFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/perfilTributarioFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/perfilTributarioFilial/{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/perfilTributarioFilial responses: 200: description: Ok schema: #/definitions/perfilTributarioFilial 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/perfilTributarioFilial responses: 200: description: Ok schema: #/definitions/perfilTributarioFilial 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/perfilTributarioFilial 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 /matriz/entities/perfilTributarioFilial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/perfilTributarioFilial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/segmento: 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/segmento responses: 200: description: The created resource schema: #/definitions/segmento 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/segmento responses: 200: description: The created resource schema: #/definitions/segmento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/segmento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /matriz/entities/segmento/{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/segmento responses: 200: description: Ok schema: #/definitions/segmento 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/segmento responses: 200: description: Ok schema: #/definitions/segmento 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/segmento 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 /matriz/entities/segmento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/segmento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumAplicacaoOperacao: description: Aplicação da operação type: string enum: – REMESSA – RETORNO – TRANSFERENCIA – SIMPLES_FATURAMENTO enumDifalNaoContribuinte: description: DIFAL não contribuinte type: string enum: – BASE_UNICA – NAO_SE_APLICA enumDifalContribuinte: description: DIFAL contribuinte type: string enum: – BASE_DUPLA – BASE_DUPLA_DIF_PERC_PER_DESTINO – BASE_DUPLA_DIF_PERCENTUAL – BASE_DUPLA_DIF_VALOR – BASE_UNICA – BASE_UNICA_DIF_PERCENTUAL – NAO_SE_APLICA tipoNotificacao: description: Tipo de notificação type: string enum: – ALERTA – ERRO – NORMAL enumImpostos: description: Impostos type: string enum: – ICMS – PIS – COFINS – ISS – IMPOSTO_IMPORTACAO_II – RETENCOES – IPI – CIDE – ICMS_ST enumImpostoCadastro: description: Impostos type: string enum: – VPIS_COFINS – VTODOS – VISS – VRETENCAO – VII – VIPI – VICMS – VCIDE enumSituacao: description: Situação type: string enum: – VATIVO – VINATIVO enumFinalidadeBaseCalculo: description: Finalidade type: string enum: – ISENTAS_OUTRAS – BASE_CALCULO enumRegime: description: Regime tributário type: string enum: – VLUCRO_REAL – VLUCRO_PRESUMIDO – VSIMPLES_NACIONAL enumSolicitanteAtualizacao: description: Lista de solicitantes para atualização da matriz type: string enum: – NCM – PRODUTO – ALIQUOTA_ICMS – OPERACAO – PIS – COFINS – IPI – II – RETENCOES – CIDE – ICMS – ICMS_ST – ISS – ICMS_ESPECIFICO_ST – BASE_CALCULO – GERAR_MATRIZ – ALIQUOTA_NCM – ALIQUOTA_PRODUTO enumStatusAtualizaMatriz: description: Status para atualização da matriz de impostos type: string enum: – PENDENTE – PROCESSANDO – PROCESSADO – ERRO enumImpostoPerfilTributario: description: Lista de impostos do perfil tributário type: string enum: – PIS – COFINS – IPI – II – RETENCOES – CIDE – ICMS – ISS – ICMS_ST – ICMS_ESPECIFICO_ST – COFINS_IMPORTACAO enumStatusAtualizaMatrizLote: description: Status para atualização da matriz de impostos type: string enum: – PENDENTE – PROCESSANDO – PROCESSADO – ERRO enumProcessoAtualizarMatriz: description: Processo de atualização da matriz para o registro type: string enum: – MARCAR_PARA_EXCLUIR – INCLUIR – EXCLUIR enumParametroCenario: description: Status do cenario da parametrização type: string enum: – PENDENTE – ATUALIZADA – ATUALIZANDO enumTipoOperacao: description: Tipo de operação type: string enum: – VSAIDA – VENTRADA – VAMBOS enumStatusMatriz: description: Status da matriz type: string enum: – PROCESSANDO – FINALIZADO_COM_ERRO – FINALIZADO_COM_SUCESSO enumStatusReprocessamento: description: Status do reprocessamento type: string enum: – SUCESSO – ERRO enumHisParametroStatus: description: Status do registro para histórico do mesmo type: string enum: – AGUARDANDO_PROCESSAMENTO – PROCESSANDO – PROCESSADO – REPROCESSADO enumHisParametroEspecializacao: description: Especialização do parâmetro específico do Perfil tributário type: string enum: – REGIME_PARTICIPANTE – PARTICIPANTE – TIPO_PESSOA – CONTRIBUINTE_ICMS – ORIGEM_MERCADORIA – NCM – GTIN – PRODUTO – LC_116_2003 – NBS – SERVICO – FINALIDADE_COMPRA_VENDA userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 perfilTributarioData: description: Perfil tributário data type: object required: – id properties: id: type: string description: Id registros: type: array items: type: object allOf: – #/definitions/registroData description: Registros registroData: description: Registro data type: object required: – id – impostoPerfil – status properties: id: type: string description: Id impostoPerfil: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil status: type: string allOf: – #/definitions/enumStatusAtualizaMatriz description: Status solicitantes: type: array items: type: object allOf: – #/definitions/solicitanteData description: Solicitantes solicitanteData: description: Solicitante data type: object required: – id – origem properties: id: type: string description: Id origem: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Origem recHistoricoParametrizacao: description: Atributos para retorno da API historicoParametrizacaoListagem type: object required: – id – dataHoraInicioProcessamento – dataHoraFimProcessamento – usuario – solicitante – solicitanteId – solicitanteIdentificacaoNegocio – status – dataHoraDefinicaoStatus properties: id: type: string description: Identificação única do histórico da parametrização dataHoraInicioProcessamento: type: string format: date-time description: Data e hora que o registro foi inserido na fila de processamento dataHoraFimProcessamento: type: string format: date-time description: Data e hora que o registro finalizou o processamento e foi removido da fila de processamento usuario: type: string description: Usuário logado na plataforma que iniciou o processo de atualização solicitante: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Solicitante solicitanteId: type: string description: Identificação única do solicitante solicitanteIdentificacaoNegocio: type: string description: Identificação de negocio do solicitante status: type: string allOf: – #/definitions/enumHisParametroStatus description: Status da parametrização dataHoraDefinicaoStatus: type: string format: date-time description: Data e a hora que o status foi alterado recStatusAtualizacaoTotaisImpostoPerfilTributario: description: Totalizadores dos status dos impostos na atualização da matriz type: object required: – pendente – processando properties: pendente: type: integer format: int64 description: Quantidade de registros pendentes processando: type: integer format: int64 description: Quantidade de registros processando recStatusAtualizacaoImpostoPerfilTributario: description: Status dos impostos do perfil tributário na atualização da matriz type: object required: – nome – status properties: nome: type: string description: Nome do imposto status: type: object allOf: – #/definitions/recStatusAtualizacaoTotaisImpostoPerfilTributario description: Status do imposto recStatusAtualizacaoPerfilTributario: description: Perfil tributário em atualização type: object required: – id – impostos properties: id: type: string description: Id do perfil tributário impostos: type: array items: type: object allOf: – #/definitions/recStatusAtualizacaoImpostoPerfilTributario minimum: 1 description: Impostos recFiltroHistoricoParametrizacaoInput: description: Input do filtro para o histórico da parametrização type: object required: – page – size properties: id: type: string description: Identificação única do histórico da parametrização parametroId: type: string description: Identificação da parametrização da regra tributário imposto: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Definição do imposto que a regra pertence page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros sort: type: array items: type: object allOf: – #/definitions/fieldsBySort description: Ordenação filterquery: type: array items: type: object allOf: – #/definitions/fieldsByFilter description: Filter recFiltroHistoricoParametrizacaoOutput: description: Output para o filtro do histórico da parametrização type: object required: – id – parametroId – dataLimite – usuario – totalPaginasRemovidas – totalRegistrosRemovidos – totalPaginasAdicionadas – totalRegistrosAdicionados – solicitante – solicitanteId – solicitanteIdentificacaoNegocio properties: id: type: string description: Identificação unica parametroId: type: string description: Identificação da parametrização imposto: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto de origem dataHoraInicioProcessamento: type: string format: date-time description: Data e hora que o registro finalizou o processamento e foi removido da fila de processamento dataHoraFimProcessamento: type: string format: date-time description: Data e hora que o registro finalizou o processamento e foi removido da fila de processamento dataLimite: type: string format: date description: Data Limite para processamento da atualização da matriz usuario: type: string description: Usuário logado na plataforma que iniciou o processo de atualização totalPaginasRemovidas: type: integer format: int64 description: Total de paginas removidas da matriz do imposto totalRegistrosRemovidos: type: integer format: int64 description: Total de registros removidos da matriz do imposto totalPaginasAdicionadas: type: integer format: int64 description: Total de paginas adicionados na matriz do imposto totalRegistrosAdicionados: type: integer format: int64 description: Total de registros adicionados da matriz do imposto solicitante: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Solicitante solicitanteId: type: string description: Identificação única do solicitante solicitanteIdentificacaoNegocio: type: string description: Identificação de negocio do solicitante hisParametroEspecializacao: type: array items: type: object allOf: – #/definitions/recParametroEspecializacao description: Histórico da parametrização para as especializações hisParametroStatus: type: array items: type: object allOf: – #/definitions/recHisParametrosStatus description: Histórico da atualização do status de processamento da parametrização recParametroEspecializacao: description: Parametro especializado type: object required: – tipo – totalRegistrosEspecializados properties: tipo: type: string allOf: – #/definitions/enumHisParametroEspecializacao description: Identificação da especialização configurada para o imposto totalRegistrosEspecializados: type: integer format: int64 description: Total de registros que foram especializados recHisParametrosStatus: description: Histórico parametros status type: object required: – dataHoraDefinicaoStatus properties: status: type: string allOf: – #/definitions/enumHisParametroStatus description: Status da parametrização dataHoraDefinicaoStatus: type: string format: date-time description: Data e a hora que o status foi alterado fieldsByFilter: description: Campos para filtros opcionais no frontend type: object properties: field: type: string description: Campo value: type: string description: Valor orValue: type: string description: Outro valor fieldsBySort: description: Campos requeridos para ordenação no frontend type: object properties: field: type: string description: Campo order: type: integer format: int64 description: Ordenação composicaoBaseCalculo: description: Cadastro para definição da base de calculo para o imposto type: object required: – codigo – nome – imposto – composicaoDaBase properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 30 description: Código nome: type: string maxLength: 255 description: Nome imposto: type: string allOf: – #/definitions/enumImpostoCadastro description: Imposto situacao: type: string allOf: – #/definitions/enumSituacao description: Situação composicaoDaBase: type: string maxLength: 512 description: Fórmula para composição da base finalidade: type: string allOf: – #/definitions/enumFinalidadeBaseCalculo description: Finalidade usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: ncm: description: Cadastro para definição do Nomenclatura comercial do Mercosul(NCM) para os produtos type: object required: – codigo – descricao – aliquotaIPI – vigenciaInicial – situacao properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 8 description: Nomenclatura comum do Mercosul (NCM) descricao: type: string maxLength: 250 description: Descrição aliquotaIPI: type: number format: double description: Alíquota IPI minimum: 0 maximum: 999.9999 excecaoIPI: type: boolean description: Exceção de IPI default: false excecaoIPICodigo: type: integer format: int64 description: Código da exceção de IPI minimum: 0 maximum: 999 codigoCest: type: string maxLength: 7 description: Código especificador da substituição tributária e027eqi: type: object allOf: – #/definitions/e027eqi description: Enquadramento de IPI vigenciaInicial: type: string format: date description: Vigência inicial vigenciaFinal: type: string format: date description: Vigência final situacao: type: string allOf: – #/definitions/enumSituacao description: Situação excluido: type: boolean description: Sinaliza se o registro foi excluido default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e027eqi: description: Tabelas – Enquadramento de IPI type: object required: – codEnq – desEnq – situacao properties: id: type: string format: uuid description: Id entidade codEnq: type: integer format: int64 description: Código do enquadramento minimum: 0 maximum: 999 desEnq: type: string maxLength: 499 description: Descrição enquadramento situacao: type: string allOf: – #/definitions/enumSituacao description: situacao 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: origemDestino: description: Tabela ICMS type: object required: – e007ufsOrigem – e007ufsDestino – aliquota – vigenciaInicial properties: id: type: string format: uuid description: Id da entidade e007ufsOrigem: type: object allOf: – #/definitions/e007ufs description: Estado de origem e007ufsDestino: type: object allOf: – #/definitions/e007ufs description: Estado de destino aliquota: type: number format: double description: Percentual minimum: 0 maximum: 999.9999 difalNaoContribuinte: type: string allOf: – #/definitions/enumDifalNaoContribuinte description: Tipo de cálculo para DIFAL não contribuinte difalContribuinte: type: string allOf: – #/definitions/enumDifalContribuinte description: Tipo de cálculo para DIFAL contribuinte percentualImportado: type: number format: double description: Percentual importado minimum: 0 maximum: 999.9999 vigenciaInicial: type: string format: date description: Vigência inicial vigenciaFinal: type: string format: date description: Vigência final 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: operacoes: description: Cadastro para definição das operacoes type: object required: – codigo – vigenciaInicial properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 5 description: Código entrada: type: string maxLength: 512 description: Descrição de entrada saida: type: string maxLength: 512 description: Descrição de saída agrupadora: type: boolean description: É operação agrupadora default: false operacaoAgrupadora: type: object allOf: – #/definitions/operacoes description: Operação agrupadora vigenciaInicial: type: string format: date description: Vigência inicial vigenciaFinal: type: string format: date description: Vigência final excluido: type: boolean description: Sinaliza se o registro foi excluido default: false aplicacaoEntrada: type: string allOf: – #/definitions/enumAplicacaoOperacao description: Aplicação da operação de entrada aplicacaoSaida: type: string allOf: – #/definitions/enumAplicacaoOperacao description: Aplicação da operação de saída usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075der: description: Produto – derivação type: object required: – codDer – desDer properties: id: type: string format: uuid description: Id da entidade codDer: type: string maxLength: 23 description: Derivação desDer: type: string maxLength: 120 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: perfilTributario: description: Cadastro do perfil tributário type: object required: – codigo – nome – situacao – regime properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 3 description: Código nome: type: string maxLength: 255 description: nome situacao: type: string allOf: – #/definitions/enumSituacao description: Situação regime: type: string allOf: – #/definitions/enumRegime description: Regime tributário statusMatriz: type: string allOf: – #/definitions/enumStatusMatriz description: Status matriz excluido: type: boolean description: Sinaliza se o registro foi excluido default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: matrizSolicitante: description: Registra o solicitante para fazer a atualização da matriz type: object required: – solicitante – solicitanteId properties: id: type: string format: uuid description: Identificação única do registro solicitante: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Solicitante para a atualização solicitanteId: type: string format: uuid description: Identificação única do solicitante matrizRegistros: type: array items: type: object allOf: – #/definitions/matrizRegistros description: Relacionamento N:N matrizAtualizarRegistros usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: matrizRegistros: description: Registra ids do solicitante que quer atualizar a matriz de impostos type: object required: – registroId – impostoPerfilTributario – status – dataLimite properties: id: type: string format: uuid description: Identificação única do registro perfilTributarioId: type: string format: uuid description: Perfil tributário do registro registroId: type: string format: uuid description: Registro id da parametrização a ser atualizada impostoPerfilTributario: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Imposto do perfil tributário totalPaginasRemover: type: integer format: int64 description: Total de paginas da parametrização para serem removidas default: 0 totalPaginasAdicionar: type: integer format: int64 description: Total de paginas da parametrização para serem adicionadas default: 0 totalRegistrosPagina: type: integer format: int64 description: Total de registros definidos por página default: 0 dataUltimaPaginaProcessada: type: string format: date-time description: Data e hora da ultima pagina processada status: type: string allOf: – #/definitions/enumStatusAtualizaMatriz description: Status para atualização da matriz dataLimite: type: string format: date-time description: Data limite para atualização da matriz matrizSolicitante: type: array items: type: object allOf: – #/definitions/matrizSolicitante description: Relacionamento N:N matrizSolicitante usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: matrizSolicitanteLotes: description: Registrar os lotes com as paginas a serem executadas type: object required: – pagina – matrizRegistros – processo – status properties: id: type: string format: uuid description: Identificação única do registro pagina: type: integer format: int64 description: Pagina a ser executada matrizRegistros: type: object allOf: – #/definitions/matrizRegistros description: Solicitante da atualização da matriz processo: type: string allOf: – #/definitions/enumProcessoAtualizarMatriz description: Processo a ser executado status: type: string allOf: – #/definitions/enumStatusAtualizaMatrizLote description: Status de execução da pagina usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: perfilTributarioFilial: description: Perfil tributario filial type: object required: – e070fil properties: id: type: string format: uuid description: Id da entidade perfilTributario: type: object allOf: – #/definitions/perfilTributario description: Perfil tributário pai e070fil: type: object allOf: – #/definitions/e070fil description: Filial usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: string format: uuid description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: perfilTributarioSegmento: description: Tabela que relaciona segmentos aos perfis tributários type: object required: – perfilTributario – segmento properties: id: type: string format: uuid description: identificação única do segmento perfilTributario: type: object allOf: – #/definitions/perfilTributario description: Identificação única do perfil tributário id segmento: type: object allOf: – #/definitions/segmento description: Segmento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: segmento: description: Tabela de segmentos do perfil tributário type: object required: – descricao properties: id: type: string format: uuid description: Identificação única do registro descricao: type: string maxLength: 250 description: Descrição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: hisParametro: description: Registra o histórico das informações dos parâmetros type: object required: – imposto – regraTributariaId – dataLimite properties: id: type: string format: uuid description: identificação única do registro matrizRegistrosId: type: string format: uuid description: Id da matriz de registros imposto: type: string allOf: – #/definitions/enumImpostoPerfilTributario description: Identifica qual imposto a regra tributária pertence regraTributariaId: type: string format: uuid description: Identificação única da parametrização tributária dataHoraInicioProcessamento: type: string format: date-time description: Data e hora que o registro foi inserido na fila de processamento dataHoraFimProcessamento: type: string format: date-time description: Data e hora que o registro finalizou o processamento e foi removido da fila de processamento dataLimite: type: string format: date description: Data limite para processar atualização da MATRIZ usuario: type: string maxLength: 255 description: Usuário logado na plataforma que iniciou o processo de atualização totalPaginasRemovidas: type: integer format: int64 description: Total de paginas removidas da matriz do imposto default: 0 totalRegistrosRemovidos: type: integer format: int64 description: Total de registros removidos da matriz do imposto default: 0 totalPaginasAdicionadas: type: integer format: int64 description: Total de paginas adicionados na matriz do imposto default: 0 totalRegistrosAdicionados: type: integer format: int64 description: Total de registros adicionados da matriz do imposto default: 0 solicitante: type: string allOf: – #/definitions/enumSolicitanteAtualizacao description: Solicitante solicitanteId: type: string format: uuid description: Identificação única do solicitante solicitanteIdentificacaoNegocio: type: string maxLength: 500 description: Identificação de negocio do solicitante usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: hisParametroEspecializacao: description: Histórico da parametrização para as especializações type: object required: – hisParametro – tipo properties: id: type: string format: uuid description: Identificação única da parametrização para as especializações hisParametro: type: object allOf: – #/definitions/hisParametro description: Identificação do histórico da parametrização tipo: type: string allOf: – #/definitions/enumHisParametroEspecializacao description: Identificação da especialização configurada para o imposto totalRegistrosEspecializados: type: integer format: int64 description: Total de registros que foram especializados default: 0 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: hisParametroStatus: description: Histórico da atualização do status de processamento da parametrização type: object required: – hisParametro properties: id: type: string format: uuid description: identificação única da parametrização hisParametro: type: object allOf: – #/definitions/hisParametro description: Identificação do histórico da parametrização status: type: string allOf: – #/definitions/enumHisParametroStatus description: Status da parametrização dataHoraDefinicaoStatus: type: string format: date-time description: Data e a hora que o status foi alterado. usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

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