2.0info: develop tax_taxa description: Serviço de Taxas x-senior-domain: ERP Agronegócio Senior X x-senior-domain-path: erp_agr x-senior-service-path: tax_taxa contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_agrsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tax_taxa/queries/obterTaxaItens: post: description: Obter dados de uma taxa com seus itens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taxaId properties: taxaId: type: string description: Id da taxa responses: 200: description: Ok schema: type: object required: – empresaId – filialId – skuId – itens properties: empresaId: type: integer format: int64 description: Id da empresa filialId: type: integer format: int64 description: Id da filial skuId: type: integer format: int64 description: Id do SKU itens: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens da taxa default: description: Error response schema: #/definitions/genericError get: description: Obter dados de uma taxa com seus itens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: taxaId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – empresaId – filialId – skuId – itens properties: empresaId: type: integer format: int64 description: Id da empresa filialId: type: integer format: int64 description: Id da filial skuId: type: integer format: int64 description: Id do SKU itens: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens da taxa default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/listarTaxaItens: post: description: Busca taxaItens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialId – skuId properties: empresaId: type: integer format: int64 description: Id da empresa filialId: type: integer format: int64 description: Id da filial skuId: type: integer format: int64 description: Id do SKU responses: 200: description: Ok schema: type: object required: – taxaId – itens properties: taxaId: type: string description: Id da taxa itens: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens encontrados default: description: Error response schema: #/definitions/genericError get: description: Busca taxaItens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId in: query required: true type: integer format: int64 – name: filialId in: query required: true type: integer format: int64 – name: skuId in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – taxaId – itens properties: taxaId: type: string description: Id da taxa itens: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens encontrados default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/listarTaxaItemTipos: post: description: Busca taxaItemTipo por nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do item da taxa responses: 200: description: Ok schema: type: object required: – taxaItemTipos properties: taxaItemTipos: type: array items: type: object allOf: – #/definitions/taxaItemTipo minimum: 1 description: Resultados encontrados default: description: Error response schema: #/definitions/genericError get: description: Busca taxaItemTipo por nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nome in: query required: true type: string responses: 200: description: Ok schema: type: object required: – taxaItemTipos properties: taxaItemTipos: type: array items: type: object allOf: – #/definitions/taxaItemTipo minimum: 1 description: Resultados encontrados default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/listarTaxaItemParametros: post: description: Lista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taxaItemId properties: taxaItemId: type: string description: Id do item da taxa responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recTaxaItemParametro minimum: 1 description: Parâmetros do item da taxa default: description: Error response schema: #/definitions/genericError get: description: Lista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: taxaItemId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recTaxaItemParametro minimum: 1 description: Parâmetros do item da taxa default: description: Error response schema: #/definitions/genericError /tax_taxa/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/exportTaxa: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/exportTaxaItemTipo: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/exportTaxaItem: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /tax_taxa/queries/exportTaxaItemParametro: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /tax_taxa/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 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 default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/criarTaxa: post: description: Cria taxas com itens tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialIds – skuId properties: empresaId: type: integer format: int64 description: Id da empresa filialIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das filiais skuId: type: integer format: int64 description: Id do SKU itens: type: array items: type: string description: Ids dos itens das taxas responses: 200: description: Ok schema: type: object required: – itensCriados properties: itensCriados: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens criados default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/editarTaxaItens: post: description: Obter dados de uma taxa com seus itens tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taxaId – itens properties: taxaId: type: string description: Id da taxa itens: type: object allOf: – #/definitions/recTaxaItensAlteracao description: Itens da taxa responses: 200: description: Ok schema: type: object required: – itensAtualizados properties: itensAtualizados: type: array items: type: object allOf: – #/definitions/recTaxaItem minimum: 1 description: Itens da taxa atualizados default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/ativarTaxaItem: post: description: Ativar item da taxa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taxaItemId properties: taxaItemId: type: string description: Id do item da taxa responses: 200: description: Ok schema: type: object required: – item properties: item: type: object allOf: – #/definitions/recTaxaItem description: Item da taxa atualizado default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/inativarTaxaItem: post: description: Desativar item da taxa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taxaItemId properties: taxaItemId: type: string description: Id do item da taxa responses: 200: description: Ok schema: type: object required: – item properties: item: type: object allOf: – #/definitions/recTaxaItem description: Item da taxa atualizado default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/importTaxa: 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: default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/importTaxaItemTipo: 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: default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/importTaxaItem: 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: default: description: Error response schema: #/definitions/genericError /tax_taxa/actions/importTaxaItemParametro: 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: default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxa: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxa responses: 200: description: The created resource schema: #/definitions/taxa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxa responses: 200: description: The created resource schema: #/definitions/taxa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/taxa default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxa/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxa responses: 200: description: Ok schema: #/definitions/taxa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxa responses: 200: description: Ok schema: #/definitions/taxa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/taxa default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxa/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/taxa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemTipo: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItemTipo responses: 200: description: The created resource schema: #/definitions/taxaItemTipo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItemTipo responses: 200: description: The created resource schema: #/definitions/taxaItemTipo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/taxaItemTipo default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemTipo/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItemTipo responses: 200: description: Ok schema: #/definitions/taxaItemTipo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItemTipo responses: 200: description: Ok schema: #/definitions/taxaItemTipo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/taxaItemTipo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemTipo/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/taxaItemTipo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItem responses: 200: description: The created resource schema: #/definitions/taxaItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItem responses: 200: description: The created resource schema: #/definitions/taxaItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/taxaItem default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItem/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItem responses: 200: description: Ok schema: #/definitions/taxaItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItem responses: 200: description: Ok schema: #/definitions/taxaItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/taxaItem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/taxaItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemParametro: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItemParametro responses: 200: description: The created resource schema: #/definitions/taxaItemParametro default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/taxaItemParametro responses: 200: description: The created resource schema: #/definitions/taxaItemParametro default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/taxaItemParametro default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemParametro/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItemParametro responses: 200: description: Ok schema: #/definitions/taxaItemParametro default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/taxaItemParametro responses: 200: description: Ok schema: #/definitions/taxaItemParametro default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/taxaItemParametro default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tax_taxa/entities/taxaItemParametro/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/taxaItemParametro responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumSituacaoTaxa: description: Situação da taxa type: string enum: – Ativo – Inativo enumAplicacaoTaxa: description: Aplicação Taxa type: string enum: – FixacaoPreco – Devolucao – Ambos – Recebimento – ContratoCompra enumTipoCobranca: description: Tipo de cobrança de taxas type: string enum: – Cooperado – NaoCooperado – Ambos enumFormaCobranca: description: Forma de cobranaça das taxas type: string enum: – Valor – ValorPeso – Percentual enumTipoDesconto: description: Tipo de desconto a ser gerado type: string enum: – Titulo – NotaServico – TaxaProduto 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 recTaxaItem: description: Taxa item type: object required: – id – nome – situacao properties: id: type: string description: Id do registro nome: type: string description: Nome do item da taxa situacao: type: string allOf: – #/definitions/enumSituacaoTaxa description: Situação: ATIVO ou INATIVO recTaxaItensAlteracao: description: Alteração de itens de uma taxa type: object properties: adicionar: type: array items: type: string description: Itens a serem adicionados remover: type: array items: type: string description: Itens a serem removidos recTaxaItemParametro: description: Taxa item parametro type: object required: – id – aplicacaoTaxa – tipoDesconto – tipoCobranca – formaCobranca – valorTaxa – situacao properties: id: type: string description: Id do registro aplicacaoTaxa: type: string allOf: – #/definitions/enumAplicacaoTaxa description: Aplicação do processo – onde é aplicado tipoDesconto: type: string allOf: – #/definitions/enumTipoDesconto description: Tipo do desconto aplicado sobre a taxa tipoCobranca: type: string allOf: – #/definitions/enumTipoCobranca description: Tipo de cobrança: Cooperado, NaoCooperado ou Ambos formaCobranca: type: string allOf: – #/definitions/enumFormaCobranca description: Forma de cobrança da taxa: Peso, ValorPeso ou Percentual valorTaxa: type: string description: Valor da taxa ou % situacao: type: string allOf: – #/definitions/enumSituacaoTaxa description: Situação do parâmetro taxa: description: Representa quais produtos possuem taxas cadastradas por empresa e filial type: object required: – empresaId – filialId – skuId properties: id: type: string format: uuid description: Id do registro empresaId: type: integer format: int64 description: Empresa filialId: type: integer format: int64 description: Filial skuId: type: integer format: int64 description: SKU usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: taxaItemTipo: description: Itens das taxas que serão utilizados nas parametrizações type: object required: – nome properties: id: type: string format: uuid description: Id do Registro nome: type: string description: Nome do item usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: taxaItem: description: Ligação de itens de taxas com taxa type: object required: – taxaId – taxaItemTipoId – situacao properties: id: type: string format: uuid description: Id do registro taxaId: type: object allOf: – #/definitions/taxa description: Id da taxa taxaItemTipoId: type: object allOf: – #/definitions/taxaItemTipo description: Id do item situacao: type: string allOf: – #/definitions/enumSituacaoTaxa description: Situação do item da taxa usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: taxaItemParametro: description: Parametros das taxas type: object required: – taxaItemId – aplicacaoTaxa – obrigatorio – tipoCobranca – formaCobranca – valorTaxa – tipoDesconto – situacao properties: id: type: string format: uuid description: Id do Registro taxaItemId: type: object allOf: – #/definitions/taxaItem description: Id da taxa Itens aplicacaoTaxa: type: string allOf: – #/definitions/enumAplicacaoTaxa description: Aplicação do processo – onde é aplicado obrigatorio: type: boolean description: Obrigatoriedade da aplicação da taxa tipoCobranca: type: string allOf: – #/definitions/enumTipoCobranca description: Tipo Cobrança formaCobranca: type: string allOf: – #/definitions/enumFormaCobranca description: Forma de cobrança da taxa: Peso, ValorPeso ou Percentual valorTaxa: type: string description: Taxa valor ou % diasCarencia: type: integer format: int64 description: Quantidade de dias de carencia diasPeriocidade: type: integer format: int64 description: Dias de Periodicidade dataInicialVig: type: string format: date description: Data inicial de vigência dataFinalVig: type: string format: date description: Data final de vigência tipoDesconto: type: string allOf: – #/definitions/enumTipoDesconto description: Tipo de desconto a ser aplicado situacao: type: string allOf: – #/definitions/enumSituacaoTaxa description: situação parametrização 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: 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