SHARED (shared)

2.0info: 1.7.0 SHARED description: Shared x-senior-domain: ERPX CPL IMP x-senior-domain-path: erpx_cpl_imp x-senior-service-path: shared 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: /shared/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 /shared/queries/obterCadastrosShared: post: description: Obtem cadastros controlados pela shared tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: cadastros: type: array items: type: object allOf: – #/definitions/recCadastrosShared description: Registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem cadastros controlados pela shared tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: cadastros: type: array items: type: object allOf: – #/definitions/recCadastrosShared description: Registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/obterMonitoramentoShared: post: description: Lista os registros de monitoramento para base shared tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – page – size – sort properties: filtro: type: object allOf: – #/definitions/recFiltroMonitoramentoShared description: Filtro page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade registros sort: type: object allOf: – #/definitions/fieldsBySort description: Ordenação responses: 200: description: Ok schema: type: object properties: registros: type: array items: type: object allOf: – #/definitions/monitoramento description: Registros totalPaginas: type: integer format: int64 description: Total páginas totalRegistros: type: integer format: int64 description: Total registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/obterStatusPublicacao: post: description: Obter o status da publicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificação única da publicação responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/enumStatusPublicacao description: Status da publicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter o status da publicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação única da publicação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/enumStatusPublicacao description: Status da publicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/obterTotalStatusMonitoramento: post: description: Obter total de registros por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – situacao properties: situacao: type: array items: type: string allOf: – #/definitions/enumMonitoramentoStatus minimum: 1 description: Situação entidade: type: array items: type: string allOf: – #/definitions/enumTipoCadastro description: Entidade cadastro: type: string description: Cadastro código de negócio periodoInicial: type: string format: date description: Período inicial periodoFinal: type: string format: date description: Período final responses: 200: description: Ok schema: type: object required: – total properties: total: type: array items: type: object allOf: – #/definitions/recTotalStatusMonitoramentoOut minimum: 1 description: Retorna o total status do lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/obterRegistrosPublicacao: post: description: Obtem informações referentes a publicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – page – size properties: filtro: type: object allOf: – #/definitions/recObterRegistrosPublicacaoFiltro description: Filtro page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade registros responses: 200: description: Ok schema: type: object required: – status – registros properties: status: type: string allOf: – #/definitions/enumStatusPublicacao description: Retorna o status do lote registros: type: array items: type: object allOf: – #/definitions/monitoramento minimum: 1 description: Registros referentes a publicação totalPaginas: type: integer format: int64 description: Total páginas totalRegistros: type: integer format: int64 description: Total registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/obterLotesParaShared: post: description: Obter lotes para shared tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – page – size properties: filtro: type: object allOf: – #/definitions/recFiltroLotesParaShared description: Filtros page: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade registros responses: 200: description: Ok schema: type: object required: – registros properties: registros: type: array items: type: object allOf: – #/definitions/publicacao minimum: 1 description: Lotes para shared totalPaginas: type: integer format: int64 description: Total páginas totalElementos: type: integer format: int64 description: Total elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/verificarRegistroShared: post: description: Obtêm os registros da base shared tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltroRegistroShared description: Filtro responses: 200: description: Ok schema: type: object required: – registros properties: registros: type: array items: type: object allOf: – #/definitions/recFiltroRegistroSharedOut minimum: 1 description: Registros verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/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 /shared/queries/exportMonitoramento: 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 /shared/queries/exportPublicacao: 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 /shared/queries/exportPublicacaoItem: 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 /shared/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 /shared/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 /shared/queries/exportE015med: 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 /shared/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 /shared/actions/prepararPublicacaoRegistros: post: description: Publicar o registro na base compartilhada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – registros properties: registros: type: array items: type: string minimum: 1 description: Registros referentes a publicação responses: 200: description: Ok schema: type: object required: – status – statusDescricao – codigo – id properties: status: type: string allOf: – #/definitions/enumStatusPublicacao description: Retorna o status do lote statusDescricao: type: string description: Descrição do status codigo: type: string maxLength: 50 description: Código do processamento da publicação para o usuário id: type: string description: Identificação única da publicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/actions/publicarRegistros: post: description: Iniciar processo de publicação dos registros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: identificação única da publicação codigo: type: string maxLength: 50 description: Código de identificação para o usuário responses: 200: description: Ok schema: type: object required: – status – statusDescricao – codigo – id properties: status: type: string allOf: – #/definitions/enumStatusPublicacao description: Status da publicacao statusDescricao: type: string description: Descrição do status codigo: type: string maxLength: 50 description: Código do processamento da publicação para o usuário id: type: string description: Identificação única da publicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/actions/recusarRegistros: post: description: Recusar registro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entidadeId – tipoCadastro – motivo properties: entidadeId: type: string description: Identificador da entidade tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Tipo de cadastro motivo: type: string maxLength: 500 description: Motivo para recusa do registro responses: 200: description: Ok schema: type: object required: – entidadeId – tipoCadastro – cadastro – sucesso – mensagem properties: entidadeId: type: string description: Identificador da entidade tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Tipo de cadastro cadastro: type: string maxLength: 500 description: Cadastro sucesso: type: boolean description: Sucesso na recusa do registro mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/actions/disponibilizarParaAprovacaoShared: post: description: Disponibilizar registros para aprovação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – monitoramentoId – motivo properties: monitoramentoId: type: string description: Identificação única do monitoramento motivo: type: string maxLength: 500 description: Motivo por estar revogando o registro responses: 200: description: Ok schema: type: object required: – tipoCadastro – entidadeId – cadastro properties: tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Tipo da entidade do registro entidadeId: type: string description: identificação única do registro para a entidade cadastro: type: string maxLength: 1000 description: Descrição do cadastro, identificação de negócio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/actions/verificarIgualdadeCamposRegistroShared: post: description: Verificar igualdade de entidade entre tenant e shared tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entidade – entidadeId properties: entidade: type: string allOf: – #/definitions/enumTipoCadastro description: Entidade entidadeId: type: string description: Identificação única do registro responses: 200: description: Ok schema: type: object required: – entidade – entidadeId – codigo – registroEntidadeShared – status properties: entidade: type: string allOf: – #/definitions/enumTipoCadastro description: Entidade entidadeId: type: string description: Identificação única do registro codigo: type: string description: Código de negócio do registro registroEntidadeShared: type: array items: type: object allOf: – #/definitions/registroEntidadeShared minimum: 1 description: Registro encontrado na shared status: type: string allOf: – #/definitions/enumStatusRegistroEntidadeShared description: Status do registro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/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 /shared/actions/importMonitoramento: 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 /shared/actions/importPublicacao: 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 /shared/actions/importPublicacaoItem: 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 /shared/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 /shared/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 /shared/actions/importE015med: 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 /shared/events/verificarPendenciaPublicacao: post: description: Evento de atualização das informações da publicacao x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – monitoramentoId – publicacaoId properties: monitoramentoId: type: array items: type: string minimum: 1 description: IDs do monitoramento publicacaoId: type: string description: ID publicacao responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /shared/events/persisteErroPublicacao: post: description: Evento de atualização das informações com erro da publicação x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – publicacao – item – erro properties: publicacao: type: object allOf: – #/definitions/publicacao description: Publicacao item: type: object allOf: – #/definitions/publicacaoItem description: Item da publicação erro: type: string description: Erro lançado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /shared/events/statusMonitoramentoShared: post: description: Evento para atualização de status da entidade de monitoramento. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – status – periodo – tipoCadastro – cadastro – statusAnterior properties: status: type: string allOf: – #/definitions/enumMonitoramentoStatus description: Status tabela monitoramento periodo: type: string format: date description: Período em que o registro foi criado no monitoramento tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Entidade no qual o registro está criado cadastro: type: string description: Código de negócio do registro statusAnterior: type: string allOf: – #/definitions/enumMonitoramentoStatus description: Status anterior do registro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /shared/events/statusLoteMonitoramentoShared: post: description: Evento para notificar o frontend via websocket x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – status – codigoLote properties: id: type: string description: Id da publicacao status: type: string allOf: – #/definitions/enumStatusPublicacao description: Situação da publicacao codigoLote: type: string description: Codigo do lote de publicacao responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /shared/events/importMonitoramentoEvent: post: description: 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 /shared/events/exportMonitoramentoEvent: post: description: 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 /shared/events/importPublicacaoEvent: post: description: 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 /shared/events/exportPublicacaoEvent: post: description: 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 /shared/events/importPublicacaoItemEvent: post: description: 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 /shared/events/exportPublicacaoItemEvent: post: description: 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 /shared/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 /shared/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 /shared/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 /shared/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 /shared/events/importE015medEvent: post: description: 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 /shared/events/exportE015medEvent: post: description: 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 /shared/entities/ncm: 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/ncm responses: 200: description: The created resource schema: #/definitions/ncm 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/ncm responses: 200: description: The created resource schema: #/definitions/ncm 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/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/ncm/{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/ncm responses: 200: description: Ok schema: #/definitions/ncm 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/ncm responses: 200: description: Ok schema: #/definitions/ncm 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/ncm 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 /shared/entities/ncm/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ncm responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/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 /shared/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 /shared/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 /shared/entities/e015med: 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/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/e015med/{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/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTipoCadastro: description: Tipo cadastro type: string enum: – E015MED – ORIGEM_DESTINO – NCM – LEI_COMPLEMENTAR_116_2003 – NBS – TABELA_PROGRESSIVA_INSS – TABELA_PROGRESSIVA_IRRF – E027STR – COMPOSICAO_BASE_CALCULO – E027EQI – BENEFICIO_FISCAL – OPERACOES – NATUREZA_RECEITA_PIS_COFINS – PIS_PARAMETRO – COFINS_PARAMETRO – IPI_PARAMETRO – CIDE_PARAMETRO – II_PARAMETRO – ISS_PARAMETRO – ICMS_PARAMETROS – RET_PARAMETRO enumMonitoramentoStatus: description: Status monitoramento type: string enum: – EM_PUBLICACAO – PUBLICADO – RECUSADO – REVOGADA_PUBLICACAO – ERRO enumStatusPublicacao: description: Status de publicação do processo type: string enum: – CRIANDO – AGUARDANDO_APROVACAO – PROCESSANDO – ERRO – APROVADO – PUBLICADO enumTipoOperacaoShared: description: Está importando ou exportando o dado para shared type: string enum: – IMPORTACAO – EXPORTACAO enumStatusRegistroEntidadeShared: description: Status dos registros shareds comparados a base logada type: string enum: – ENCONTRADO_TOTAL – ENCONTRADO_PARCIAL – NAO_ENCONTRADO 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 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 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 recCadastrosShared: description: Cadastros controlados pela shared type: object required: – chaveEntidade – descricaoEntidade properties: chaveEntidade: type: string maxLength: 350 description: Nome entidade descricaoEntidade: type: string maxLength: 350 description: Descrição entidade recFiltroMonitoramentoShared: description: Filtro para registros de monitoramento type: object required: – status – tipoCadastro – dataInicial properties: status: type: array items: type: string allOf: – #/definitions/enumMonitoramentoStatus minimum: 1 description: Lista de status dos registros monitorados tipoCadastro: type: array items: type: string allOf: – #/definitions/enumTipoCadastro minimum: 1 description: Lista de tipo/origem do cadastro monitorado cadastro: type: string description: Cadastro descritivo de negócio para o registro entidadeId: type: array items: type: string description: Lista de Ids dos registros monitorados dataInicial: type: string format: date description: Período inicial de monitoramento dataFinal: type: string format: date description: Período final de monitoramento recObterRegistrosPublicacaoFiltro: description: Filtro para ObterRegistroasPublicacaoFiltro type: object properties: id: type: string description: Identificação única do processo de publicação codigo: type: string description: Identificação do usuário recFiltroLotesParaShared: description: Filtro para ObterLoteParaShared type: object properties: codigo: type: string description: Código do lote status: type: array items: type: string allOf: – #/definitions/enumStatusPublicacao description: Status do lote periodoInicial: type: string format: date description: Período inicial periodoFinal: type: string format: date description: Período final registroEntidadeShared: description: Conteúdo do registro da shared type: object required: – campo – conteudo – isIgual properties: campo: type: string description: Campo da entidade retornada conteudo: type: string description: Conteudo existente na base shared isIgual: type: boolean description: Confirma se o registro da base está igual a shared recFiltroRegistroShared: description: Filtro para verificarRegistroShared type: object required: – registros properties: registros: type: array items: type: object allOf: – #/definitions/recRegistrosShared minimum: 1 description: Lista de registros da shared recRegistrosShared: description: type: object required: – entidade – entidadeId properties: entidade: type: string description: Entidade entidadeId: type: string description: Identificação única do registro recFiltroRegistroSharedOut: description: Filtro para verificarRegistroShared type: object required: – entidade – entidadeId – codigo – status properties: entidade: type: string description: Entidade entidadeId: type: string description: Identificação única do registro codigo: type: string description: Código de negócio do registro status: type: string allOf: – #/definitions/enumStatusRegistroEntidadeShared description: Status do registro recTotalStatusMonitoramento: description: Filtro para obterTotalStatusMonitoramento type: object required: – tipoCadastro properties: tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Tipo de cadastro totalRegistros: type: integer format: int64 description: Total de registros recTotalStatusMonitoramentoOut: description: Total do status da tabela de monitoramento type: object required: – situacao – totalEntidades properties: situacao: type: string allOf: – #/definitions/enumMonitoramentoStatus description: Retorna o status do lote totalEntidades: type: array items: type: object allOf: – #/definitions/recTotalStatusMonitoramento minimum: 1 description: Total de entidades encontradas monitoramento: description: Controle dos registros para serem importados/exportados da shared type: object required: – cadastro – tipoCadastro – entidadeId – tipoOperacaoShared – status properties: id: type: string format: uuid description: identificação unica do registro cadastro: type: string maxLength: 500 description: Cadastro tipoCadastro: type: string allOf: – #/definitions/enumTipoCadastro description: Tipo de cadastro entidadeId: type: string format: uuid description: identificação unica do registro na entidade tipoOperacaoShared: type: string allOf: – #/definitions/enumTipoOperacaoShared description: Tipo da operação shared status: type: string allOf: – #/definitions/enumMonitoramentoStatus description: Status statusDescricao: type: string maxLength: 500 description: Status descrição excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: type: string format: date-time description: publicacao: description: Registrar os processos de publicações type: object required: – dataInicio – codigo – status – statusDescricao properties: id: type: string format: uuid description: Identificação única do registro dataInicio: type: string format: date description: Data de inicio do processo codigo: type: string maxLength: 50 description: Codigo unico de identificacao dataFim: type: string format: date description: Data de termino do processo status: type: string allOf: – #/definitions/enumStatusPublicacao description: Status do processo de publicação statusDescricao: type: string maxLength: 500 description: Descrição para o status descricaoProcesso: type: string maxLength: 500 description: Descrição do processo de publicação excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: type: string format: date-time description: publicacaoItem: description: Registrar os itens adicionados ao processo de publicação para a shared type: object required: – publicacaoId – entidade – entidadeId – versaoAnterior properties: id: type: string format: uuid description: Identificação única do registro publicacaoId: type: object allOf: – #/definitions/publicacao description: Identificação única da publicação entidade: type: string allOf: – #/definitions/enumTipoCadastro description: Entidade entidadeId: type: string format: uuid description: Identificação única do registro na entidade versaoAnterior: type: boolean description: Versão anterior versaoAnteriorVigenciaFinal: type: string format: date description: Vigência final da versão anterior excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: 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 – uTrib – 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 uTrib: type: object allOf: – #/definitions/e015med description: Unidade de medida tributável 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 description: Situação tipoOrigem: type: string description: Tipo da origem origem: type: string maxLength: 150 description: Origem do registro baseLegal: type: string maxLength: 500 description: Base legal excluido: type: boolean description: Sinaliza se o registro foi excluido default: false ncmPrincipalId: type: string format: uuid description: Identificação única da NCM principal ncmPrincipalOrigemId: type: string format: uuid description: Identificação única da NCM principal de origem usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: 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 description: situacao excluido: type: boolean description: Indica se o registro foi excluído default: false tipoOrigem: type: string description: Tipo da origem origem: type: string maxLength: 150 description: Tenant de origem do cadastro usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: type: string format: date-time description: e015med: description: Cadastros – Unidades de Medida type: object required: – uniMed – desMed properties: id: type: string format: uuid description: Id da entidade uniMed: type: string maxLength: 3 description: Unidade de medida desMed: type: string maxLength: 10 description: Descrição da unidade de medida excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: datger: type: string format: date-time description: usualt: type: string description: datalt: 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