2.0info: 2.4.1 Cálculo de consumo dos produtos description: Serviço de cálculo de consumo dos produtos do estoque x-senior-domain: Estoque x-senior-domain-path: erp_est x-senior-service-path: ccn_calculoconsumo 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/erp_estsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ccn_calculoconsumo/queries/buscarEmpresa: post: description: Busca por múltiplas empresas podendo ser todas caso nenhum filtro seja informado, ou uma lista filtrada caso algum seja. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: id: type: integer format: int64 description: Id da empresa texto: type: string description: Texto para busca parcial no código ou nome fantasia da empresa pagina: type: object allOf: – #/definitions/recPaginacaoLimit description: Dados para paginação responses: 200: description: Ok schema: type: object required: – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa description: Retorna lista de empresas filtrada pelos parâmetros informados totalRegistros: type: integer format: int64 description: Total de registros para paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarIdsTodasEmpresas: post: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarFiliaisMultiplasEmpresas: post: description: Retornar empresas com suas filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: Texto para busca parcial no código ou nome fantasia da empresa todas: type: boolean description: Flag indicando se a busca por filiais deve considerar todas as empresas. somente: type: array items: type: integer format: int64 description: Caso todas == false, devem ser informadas as empresas selecionadas para buscar suas filiais. Nesse caso o campo exceto é ignorado. exceto: type: array items: type: integer format: int64 description: Caso todas == true, as filiais de todas as empresas devem ser consideradas na busca. Caso o usuário selecione todas as empresas e desmarca algumas poucas, o componente enviará os IDs das empresas desmarcadas nesse campo pagina: type: object allOf: – #/definitions/recPaginacaoLimit description: Dados para paginação responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Retorna lista de empresas e filiais filtrada pelos parâmetros informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarIdsFiliaisPorEmpresas: post: description: Retorna todos os IDs das filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaIds description: IDs das empresas in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/pesquisarEmpresa: post: description: Retorna empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa orderby: type: string description: Define ordenação dos dados pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – empresas – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/recPessoa minimum: 1 description: Retorna a lista de empresas totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/pesquisarFilial: post: description: Retorna filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: código da empresa pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente empresaId: type: integer format: int64 description: Id da empresa para pesquisar codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa orderby: type: string description: Define ordenação dos dados pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – filiais – totalRegistros properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna a lista de filiais totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarSugestaoTransacao: post: description: Retorna as transações de estoque sugeridas para cálculo de consumo que foram cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: array items: type: integer format: int64 description: Identificação da empresa processo: type: string allOf: – #/definitions/enumTipoProcesso description: Tipo de processo responses: 200: description: Ok schema: type: object properties: sugestaoProcesso: type: array items: type: object allOf: – #/definitions/sugestaoTransacaoProcesso description: Sugestão de transações cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarConsumoSkus: post: description: Busca o consumo de determinados produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processo – itens properties: processo: type: string allOf: – #/definitions/enumTipoProcesso description: Tipo de processo para obter o cálculo de consumo itens: type: array items: type: object allOf: – #/definitions/recItemBuscarConsumoSku minimum: 1 description: Itens para buscar o consumo responses: 200: description: Ok schema: type: object required: – itens properties: itens: type: array items: type: object allOf: – #/definitions/recItemRespostaBuscarConsumoSku minimum: 1 description: Consumo obtido para os itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/pesquisarConfiguracoesCalculoConsumo: post: description: Retorna os parâmetros de uma configuração de cálculo de consumo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: idEmpresa: type: integer format: int64 description: ID da empresa idsFiliais: type: array items: type: integer format: int64 description: IDs das filiais codigosFamilias: type: array items: type: string description: Códigos das famílias skus: type: array items: type: string description: SKUs dos produtos processo: type: string allOf: – #/definitions/enumTipoProcesso description: Processo da configuração paginacao: type: object allOf: – #/definitions/recPaginacaoLimit description: Dados para paginação responses: 200: description: Ok schema: type: object required: – configuracoes properties: configuracoes: type: array items: type: object allOf: – #/definitions/configuracaoCalculoConsumo minimum: 1 description: Parâmetros da configuração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarTransacoesConfiguracaoCalculoConsumo: post: description: Retorna as transações de uma configuração de cálculo de consumo 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 da configuração responses: 200: description: Ok schema: type: object required: – ligacoes properties: ligacoes: type: array items: type: object allOf: – #/definitions/configuracaoCalculoTransacao minimum: 1 description: Ligações da configuração de cálculo com suas transações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as transações de uma configuração de cálculo de consumo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação da configuração in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ligacoes properties: ligacoes: type: array items: type: object allOf: – #/definitions/configuracaoCalculoTransacao minimum: 1 description: Ligações da configuração de cálculo com suas transações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/buscarSazonalidadesConfiguracaoCalculoConsumo: post: description: Retorna as sazonalidades de uma configuração de cálculo de consumo 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 da configuração responses: 200: description: Ok schema: type: object required: – ligacoes properties: ligacoes: type: array items: type: object allOf: – #/definitions/configuracaoCalculoSazonalidade minimum: 1 description: Ligações da configuração de cálculo com suas sazonalidades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as sazonalidades de uma configuração de cálculo de consumo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação da configuração in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ligacoes properties: ligacoes: type: array items: type: object allOf: – #/definitions/configuracaoCalculoSazonalidade minimum: 1 description: Ligações da configuração de cálculo com suas sazonalidades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/queries/healthcheck: post: description: Query para o SRE verificar a disponibildade 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 disponibildade 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 /ccn_calculoconsumo/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 /ccn_calculoconsumo/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportSugestaoTransacaoProcesso: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportTransacao: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportFamilia: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportSku: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportConfiguracaoCalculoConsumo: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportConfiguracaoCalculoTransacao: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportConfiguracaoCalculoSazonalidade: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportDeposito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportDepositoSkuParametro: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportConsumoDiario: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/exportSazonalidade: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /ccn_calculoconsumo/actions/sugerirTransacoes: post: description: Sugere as transações padrões para uma determinada configuração de cálculo de consumo, gravando-os no banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configuracaoCalculoConsumoId properties: configuracaoCalculoConsumoId: type: string description: ID de um conjunto de parâmetros para cálculo de consumo responses: 200: description: Ok schema: type: object required: – sugestaoRealizada properties: sugestaoRealizada: type: boolean description: Indicativo se foi feita sugestão ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importSugestaoTransacaoProcesso: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importTransacao: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importFamilia: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importSku: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importConfiguracaoCalculoConsumo: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importConfiguracaoCalculoTransacao: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importConfiguracaoCalculoSazonalidade: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importDeposito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importDepositoSkuParametro: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importConsumoDiario: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/actions/importSazonalidade: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /ccn_calculoconsumo/entities/pessoa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/pessoa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/pessoa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pessoa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sugestaoTransacaoProcesso: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sugestaoTransacaoProcesso responses: 200: description: The created resource schema: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sugestaoTransacaoProcesso responses: 200: description: The created resource schema: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sugestaoTransacaoProcesso/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sugestaoTransacaoProcesso responses: 200: description: Ok schema: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sugestaoTransacaoProcesso responses: 200: description: Ok schema: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sugestaoTransacaoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/sugestaoTransacaoProcesso/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sugestaoTransacaoProcesso responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/transacao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transacao responses: 200: description: The created resource schema: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/transacao responses: 200: description: The created resource schema: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/transacao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/transacao responses: 200: description: Ok schema: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/transacao responses: 200: description: Ok schema: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/transacao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/transacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/familia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/familia/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/familia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/familia responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sku: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sku/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/sku/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sku responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoConsumo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoConsumo responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoConsumo responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoConsumo/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoConsumo responses: 200: description: Ok schema: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoConsumo responses: 200: description: Ok schema: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configuracaoCalculoConsumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/configuracaoCalculoConsumo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracaoCalculoConsumo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoTransacao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoTransacao responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoTransacao responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoTransacao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoTransacao responses: 200: description: Ok schema: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoTransacao responses: 200: description: Ok schema: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configuracaoCalculoTransacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/configuracaoCalculoTransacao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracaoCalculoTransacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoSazonalidade: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoSazonalidade responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/configuracaoCalculoSazonalidade responses: 200: description: The created resource schema: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/configuracaoCalculoSazonalidade/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoSazonalidade responses: 200: description: Ok schema: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/configuracaoCalculoSazonalidade responses: 200: description: Ok schema: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/configuracaoCalculoSazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/configuracaoCalculoSazonalidade/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracaoCalculoSazonalidade responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/deposito: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/deposito/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/deposito/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deposito responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/depositoSkuParametro: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/depositoSkuParametro responses: 200: description: The created resource schema: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/depositoSkuParametro responses: 200: description: The created resource schema: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/depositoSkuParametro/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/depositoSkuParametro responses: 200: description: Ok schema: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/depositoSkuParametro responses: 200: description: Ok schema: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/depositoSkuParametro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/depositoSkuParametro/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/depositoSkuParametro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/consumoDiario: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/consumoDiario responses: 200: description: The created resource schema: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/consumoDiario responses: 200: description: The created resource schema: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/consumoDiario/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/consumoDiario responses: 200: description: Ok schema: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/consumoDiario responses: 200: description: Ok schema: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/consumoDiario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/consumoDiario/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/consumoDiario responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidade: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sazonalidade responses: 200: description: The created resource schema: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sazonalidade responses: 200: description: The created resource schema: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidade/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidade responses: 200: description: Ok schema: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidade responses: 200: description: Ok schema: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sazonalidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/sazonalidade/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sazonalidade responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidadePeriodo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sazonalidadePeriodo responses: 200: description: The created resource schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sazonalidadePeriodo responses: 200: description: The created resource schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidadePeriodo/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidadePeriodo responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidadePeriodo responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ccn_calculoconsumo/entities/sazonalidade/{parentId}/periodos: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/sazonalidadePeriodo responses: 200: description: The created resources schema: type: array items: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/sazonalidadePeriodo responses: 200: description: The created resources schema: type: array items: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidade/{parentId}/periodos/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidadePeriodo responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sazonalidadePeriodo responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sazonalidadePeriodo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ccn_calculoconsumo/entities/sazonalidadePeriodo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sazonalidadePeriodo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumTipoProcesso: description: Tipos de processo cálculo de consumo type: string enum: – AnaliseDeReposicao – PlanoOperacional enumTiposConsumo: description: Tipos para movimento de estoque type: string enum: – Venda – RemessaParaIndustrializacao – TransferenciaEntreFiliais – DevolucaoParaFornecedor – AbastecimentoDeProducao – Compra – DevolucaoDeCliente – ApontamentoDeProducao – ConsumoProprio – AcertoSobra – AcertoPerda – RetornoRemessaIndustrializacao – Bloqueio enumInativoAtivo: description: Enumerador de situação do registro type: string enum: – Inativo – Ativo enumAtivoInativo: description: Enumerador de situação do registro type: string enum: – Ativo – Inativo enumPeriodoConsiderado: description: Enumerador do período a ser considerado type: string enum: – Anteriormente – AnoPassado – AnoPassadoComDiasEstoque enumEntradaSaida: description: Enumerador de situação do registro type: string enum: – Entrada – Saida enumSimNao: description: Sim / não type: string enum: – Nao – Sim enumFormaValorizacao: description: Forma de valorização type: string enum: – Movimento – Fechamento enumTipoPessoa: description: Tipo de pessoa Empresa/Filial type: string enum: – Empresa – Filial enumIntervaloCalculoConsumo: description: Enumerador de Intervalo de consumo type: string enum: – Dia – Semana – Mes – Ano upDown: description: Up or down type: string enum: – UP – DOWN 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 – 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 recPagina: description: Dados para paginação de registros type: object required: – offset – limit properties: offset: type: integer format: int64 description: Qual página limit: type: integer format: int64 description: Limite de registros recPessoa: description: Dados referente a tabela Pessoa (Empresa/Filial) type: object properties: id: type: integer format: int64 description: Identificador único entidade pessoa tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo pessoa da empresa ou filial codigo: type: integer format: int64 description: Código da empresa ou filial nome: type: string maxLength: 100 description: Nome da empresa ou filial fantasia: type: string maxLength: 50 description: Nome fantasia da empresa ou filial pessoaOrigem: type: object allOf: – #/definitions/recPessoa description: Código da empresa a qual a filial pertence dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string description: Usuário geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário geração recPaginacaoLimit: description: Dados de paginação type: object required: – offset – limit properties: offset: type: integer format: int64 description: Número da página. limit: type: integer format: int64 description: Quantidade de registros na página orderBy: type: string description: Campos para ordenação recEmpresa: description: Empresa type: object required: – codigo – tipo properties: id: type: integer format: int64 description: Id da empresa codigo: type: string maxLength: 4 description: Código da empresa nome: type: string maxLength: 100 description: Nome fantasia da empresa tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa recEmpresaComFiliais: description: Empresas type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: Id da empresa codigo: type: string description: Código da empresa nome: type: string description: Nome fantasia da empresa filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais recFilial: description: Filiais type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: Id da filial nome: type: string description: Nome fantasia da filial codigo: type: string description: Código da filial recItemBuscarConsumoSku: description: Parâmetros para busca de consumo de produto type: object required: – codigoEmpresa – codigoFilial – codigoDeposito – sku properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoDeposito: type: string description: Código do depósito sku: type: string description: SKU qtdDiasPosteriores: type: integer format: int64 description: Dias posteriores recItemRespostaBuscarConsumoSku: description: Dados de resposta da busca de consumo de produto type: object required: – codigoEmpresa – codigoFilial – codigoDeposito – sku – periodos – consumoMedio properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoDeposito: type: string description: Código do depósito sku: type: string description: SKU tipoIntervalo: type: string allOf: – #/definitions/enumIntervaloCalculoConsumo description: Tipo de intervalo para obtenção do cálculo de consumo periodos: type: array items: type: object allOf: – #/definitions/recPeriodoCalculoConsumoSku minimum: 1 description: Períodos para obtenção do cálculo de consumo consumoMedio: type: string description: Consumo médio skuSubstituto: type: string description: Produto substituto recPeriodoCalculoConsumoSku: description: Detalhamento do período de cálculo de consumo type: object required: – inicio – fim – quantidadeConsumida – possuiPeriodoSazonal properties: inicio: type: string format: date description: Data do início do período fim: type: string format: date description: Data do fim do período quantidadeConsumida: type: number format: double description: Quantidade consumida do produto no período possuiPeriodoSazonal: type: boolean description: Indicativo se o período possui uma data sazonal desconsideradoPicosVales: type: boolean description: Indicativo se está sendo desconsiderado picos e vales no período default: false utilizadoHistoricoSubstituidoEquivalente: type: boolean description: Indicativo se este período utiliza o histórico de um SKU substituído ou equivalente default: false 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 pessoa: description: Entidade mantém cadastro de empresa e filiais type: object required: – tipo – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificados único tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo da pessoa (Empresa/Filial) codigo: type: integer format: int64 description: Código da empresa/filial nome: type: string maxLength: 100 description: Nome da empresa/filial fantasia: type: string maxLength: 50 description: Nome fantasia da empresa/filial pessoaIdOrigem: type: object allOf: – #/definitions/pessoa description: Empresa origem usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sugestaoTransacaoProcesso: description: Sugestão de transação para cálculo de consumo type: object required: – processo – transacao properties: id: type: string format: uuid description: Identificador único processo: type: string allOf: – #/definitions/enumTipoProcesso description: Tipos de processo cálculo de consumo transacao: type: object allOf: – #/definitions/transacao description: Transação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: transacao: description: Transações de estoque type: object required: – empresa – codigo – descricao – situacao – consignacaoCliente – consignacaoFornecedor – considerarQuantidade properties: id: type: string format: uuid description: Identificador único empresa: type: object allOf: – #/definitions/pessoa description: Registro da empresa da transação codigo: type: string maxLength: 5 description: Código da transação descricao: type: string maxLength: 60 description: Descrição da transação origem: type: string allOf: – #/definitions/enumTiposConsumo description: Campo para classificar o tipo de movimentação de estoque situacao: type: string allOf: – #/definitions/enumInativoAtivo description: Situação do registro modulo: type: string maxLength: 3 description: Módulo da transação estoqueMovimentado: type: string maxLength: 2 description: Tipo do estoque movimentado indicativoOperacao: type: string allOf: – #/definitions/enumEntradaSaida description: Indica se a operação é de entrada ou saída consignacaoCliente: type: string allOf: – #/definitions/enumSimNao description: Indicativo se a transação movimenta estoques consignados a clientes consignacaoFornecedor: type: string allOf: – #/definitions/enumSimNao description: Indicativo se a transação movimenta estoques consignados a fornecedor formaValorizacao: type: string allOf: – #/definitions/enumFormaValorizacao description: Indicativo da forma de valorização considerarQuantidade: type: string allOf: – #/definitions/enumSimNao description: Indicativo se deve considerar quantidade para movimento transacaoTransferencia: type: string maxLength: 5 description: Código da transação para transferência depositoPadrao: type: string maxLength: 10 description: Código do depósito padrão usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: familia: description: Entidade família type: object required: – empresa – codigo – descricao properties: id: type: integer format: int64 description: Identificados único empresa: type: object allOf: – #/definitions/pessoa description: Empresa da família codigo: type: string description: Código da família descricao: type: string description: Descrição da família usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sku: description: Entidade de SKU type: object required: – empresa – codigo – descricao – familia properties: id: type: integer format: int64 description: Identificados único empresa: type: object allOf: – #/definitions/pessoa description: Empresa do produto codigo: type: string description: SKU descricao: type: string description: Descrição do produto familia: type: object allOf: – #/definitions/familia description: Família do produto usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: configuracaoCalculoConsumo: description: Configurações para cálculo de consumo type: object required: – empresa – intervalo – quantidade_intervalos – processo – tipoMovimento – periodoConsiderado properties: id: type: string format: uuid description: Identificador único empresa: type: object allOf: – #/definitions/pessoa description: Empresa filial: type: object allOf: – #/definitions/pessoa description: Filial familia: type: object allOf: – #/definitions/familia description: Família sku: type: object allOf: – #/definitions/sku description: SKU intervalo: type: string allOf: – #/definitions/enumIntervaloCalculoConsumo description: Tipo de intervalo para cálculo de consumo. Indica a periodicidade quantidade_intervalos: type: integer format: int64 description: Quantidade de intervalos para cálculo de consumo processo: type: string allOf: – #/definitions/enumTipoProcesso description: Processo tipoMovimento: type: string allOf: – #/definitions/enumEntradaSaida description: Tipo de movimento a considerar como quantidade consumida (considerar que a quantidade consumida é saída ou entrada?) periodoConsiderado: type: string allOf: – #/definitions/enumPeriodoConsiderado description: Período considerado para cálculo descartarPicosVales: type: boolean description: Descartar picos e vales default: false limiteDesvioPadrao: type: number format: double description: limiteDesvioPadrao usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: configuracaoCalculoTransacao: description: Transações de uma configuração de cálculo de consumo type: object required: – configuracao – transacao properties: id: type: string format: uuid description: Identificador único configuracao: type: object allOf: – #/definitions/configuracaoCalculoConsumo description: Parâmetros de consumo transacao: type: object allOf: – #/definitions/transacao description: Transação para cálculo de consumo usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: configuracaoCalculoSazonalidade: description: Sazonalidades de uma configuração de cálculo de consumo type: object required: – configuracao – sazonalidade properties: id: type: string format: uuid description: Identificador único configuracao: type: object allOf: – #/definitions/configuracaoCalculoConsumo description: Parâmetros de consumo sazonalidade: type: object allOf: – #/definitions/sazonalidade description: Sazonalidades para cálculo de consumo usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: deposito: description: Entidade depósito type: object required: – codigo – descricao – filial – geraReposicao properties: id: type: integer format: int64 description: Identificados único codigo: type: string maxLength: 10 description: Código do depósito descricao: type: string maxLength: 30 description: Descrição filial: type: object allOf: – #/definitions/pessoa description: Filial do depósito situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação geraReposicao: type: boolean description: Gerar reposição usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: depositoSkuParametro: description: Depósito SKU parâmetro type: object required: – deposito – geraReposicao – geraNecessidadeAutomatica – situacao properties: id: type: string format: uuid description: Identificador único deposito: type: object allOf: – #/definitions/deposito description: Depósito familia: type: object allOf: – #/definitions/familia description: Família sku: type: object allOf: – #/definitions/sku description: Produto prazoRessuprimento: type: integer format: int64 description: Prazo ressuprimento estoqueMinimo: type: number format: double description: Estoque mínimo estoqueMaximo: type: number format: double description: Estoque máximo estoqueSeguranca: type: number format: double description: Estoque segurança geraReposicao: type: boolean description: Gerar reposição geraNecessidadeAutomatica: type: string maxLength: 1 description: Gerar necessidade automática situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: consumoDiario: description: Cálculo de consumo diário para cada produto conforme transação type: object required: – data – empresa – filial – deposito – sku – transacao – quantidade properties: id: type: string format: uuid description: Identificador único data: type: string format: date description: Data do consumo empresa: type: object allOf: – #/definitions/pessoa description: Empresa do consumo filial: type: object allOf: – #/definitions/pessoa description: Filial do consumo deposito: type: object allOf: – #/definitions/deposito description: Depósito onde foi consumido sku: type: object allOf: – #/definitions/sku description: Produto consumido transacao: type: object allOf: – #/definitions/transacao description: Transação realizada quantidade: type: number format: double description: Quantidade consumida minimum: -999999999.99999 maximum: 999999999.99999 usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sazonalidade: description: Sazonalidade type: object required: – empresa – nome properties: id: type: string format: uuid description: Identificador único empresa: type: object allOf: – #/definitions/pessoa description: Empresa nome: type: string description: Nome periodos: type: array items: type: object allOf: – #/definitions/sazonalidadePeriodo description: Períodos usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sazonalidadePeriodo: description: Período da sazonalidade type: object required: – inicio – fim properties: id: type: string format: uuid description: Identificador único sazonalidade: type: object allOf: – #/definitions/sazonalidade description: Sazonalidade inicio: type: string format: date description: Período inicial fim: type: string format: date description: Período final usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: 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