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

tax

2 views 0 06/11/2025 Atualizado em 18/11/2025 integrador

2.0info: 1.2.0 tax description: Taxas x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: tax 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/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tax/queries/listProductTaxWithParameters: post: description: Query para listar taxas de produtos com parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/filterProductTax description: Filtros size: type: integer format: int64 description: Paginação default: 0 offset: type: integer format: int64 description: Quantidade por página default: 10 orderBy: type: string description: Ordenação default: lastModifiedDate asc responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/productTaxDetails minimum: 1 description: Listagem das taxas de produtos totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/listHistoricTaxCalculation: post: description: Lista os dados de um cálculo agrupados por taxa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – application – applicationCode properties: application: type: string allOf: – #/definitions/typeApplication description: Enum da aplicação applicationCode: type: integer format: int64 description: Código único aplicação origem size: type: integer format: int64 description: Paginação default: 0 offset: type: integer format: int64 description: Quantidade por página default: 10 orderBy: type: string description: Ordenação default: tax.name asc responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculation minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os dados de um cálculo agrupados por taxa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: application description: Enum da aplicação in: query required: true type: string allOf: – #/definitions/typeApplication – name: applicationCode description: Código único aplicação origem in: query required: true type: integer format: int64 – name: size description: Paginação in: query type: integer format: int64 – name: offset description: Quantidade por página in: query type: integer format: int64 – name: orderBy description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculation minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/taxHistoricByProduct: post: description: Lista os dados de um cálculo agrupados por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – application – applicationCode – applicationCodeItem properties: application: type: string allOf: – #/definitions/typeApplication description: Enum da aplicação applicationCode: type: integer format: int64 description: Código único aplicação origem applicationCodeItem: type: integer format: int64 description: Código único do item da aplicação origem size: type: integer format: int64 description: Paginação default: 0 offset: type: integer format: int64 description: Quantidade por página default: 10 orderBy: type: string description: Ordenação default: applicationCodeItem asc responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculationByProduct minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os dados de um cálculo agrupados por produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: application description: Enum da aplicação in: query required: true type: string allOf: – #/definitions/typeApplication – name: applicationCode description: Código único aplicação origem in: query required: true type: integer format: int64 – name: applicationCodeItem description: Código único do item da aplicação origem in: query required: true type: integer format: int64 – name: size description: Paginação in: query type: integer format: int64 – name: offset description: Quantidade por página in: query type: integer format: int64 – name: orderBy description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculationByProduct minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/taxHistoricByTax: post: description: Listar os dados de um cálculo agrupados por taxa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – application – applicationCode – taxId properties: application: type: string allOf: – #/definitions/typeApplication description: Enum da aplicação applicationCode: type: integer format: int64 description: Código único aplicação origem taxId: type: string description: Código da taxa size: type: integer format: int64 description: Paginação default: 0 offset: type: integer format: int64 description: Quantidade por página default: 10 orderBy: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculation minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar os dados de um cálculo agrupados por taxa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: application description: Enum da aplicação in: query required: true type: string allOf: – #/definitions/typeApplication – name: applicationCode description: Código único aplicação origem in: query required: true type: integer format: int64 – name: taxId description: Código da taxa in: query required: true type: string – name: size description: Paginação in: query type: integer format: int64 – name: offset description: Quantidade por página in: query type: integer format: int64 – name: orderBy description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/groupTaxCalculation minimum: 1 description: Agrupador de cálculo totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/listTaxPerProduct: post: description: Query para listar taxas de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/filterProductTax description: Filtros size: type: integer format: int64 description: Paginação default: 0 offset: type: integer format: int64 description: Quantidade por página default: 10 orderBy: type: string description: Ordenação default: lastModifiedDate asc responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/productTaxDetails minimum: 1 description: Listagem das taxas de produtos totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços 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 /tax/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 /tax/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportE012fam: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportE075der: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportProducerGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportApprovalSettings: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportApprovalSettingsGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportTax: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportProductTax: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportParamProductTax: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportTaxCalculation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportTaxCalculationChargesFix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportTaxCalculationDetails: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportChangeTaxValueRequest: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/exportE080ser: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/rateCalculator: post: description: Action para cálculo de taxas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – application – applicationCode – charges properties: application: type: string allOf: – #/definitions/typeApplication description: Aplicação Origem applicationCode: type: integer format: int64 description: Código único aplicação origem charges: type: array items: type: object allOf: – #/definitions/chargesToBeFixed minimum: 1 description: Cargas a fixar responses: 200: description: Ok schema: type: object required: – status – individualTaxes properties: totalFinancialTaxValue: type: string description: Total da taxa em reais totalProductTaxValue: type: string description: Quantidade de taxa em quilos totalServiceTaxValue: type: string description: Quantidade de taxa em serviço totalFinancialTitleValue: type: string description: Valor total de taxas que geram titulos financeiros availableProductQuantity: type: number format: double description: Quantidade de quilos disponiveis para fixação status: type: string allOf: – #/definitions/statusCalculation description: Status geral do cálculo individualTaxes: type: array items: type: object allOf: – #/definitions/individualTaxDetails minimum: 1 description: Taxas individuais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/requestChangeTaxValue: post: description: Action para solicitação de alteração do valor da taxa ao BPM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – newValueTax – reason – dataToChange properties: newValueTax: type: number format: double description: Novo valor da taxa reason: type: string description: Motivo da alteração dataToChange: type: object allOf: – #/definitions/requestChangeTaxValueReceived description: Dados para alteração do valor da taxa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/updateParamProductTaxPreference: post: description: Action para alterar a prioridade de um parâmetro de taxa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idProductTax – idParamProductTax – currentPreference – newPreference properties: idProductTax: type: string description: UUID do Produto pai do parâmetro que será alterado idParamProductTax: type: string description: UUID do parâmetro que solicitou a troca de preferência currentPreference: type: integer format: int64 description: Valor atual da prioridade newPreference: type: integer format: int64 description: Novo valor para atualizar a prioridade responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/finishFixation: post: description: Endpoint acionado na finalização de uma fixação, responsável por alterar o status das cargas para fixadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fixationCode properties: fixationCode: type: integer format: int64 description: Código da fixação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/cancelFixation: post: description: Endpoint cancela a fixação, excluindo o historico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fixationCode properties: fixationCode: type: integer format: int64 description: Código da fixação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE012fam: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE075der: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importProducerGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importApprovalSettings: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importApprovalSettingsGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importTax: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importProductTax: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importParamProductTax: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importTaxCalculation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importTaxCalculationChargesFix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importTaxCalculationDetails: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importChangeTaxValueRequest: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/actions/importE080ser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/events/publishChangeTaxValueEvent: post: description: Evento que publica a alteração da taxa para o serviço de Fixação x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – status properties: status: type: string allOf: – #/definitions/statusChangeRequest description: Status da solicitação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE012famEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE012famEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE075derEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE075derEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importProducerGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportProducerGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importApprovalSettingsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportApprovalSettingsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importApprovalSettingsGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportApprovalSettingsGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importProductTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportProductTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importParamProductTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportParamProductTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importTaxCalculationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportTaxCalculationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importTaxCalculationChargesFixEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportTaxCalculationChargesFixEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importTaxCalculationDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportTaxCalculationDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importChangeTaxValueRequestEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportChangeTaxValueRequestEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/importE080serEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/events/exportE080serEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tax/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e012fam: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e075der: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e001pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/producerGroup: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/producerGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/approvalSettings: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/approvalSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/approvalSettingsGroup: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/approvalSettingsGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/tax: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tax responses: 200: description: The created resource schema: #/definitions/tax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tax responses: 200: description: The created resource schema: #/definitions/tax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/tax/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTax responses: 200: description: Ok schema: #/definitions/editTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tax responses: 200: description: Ok schema: #/definitions/tax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/tax/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/productTax: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/productTax responses: 200: description: The created resource schema: #/definitions/productTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/productTax responses: 200: description: The created resource schema: #/definitions/productTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/productTax/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editProductTax responses: 200: description: Ok schema: #/definitions/editProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/productTax responses: 200: description: Ok schema: #/definitions/productTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/productTax/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/productTax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/paramProductTax: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paramProductTax responses: 200: description: The created resource schema: #/definitions/paramProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paramProductTax responses: 200: description: The created resource schema: #/definitions/paramProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/paramProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/paramProductTax/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editParamProductTax responses: 200: description: Ok schema: #/definitions/editParamProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paramProductTax responses: 200: description: Ok schema: #/definitions/paramProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paramProductTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/paramProductTax/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paramProductTax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/taxCalculation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/taxCalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/taxCalculationChargesFix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/taxCalculationChargesFix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/taxCalculationDetails: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/taxCalculationDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/changeTaxValueRequest: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/changeTaxValueRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e080ser: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tax/entities/e080ser/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down statusEntity: type: string enum: – VA – VI description: Status da Entidade: * `VA` – Ativo * `VI` – Inativo typeMandatory: type: string enum: – REQUIRED – OPTIONAL description: Obrigatoriedade: * `REQUIRED` – Obrigatório * `OPTIONAL` – Opcional typeApplication: type: string enum: – FIXATION – TRANSFER description: Aplicação: * `FIXATION` – Fixação * `TRANSFER` – Transferência typeCharge: type: string enum: – PRODUCT – FINANCIAL – SERVICE – FINANCIAL_TITLE description: Tipo de Cobrança: * `PRODUCT` – Em Produto * `FINANCIAL` – Retenção financeira * `SERVICE` – Serviço * `FINANCIAL_TITLE` – Título financeiro typeCalculation: type: string enum: – PERCENTAGE – VALUE – VALUE_PER_WEIGHT description: Tipo de Cálculo: * `PERCENTAGE` – Porcentagem * `VALUE` – Valor * `VALUE_PER_WEIGHT` – Valor por Peso typeWeight: type: string enum: – NET – GROSS description: Tipo de Peso: * `NET` – Líquido * `GROSS` – Bruto typeSingleCharge: type: string enum: – YES – NO description: Cobrança Única: * `YES` – Sim * `NO` – Não typeGracePeriod: type: string enum: – DAYS – DATE – NO_GRACE_PERIOD description: Tipo de Carência: * `DAYS` – Dias * `DATE` – Data * `NO_GRACE_PERIOD` – Sem Carência typePeriodicity: type: string enum: – NO_RECURRENCE – DAILY – WEEKLY – MONTHLY – YEARLY description: Tipo de Periodicidade: * `NO_RECURRENCE` – Sem Recorrência * `DAILY` – Diário * `WEEKLY` – Semanal * `MONTHLY` – Mensal * `YEARLY` – Anual statusChangeRequest: type: string enum: – APPROVED – REJECTED – IN_PROGRESS – CANCELED description: Status da Solicitação da Alteração: * `APPROVED` – Aprovado * `REJECTED` – Reprovado * `IN_PROGRESS` – Em andamento * `CANCELED` – Cancelado statusCalculation: type: string enum: – SUCCESS – ERROR – EMPTY description: Status do Cálculo: * `SUCCESS` – Sucesso * `ERROR` – Erro * `EMPTY` – Vazio – nao foi encontrado taxas para calcular approvalOrigin: type: string enum: – APPROVAL_WEIGHING – APPROVAL_TAX description: Origem da Aprovação – Solicitação: * `APPROVAL_WEIGHING` – Aprovação Alteração da Pesagem * `APPROVAL_TAX` – Aprovação Alteração Valor da Taxa statusHistory: type: string enum: – CALCULATED – RECALCULATED – FINISHED description: Status do historico de calculo de taxas: * `CALCULATED` – Calculado * `RECALCULATED` – Recalculado * `FINISHED` – Finalizado userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error groupTaxCalculation: description: Agrupador de cálculo type: object required: – identifier – code – name – product – applicationCode – application – totalFinancialTaxValue – totalProductTaxValue properties: identifier: type: string description: Identificador da taxa code: type: integer format: int64 description: Código da taxa name: type: string description: Nome da taxa product: type: string description: Nome do Produto applicationCode: type: integer format: int64 description: Código único da aplicação application: type: string allOf: – #/definitions/typeApplication description: Origem da aplicação totalFinancialTaxValue: type: number format: double description: Total da taxa em reais totalProductTaxValue: type: number format: double description: Quantidade de taxa em quilos groupTaxCalculationByProduct: description: Agrupador de cálculo por produto type: object required: – identifier – code – name – applicationCode – application – applicationItemCode – totalFinancialTaxValue – totalProductTaxValue properties: identifier: type: string description: Identificador do produto code: type: string description: Código do produto name: type: string description: Nome do produto applicationCode: type: integer format: int64 description: Código único da aplicação application: type: string allOf: – #/definitions/typeApplication description: Origem da aplicação applicationItemCode: type: integer format: int64 description: Código único do item na aplicação totalFinancialTaxValue: type: number format: double description: Total da taxa em reais totalProductTaxValue: type: number format: double description: Quantidade de taxa em quilos chargesToBeFixed: description: Cargas a serem fixadas type: object required: – applicationItemCode – effectiveId – effectiveDate – producerId – productId – grossWeight – netWeight – quantityToBeFixed – availableQuantity – unitValue properties: applicationItemCode: type: integer format: int64 description: Código do item de aplicação effectiveId: type: string description: Identificador de carga/saldo effectiveDate: type: string format: date description: Data de entrada da carga/saldo producerId: type: string description: ID do Produtor productId: type: string description: Id do Produto grossWeight: type: number format: double description: Peso bruto netWeight: type: number format: double description: Peso líquido quantityToBeFixed: type: number format: double description: Saldo disponível a fixar availableQuantity: type: number format: double description: Quantidade disponivel unitValue: type: number format: double description: Valor moeda unitário financialIncrease: type: number format: double description: Valor total de acrescimos financeiros default: 0.0 qtdRemainingParameters: type: integer format: int64 description: Quantidade de parametros de taxas restantes a serem calculadas default: 0 qtdRemainingTaxes: type: integer format: int64 description: Quantidade de taxas restantes a serem calculadas default: 0 originalQuantityToBeFixed: type: number format: double description: Valor original da quantidade a ser fixada utilizado para persistir no banco default: 0.0 ratesToBeCalculated: type: array items: type: string allOf: – #/definitions/typeCharge description: Taxas a serem calculadas para a carga – caso estiver vazio, calcula tudo individualTaxDetails: description: Taxas individuais type: object required: – taxId – taxCode – taxName – taxCalculationDetailsId – taxMandatory – taxParameters – statusDetails properties: taxId: type: string description: ID da Taxa taxCode: type: integer format: int64 description: Código da Taxa taxName: type: string description: Nome da taxa taxCalculationDetailsId: type: string description: Id dos detalhes do cálculo taxMandatory: type: string allOf: – #/definitions/typeMandatory description: Taxa obrigatória taxParameters: type: object allOf: – #/definitions/taxParameters description: Parametros statusDetails: type: object allOf: – #/definitions/statusDetails description: Status individual do calculo da taxa taxParameters: description: Parametros de Taxas type: object required: – paramTaxId – chargeType – itemCode properties: paramTaxId: type: string description: ID do parâmetro da taxa chargeType: type: string allOf: – #/definitions/typeCharge description: Tipo de cobrança itemCode: type: integer format: int64 description: Código do item valueFinancialTax: type: number format: double description: Valor taxa em reais valueProductTax: type: number format: double description: Valor taxa em quilos serviceId: type: string description: Id do serviço transactionId: type: string description: Id da transação titleType: type: string description: Típo de título financeiro financialGroup: type: string description: Grupo de cobrança financeira statusDetails: description: Detalhes do status type: object required: – type – message properties: type: type: string allOf: – #/definitions/statusCalculation description: Tipo do Status message: type: string description: Mensagem do Status productTaxDetails: description: DTO para listagem de taxas de produtos com parâmetros type: object required: – id – e070empId – e070emp – e012famId – e012fam – e075derId – e075der – taxId – tax – mandatory – status – parameters – lastModifiedDate – taxCode – productCode properties: id: type: string description: Id e070empId: type: string description: Id da empresa e070emp: type: string description: Nome da empresa e012famId: type: string description: Id da família e012fam: type: string description: Nome da Família e075derId: type: string description: Id do Produto e075der: type: string description: Nome do Produto taxId: type: string description: Id da Taxa tax: type: string description: Nome da Taxa mandatory: type: string allOf: – #/definitions/typeMandatory description: Obrigatoriedade status: type: string allOf: – #/definitions/statusEntity description: Status parameters: type: integer format: int64 description: Quantidade de parâmetros lastModifiedDate: type: string format: date-time description: Data de Criação taxCode: type: string description: Código da taxa productCode: type: string description: Código do produto filterProductTax: description: Filtros para listagem de taxas de produtos type: object required: – e070emp – e012fam – e075der – tax properties: e070emp: type: string description: Código da empresa e012fam: type: string description: Código da família e075der: type: string description: Código do Produto tax: type: string description: Código da Taxa requestChangeTaxValueReceived: description: Objeto para requisição de alteração do valor da taxa type: object required: – calculationId – application – applicationCode – applicationCodeItem – description – grossWeight – netWeight – availableQuantity – unitValue – originalTaxValue – originalTaxResult properties: calculationId: type: string description: Identificador do cálculo application: type: string allOf: – #/definitions/typeApplication description: Aplicação Origem applicationCode: type: string description: Código único aplicação origem applicationCodeItem: type: integer format: int64 description: Código do Item da Aplicação de Origem description: type: string description: Descrição da taxa grossWeight: type: number format: double description: Peso bruto netWeight: type: number format: double description: Peso líquido availableQuantity: type: number format: double description: Quantidade disponível unitValue: type: number format: double description: Valor unitário originalTaxValue: type: number format: double description: Valor da taxa original originalTaxResult: type: number format: double description: Resultado da taxa original businessDataDTO: description: Objeto para envio de solicitação de alteração da taxa no BPM type: object required: – identificador_do_calculo – aplicacao_origem – codigo_unico_aplicacao_origem – codigo_do_item_da_aplicacao_origem – descricao_da_taxa – peso_bruto – peso_liquido – quantidade_disponivel – valor_unitario – valor_taxa_original – resultado_da_taxa_original – valor_da_taxa – motivo_da_alteracao properties: identificador_do_calculo: type: string description: Identificador do cálculo aplicacao_origem: type: string description: Aplicação Origem codigo_unico_aplicacao_origem: type: string description: Código único da aplicação de origem codigo_do_item_da_aplicacao_origem: type: integer format: int64 description: Código do item da aplicação origem descricao_da_taxa: type: string description: Descrição da taxa peso_bruto: type: number format: double description: Peso bruto peso_liquido: type: number format: double description: Peso líquido quantidade_disponivel: type: number format: double description: Quantidade disponível valor_unitario: type: number format: double description: Valor unitário valor_taxa_original: type: number format: double description: Valor da taxa original resultado_da_taxa_original: type: number format: double description: Resultado da taxa original valor_da_taxa: type: number format: double description: Novo valor da taxa motivo_da_alteracao: type: string description: Motivo da alteração calculateTaxResultDTO: description: Objeto pra trazer o resultado da taxa type: object properties: resultCalc: type: number format: double description: Resultado do cálculo default: 0.0 formula: type: string description: Fórmula default: startProcessInput: description: Record para envio de dados para iniciar um processo type: object properties: processId: type: integer format: int64 description: Número do processo requester: type: string description: Usuário solicitante type: string description: Título opcional da solicitação businessData: type: string description: Variáveis de Negócio do Processo flowExecutionData: type: object allOf: – #/definitions/flowExecutionData description: Informação para Fluxo de Execução do Processo startProcessOutput: description: Record de retorno da execução do processo type: object properties: processInstanceID: type: integer format: int64 description: Instância de Processo criada flowExecutionData: description: Dados para a execução do fluxo type: object properties: actionToExecute: type: string description: Nome da ação a ser tomada dentro do fluxo getUserInput: description: Record referente ao envio dos dados na integração com o serviço plataform/user/getUser type: object properties: username: type: string description: Username completeUser: description: Record referente ao retorno da integração com o serviço plataform/user/getUser type: object required: – fullName properties: fullName: type: string description: Nome do usuário checkAccessInput: description: Record referente ao envio dos dados na integração com o serviço plataform/user/checkAccess type: object properties: permissions: type: array items: type: object allOf: – #/definitions/permissionToCheck description: As permissões à serem verificadas permissionToCheck: description: Conjunto de recurso, ação e atributos para validação da permissão type: object properties: resource: type: string description: URI do recurso action: type: string description: Ação do recurso checkAccessOutput: description: Record referente ao retorno da integração com o serviço plataform/user/checkAccess type: object required: – authorized properties: authorized: type: boolean description: Verdadeiro se o usuário possuir permissão em todos os recursos informados 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 e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia / Sigla da empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFil: type: integer format: int64 description: Código da filial nomFil: type: string maxLength: 100 description: Nome da filial sigFil: type: string maxLength: 100 description: Nome fantasia da filial numCgc: type: string maxLength: 18 description: CNPJ cidFil: type: string maxLength: 60 description: Cidade numFon: type: string maxLength: 20 description: Numero Telefone extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e012fam: description: Família type: object required: – e070emp – codFam – desFam – sitFam properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFam: type: string maxLength: 6 description: Código desFam: type: string maxLength: 50 description: Descrição sitFam: type: string allOf: – #/definitions/statusEntity description: Status extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e075der: description: Produto type: object required: – e070emp – e012fam – codDer – desDer – sitDer properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa e012fam: type: object allOf: – #/definitions/e012fam description: Código da família codDer: type: string maxLength: 23 description: Código da derivação desDer: type: string maxLength: 120 description: Descrição da derivação sitDer: type: string allOf: – #/definitions/statusEntity description: Situação da derivação extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – nomPes – sitPes properties: id: type: string format: uuid description: Id Pessoa nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 14 description: CNPJ/CPF sitPes: type: string allOf: – #/definitions/statusEntity description: Status extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: producerGroup: description: Grupo type: object required: – name – status properties: id: type: string format: uuid description: Id do Grupo code: type: integer format: int64 description: code name: type: string description: name status: type: string allOf: – #/definitions/statusEntity description: status producers: type: array items: type: object allOf: – #/definitions/e001pes description: Lista de Produtores producersQuantity: type: integer format: int64 description: Quantidade de Produtores extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: approvalSettings: description: Configuração da aprovação e templates por grupo de usuário da plataforma e por empresa/filial type: object required: – company – branches – approvalOrigin – processConfig – groups properties: id: type: string format: uuid description: Id company: type: object allOf: – #/definitions/e070emp description: Empresa branches: type: array items: type: object allOf: – #/definitions/e070fil minimum: 1 description: Filiais approvalOrigin: type: string allOf: – #/definitions/approvalOrigin description: Origem da Aprovação processConfig: type: integer format: int64 description: Template BPM da plataforma groups: type: array items: type: object allOf: – #/definitions/approvalSettingsGroup minimum: 1 description: Approval Settings Groups extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: approvalSettingsGroup: description: Itens de Grupo de usuário da plataforma relacionados a uma configuração de aprovação type: object required: – groupId properties: id: type: string format: uuid description: Id approvalSettings: type: object allOf: – #/definitions/approvalSettings description: Setting groupId: type: string maxLength: 40 description: Grupo de Usuários da plataforma extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tax: description: Taxas type: object required: – e070emp – code – name – status properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa code: type: integer format: int64 description: Code name: type: string description: Name status: type: string allOf: – #/definitions/statusEntity description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTax: type: object required: – id allOf: – #/definitions/tax productTax: description: Taxas de Produtos type: object required: – e070emp – e012fam – e075der – tax – mandatory – status properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa e012fam: type: object allOf: – #/definitions/e012fam description: Família e075der: type: object allOf: – #/definitions/e075der description: Código do Produto tax: type: object allOf: – #/definitions/tax description: Código da Taxa mandatory: type: string allOf: – #/definitions/typeMandatory description: Obrigatoriedade status: type: string allOf: – #/definitions/statusEntity description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProductTax: type: object required: – id allOf: – #/definitions/productTax paramProductTax: description: Parâmetros da Taxa type: object required: – productTax – application – chargeType – calculationType – chargeValue – weightType – singleCharge – gracePeriodType – periodicityType – status properties: id: type: string format: uuid description: Id productTax: type: object allOf: – #/definitions/productTax description: Taxa de Produto producerGroup: type: array items: type: object allOf: – #/definitions/producerGroup description: Grupo de Produtores preference: type: integer format: int64 description: Prioridade application: type: string allOf: – #/definitions/typeApplication description: Aplicação chargeType: type: string allOf: – #/definitions/typeCharge description: Tipo de Cobrança calculationType: type: string allOf: – #/definitions/typeCalculation description: Tipo de Cálculo chargeValue: type: number format: double description: Valor da Cobrança weightType: type: string allOf: – #/definitions/typeWeight description: Tipo de Peso singleCharge: type: string allOf: – #/definitions/typeSingleCharge description: Cobrança Única gracePeriodType: type: string allOf: – #/definitions/typeGracePeriod description: Tipo de Carência graceDayValue: type: integer format: int64 description: Dias da Carência graceDateValue: type: string format: date description: Data da Carência periodicityType: type: string allOf: – #/definitions/typePeriodicity description: Tipo de Periodicidade recurrenceInterval: type: integer format: int64 description: Intervalo de Recorrência daysWeek: type: string description: Dias da semana para recorrência dateRecurrence: type: string format: date description: Data da Recorrência startDate: type: string format: date description: Data de Início endDate: type: string format: date description: Data de Fim e080ser: type: object allOf: – #/definitions/e080ser description: Serviço status: type: string allOf: – #/definitions/statusEntity description: Status e001tns: type: string description: Transação escolhida para típo de cobrança Título Financeiro e002tpt: type: string description: Típo de título financeiro e023crp: type: string description: Grupo de cobrança financeira createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editParamProductTax: type: object required: – id allOf: – #/definitions/paramProductTax taxCalculation: description: Cálculo de Taxa type: object required: – calculationDate – application – applicationCode properties: id: type: string format: uuid description: Id calculationDate: type: string format: date description: Data do Cálculo application: type: string allOf: – #/definitions/typeApplication description: Tipo da Aplicação de Origem applicationCode: type: integer format: int64 description: Código da Aplicação de Origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: taxCalculationChargesFix: description: Cálculo de Taxa – Cargas a Fixar type: object required: – applicationCodeItem – taxCalculation – producer – effectiveId – effectiveDate – e075der – grossQuantity – netQuantity – unitPrice – quantityFix – chargeMade properties: id: type: string format: uuid description: Id applicationCodeItem: type: integer format: int64 description: Código do Item da Aplicação de Origem taxCalculation: type: object allOf: – #/definitions/taxCalculation description: Cálculo de Taxa producer: type: object allOf: – #/definitions/e001pes description: Produtor effectiveId: type: string description: Identificação do Saldo effectiveDate: type: string format: date description: Data de Entrada e075der: type: object allOf: – #/definitions/e075der description: Produto grossQuantity: type: number format: double description: Quantidade Bruta netQuantity: type: number format: double description: Quantidade Líquida unitPrice: type: number format: double description: Preço Unitário quantityFix: type: number format: double description: Quantidade a Fixar quantityTaxProduct: type: number format: double description: Quantidade de Taxa em Produto valueTax: type: number format: double description: Valor Taxa Financeira availableQuantity: type: number format: double description: Quantidade Disponível chargeMade: type: boolean description: Cobrança Efetivada financialIncrease: type: number format: double description: Valor do acrescimo financeiro default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: taxCalculationDetails: description: Cálculo de Taxa – Detalhes type: object required: – taxCalculationChargesFix – tax – paramProductTax – taxItemCode properties: id: type: string format: uuid description: Id taxCalculationChargesFix: type: object allOf: – #/definitions/taxCalculationChargesFix description: Carga a Fixar tax: type: object allOf: – #/definitions/tax description: Taxa paramProductTax: type: object allOf: – #/definitions/paramProductTax description: Parâmetros da Taxa taxItemCode: type: integer format: int64 description: Código do Item da Taxa calculationType: type: string allOf: – #/definitions/typeCalculation description: Tipo de Cálculo chargeType: type: string allOf: – #/definitions/typeCharge description: Tipo de Cobrança weightType: type: string allOf: – #/definitions/typeWeight description: Tipo de Peso singleCharge: type: string allOf: – #/definitions/typeSingleCharge description: Cobrança Única mandatory: type: string allOf: – #/definitions/typeMandatory description: Obrigatoriedade startDate: type: string format: date description: Vigência Inicial endDate: type: string format: date description: Vigência Final periodicityType: type: string allOf: – #/definitions/typePeriodicity description: Tipo de Periodicidade recurrenceInterval: type: integer format: int64 description: Intervalo de Recorrência dateRecurrence: type: string format: date description: Data da Recorrência daysWeek: type: string description: Dias da Semana gracePeriodType: type: string allOf: – #/definitions/typeGracePeriod description: Tipo de Carência graceDayValue: type: integer format: int64 description: Dias da Carência graceDateValue: type: string format: date description: Data da Carência chargeValue: type: number format: double description: Valor da Taxa valueTax: type: number format: double description: Valor Taxa Financeira formula: type: string description: Fórmula quantityFix: type: number format: double description: Quantidate a fixar usada no calculo status: type: string allOf: – #/definitions/statusHistory description: Status do calculo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: changeTaxValueRequest: description: Solicitação de Alteração de Valor da Taxa type: object required: – taxCalculationDetails – status – payloadContent properties: id: type: string format: uuid description: Id taxCalculationDetails: type: object allOf: – #/definitions/taxCalculationDetails description: Detalhes do cálculo de Taxa processId: type: integer format: int64 description: Id do processo BPM processInstanceId: type: integer format: int64 description: Id da instancia do processo BPM status: type: string allOf: – #/definitions/statusChangeRequest description: Status payloadContent: type: string description: Payload recebido na solicitação de alteração payloadBpmRequest: type: string description: Payload BPM da solicitação de alteração payloadBpmResponse: type: string description: Payload BPM da resposta da solicitação de alteração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e080ser: description: Serviço type: object required: – e070emp – e012fam – codSer – desSer – sitSer properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial e012fam: type: object allOf: – #/definitions/e012fam description: Família codSer: type: string maxLength: 14 description: Serviço desSer: type: string maxLength: 70 description: Descrição cplSer: type: string maxLength: 250 description: Complemento qtdPad: type: number format: double description: Quantidade padrão minimum: 0.00 maximum: 999999999.99999 obsSer: type: string maxLength: 999 description: Observação do serviço preCpr: type: string description: Preço unitário do serviço para compras minimum: 0.00 sitSer: type: string allOf: – #/definitions/statusEntity description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

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