2.0info: 1.7.0 calculo_impostos description: Serviço que efetua o cálculo dos impostos x-senior-domain: erpx_cpl x-senior-domain-path: erpx_cpl x-senior-service-path: calculo_impostos contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_cplsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /calculo_impostos/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /calculo_impostos/queries/calculaImpostos: post: description: Efetua o cálculo dos impostos de acordo com os parâmetros informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – emitente – dataEmissao – tipoOperacao – destinatario properties: empresaCodigo: type: integer format: int64 description: Código da empresa – Código de negócio minimum: 0 emitente: type: object allOf: – #/definitions/participante description: Dados para identificação do emitente dataEmissao: type: string format: date-time description: Data de emissão do documento dataEntrada: type: string format: date-time description: Data de Entrada – é a data de inserção do documento, emissão pode ser posterior tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de operação: Entrada ou Saída operacao: type: string description: Código da operação destinatario: type: object allOf: – #/definitions/participante description: Dados para identificação do destinatário produto: type: object allOf: – #/definitions/produto description: Dados do produto servico: type: object allOf: – #/definitions/servico description: Dados do serviço valores: type: object allOf: – #/definitions/valores description: Valores gerais devolucaoItem: type: object allOf: – #/definitions/devolucaoItem description: Informações originais do documento para devolução icms: type: object allOf: – #/definitions/icms description: ICMS iss: type: object allOf: – #/definitions/iss description: ISS ipi: type: object allOf: – #/definitions/ipi description: IPI pis: type: object allOf: – #/definitions/pisCofinsNormalImportacao description: PIS pisImportacao: type: object allOf: – #/definitions/pisCofinsNormalImportacao description: PIS Importação cofins: type: object allOf: – #/definitions/pisCofinsNormalImportacao description: COFINS cofinsImportacao: type: object allOf: – #/definitions/pisCofinsNormalImportacao description: COFINS Importação issRetido: type: object allOf: – #/definitions/iss description: ISS Retido pisRetido: type: object allOf: – #/definitions/impostoPadrao description: PIS Retido cofinsRetido: type: object allOf: – #/definitions/impostoPadrao description: COFINS Retido csll: type: object allOf: – #/definitions/impostoPadrao description: CSLL irrf: type: object allOf: – #/definitions/impostoPadrao description: IRRF inss: type: object allOf: – #/definitions/impostoPadrao description: INSS inssPatronal: type: object allOf: – #/definitions/impostoPadrao description: INSS Patronal impostoImportacaoII: type: object allOf: – #/definitions/impostoPadrao description: INSS Patronal cide: type: object allOf: – #/definitions/cide description: CIDE responses: 200: description: Ok schema: type: object required: – impostosCalculados properties: impostosCalculados: type: object allOf: – #/definitions/imposto description: Lista com os impostos calculados default: description: Error response schema: #/definitions/genericError /calculo_impostos/queries/consultarParametrizacaoUtilizada: post: description: Verifica no elasticsearch da memoria de calculo se o ID informado ja foi utilizado o ou não tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: UUID dos parametros de impostos ex: PisParametros responses: 200: description: Ok schema: type: object required: – encontrado properties: encontrado: type: boolean description: Retorna true se encontrou ou false se não existir nada default: description: Error response schema: #/definitions/genericError get: description: Verifica no elasticsearch da memoria de calculo se o ID informado ja foi utilizado o ou não tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: UUID dos parametros de impostos ex: PisParametros in: query required: true type: string responses: 200: description: Ok schema: type: object required: – encontrado properties: encontrado: type: boolean description: Retorna true se encontrou ou false se não existir nada default: description: Error response schema: #/definitions/genericError /calculo_impostos/queries/retornarParametrosRetencoes: post: description: Retorna os parametros utilizados para o calculo de retenção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – emitente – dataEmissao – tipoOperacao – destinatario properties: empresaCodigo: type: integer format: int64 description: Código da empresa – Código de negócio minimum: 0 emitente: type: object allOf: – #/definitions/participante description: Dados para identificação do emitente dataEmissao: type: string format: date-time description: Data de emissão do documento dataEntrada: type: string format: date-time description: Data de Entrada – é a data de inserção do documento, emissão pode ser posterior tipoOperacao: type: string allOf: – #/definitions/tipoOperacao description: Tipo de operação: Entrada ou Saída operacao: type: string description: Código da operação destinatario: type: object allOf: – #/definitions/participante description: Dados para identificação do destinatário itens: type: array items: type: object allOf: – #/definitions/itemRetencao description: Itens do documento de retenção responses: 200: description: Ok schema: type: object required: – parametrosPorItem properties: parametrosPorItem: type: array items: type: object allOf: – #/definitions/retornoParametroItem minimum: 1 description: Retorno de parametrização por item default: description: Error response schema: #/definitions/genericError /calculo_impostos/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /calculo_impostos/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumConsumidorFinal: description: Consumidor final type: string enum: – SIM – NAO – INDIFERENTE tipoOperacao: description: Contém o tipo de operação do impostos type: string enum: – ENTRADA – SAIDA tipoDiferimento: description: Indicativo de como será o tipo de diferimento type: string enum: – BASE – VALOR formaNaoTributada: description: Forma não tributada type: string enum: – ISENTAS – OUTRAS – NENHUMA – SENIOR enumDescontaICMSST: description: Desconta ICMS ST type: string enum: – NAO – SOMENTE_FINANCEIRO – SOMENTE_DO_VALOR_LIQUIDO enumCodEmp: description: Condição de empresa type: string enum: – SUBSTITUIDO – SUBSTITUTO – SUBSTITUTO_SOLIDARIO enumRetornoICMSST: description: Tipo de retorno ICMS ST type: string enum: – RETIDO – RETIDO_SOLIDARIO – RETIDO_FUTURO – RETIDO_ANTERIORMENTE enumICMSSTDevolucao: description: Devolução ICMS ST campos de retorno type: string enum: – V1 – V2 – V3 enumDevolucaoIpi: description: Devolução IPI type: string enum: – IPI_DESTACADO – IPI_DEVOLVIDO – OUTRAS aplicacaoOperacao: description: Aplicação da natureza da operação type: string enum: – REMESSA – RETORNO – TRANSFERENCIA – OUTROS enumMotDes: description: Motivo da desoneração type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V16 – V90 enumAplicacaoOperacao: description: Aplicação da operação type: string enum: – REMESSA – RETORNO – TRANSFERENCIA – SIMPLES_FATURAMENTO enumCodCrt: description: Código do Regime Tributário type: string enum: – V1 – V2 – V3 userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT 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 produto: description: Contém informações que definem ou identificam um produto type: object properties: exIpi: type: string description: Exceção do IPI ncm: type: string description: NCM – Nomenclatura Comum do Mercosul codigoProduto: type: string description: Código do produto gtinEan: type: string description: Código EAN origemMercadoria: type: string description: Origem da mercadoria controlaEntradaSaida: type: boolean description: Controle Entrada/Saida ICMS ST (PEPS) participante: description: Representa algum participante da operação type: object properties: cnpjCpf: type: string description: CNPJ/CPF do participante. Somente os números, sem formatação nif: type: string description: Código NIF (Número de Identificação Fiscal) codigo: type: integer format: int64 description: Código do participante minimum: 0 maximum: 999999999 consumidorFinal: type: boolean description: Consumidor final default: false servico: description: Contém informações que definem ou identificam um serviço type: object properties: nbs: type: string description: Código da NBS – Nomenclatura Brasileira de Serviços codigoServico: type: string description: Código do serviço lc1162003: type: string description: Código da Lei complementar 116/2003 valores: description: Contém valores gerais utilizados para o cálculo type: object required: – quantidadeTributavel – valorUnitarioTributavel properties: quantidadeTributavel: type: number format: double description: Quantidade tributável valorUnitarioTributavel: type: string description: Valor unitário da tributação valorDesconto: type: string description: Valor do desconto valorFreteNormal: type: string description: Valor do frete valorFreteDestacado: type: string description: Valor do frete destacado valorFreteImportacao: type: string description: Valor do frete de importação valorAfrmm: type: string description: Valor AFRMM valorSeguro: type: string description: Valor total do seguro valorSeguroImportacao: type: string description: Valor total do seguro importação valorOutrasDespesas: type: string description: Valor de outras despesas acessórias valorOutrasDespesasDestacadas: type: string description: Valor de outras despesas destacadas valorOutrasDespesasImportacao: type: string description: Valor de outras despesas importação valorEncargos: type: string description: Valor total de encargos valorEmbalagens: type: string description: Valor total de embalagens valorPedagio: type: string description: Valor do pedágio valorVariacaoCambial: type: string description: Valor de variação cambial indiceGrossUp: type: number format: double description: Valor do indice da moeda para cálculo GrossUp indiceNegociado: type: number format: double description: Valor do índice da moeda negociado no documento valorLiquidoSemImposto: type: string description: Valor liquido do documento sem os valores de impostos icmsValores: description: Contém os parâmetros relacionados ao ICMS type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto percentualReducao: type: number format: double description: Percentual de redução devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução motivo: type: string allOf: – #/definitions/enumMotDes description: Motivo da desoneração icmsPadrao: description: Valores padrões de ICMS ST type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto percentualReducao: type: number format: double description: Percentual de redução icmsRetidoAnterior: description: Valores de ICMS ST retidos anteriormente type: object properties: base: type: string description: Base de cálculo do imposto percentualSuportado: type: number format: double description: Aliquota suportada pelo consumidor final valor: type: string description: Valor do imposto valorRecolhido: type: string description: Valor recolhido pelo substituto icmsRetido: description: Valores de ICMS ST type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto percentualReducao: type: number format: double description: Percentual de redução percentualMVA: type: number format: double description: Percentual de margem do valor agregado icmsSt: description: Contem os parametros relacionados ao ICMS ST type: object properties: retido: type: object allOf: – #/definitions/icmsRetido description: ICMS ST retido solidario: type: object allOf: – #/definitions/icmsPadrao description: ICMS ST retido solidário futuro: type: object allOf: – #/definitions/icmsPadrao description: ICMS ST entrega futura retidoAnterior: type: object allOf: – #/definitions/icmsRetidoAnterior description: ICMS ST retido anteriormente efetivo: type: object allOf: – #/definitions/icmsPadrao description: ICMS Efetivo devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução impostoPadrao: description: Contém os parâmetros relacionados ao imposto type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução origemNfFrete: type: object allOf: – #/definitions/origemNfFrete description: Informações das origens da nota fiscal de frete impostoPadraoIcms: description: Contém os parâmetros relacionados ao imposto type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução ipi: description: Contém os parâmetros relacionados ao imposto IPI type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto basePresumido: type: string description: Base de cálculo do imposto presumido percentualImpostoPresumido: type: number format: double description: Percentual do imposto imposto presumido valorPresumido: type: string description: Valor do imposto presumido baseCreditado: type: string description: Base de cálculo do imposto efetivamente creditado percentualImpostoCreditado: type: number format: double description: Percentual do imposto imposto efetivamente creditado valorCreditado: type: string description: Valor do imposto efetivamente creditado devolucao: type: object allOf: – #/definitions/devolucaoImpostoIPI description: Valores originais do documento usado para o calculo na devolução origemNfFrete: type: object allOf: – #/definitions/origemNfFrete description: Informações das origens da nota fiscal de frete valorIsentas: type: string description: valor de isentas do imposto valorOutras: type: string description: valor de outras do imposto situacaoTributaria: type: string description: Situação tributária enquadramentoIPI: type: string description: Enquadramento do IPI iss: description: Contém os parâmetros relacionados ao imposto type: object required: – municipio properties: base: type: string description: Base de cálculo do imposto percentualReducaoBase: type: number format: double description: Percentual de Redução da base de cálculo percentualImposto: type: number format: double description: Percentual do imposto imposto valor: type: string description: Valor do imposto municipio: type: integer format: int64 description: Município de tributação do ISS (Código do IBGE) minimum: 0 maximum: 9999999 devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução origemNfFrete: type: object allOf: – #/definitions/origemNfFrete description: Informações das origens da nota fiscal de frete pisCofinsNormalImportacao: description: Contém os parâmetro relacionados ao PIS type: object properties: base: type: string description: Base de cálculo do PIS percentualImposto: type: number format: double description: Percentual do imposto PIS valor: type: string description: Valor do PIS devolucao: type: object allOf: – #/definitions/devolucaoImposto description: Valores originais do documento usado para o calculo na devolução origemNfFrete: type: object allOf: – #/definitions/origemNfFrete description: Informações das origens da nota fiscal de frete situacaoTributaria: type: string description: Situação tributária imposto: description: Representa um imposto calculado type: object properties: pis: type: object allOf: – #/definitions/retornoPisCofinsNormalImportacao description: Retorno do PIS cofins: type: object allOf: – #/definitions/retornoPisCofinsNormalImportacao description: Retorno do cofins pisImportacao: type: object allOf: – #/definitions/retornoPisCofinsNormalImportacao description: Retorno do pis importação cofinsImportacao: type: object allOf: – #/definitions/retornoPisCofinsNormalImportacao description: Retorno do cofins importação iss: type: object allOf: – #/definitions/retornoIss description: Retorno do ISS icms: type: object allOf: – #/definitions/retornoIcms description: Retorno do ICMS ipi: type: object allOf: – #/definitions/retornoIpi description: Retorno do IPI issRetido: type: object allOf: – #/definitions/retornoIssRetido description: Retorno do PIS Retido pisRetido: type: object allOf: – #/definitions/retornoPisRetido description: Retorno do PIS Retido cofinsRetido: type: object allOf: – #/definitions/retornoCofinsRetido description: Retorno do COFINS Retido csll: type: object allOf: – #/definitions/retornoCsll description: Retorno do CSLL irrf: type: object allOf: – #/definitions/retornoIrrf description: Retorno do IRRF inss: type: object allOf: – #/definitions/retornoInss description: Retorno do INSS inssPatronal: type: object allOf: – #/definitions/retornoInssPatronal description: Retorno do INSS impostoImportacaoII: type: object allOf: – #/definitions/retornoImpostoImportacaoII description: Retorno do II cide: type: object allOf: – #/definitions/retornoCide description: Retorno do CIDE devolucaoItem: description: Contém os parametros com a quantidade original e valor original do documento a ser devolvido type: object properties: quantidadeOriginal: type: number format: double description: quantidade original do item no documento de entrada utilizado para devolução parcial valorOriginal: type: string description: valor original do item no documento de entrada utilizado para devolução parcial devolucaoImposto: description: Contém os parametros para o cálculo de devolucão do imposto type: object properties: baseOriginal: type: string description: Valor da base de cálculo original do item valorImpostoOriginal: type: string description: Valor calculado por imposto original do item percentualImposto: type: number format: double description: Percentual do imposto original do item devolucaoImpostoIPI: description: Contém os parametros para o cálculo de devolucão do imposto IPI type: object properties: baseOriginal: type: string description: Valor da base de cálculo original do item valorImpostoOriginal: type: string description: Valor calculado por imposto original do item percentualImpostoOriginal: type: number format: double description: Percentual do imposto original do item baseOriginalPresumido: type: string description: Valor da base de cálculo original do item presumido valorImpostoOriginalPresumido: type: string description: Valor calculado por imposto original do item presumido percentualImpostoOriginalPresumido: type: number format: double description: Percentual do imposto original do item presumido origemNfFrete: description: Informações das origens da nota fiscal de frete type: object properties: totalTributado: type: string description: Valor, Quantidade ou Peso tributado nas notas de origens de frete totalNaoTributado: type: string description: Valor, Quantidade ou Peso não tributado nas notas de origens de frete icms: description: Valores de icms type: object properties: estadoOrigem: type: string description: Sigla do estado origem estadoDestino: type: string description: Sigla do estado destino finalidadeCompraVenda: type: string description: Finalidade de compra e Venda origemNfFrete: type: object allOf: – #/definitions/origemNfFrete description: Informações das origens da nota fiscal de frete icms: type: object allOf: – #/definitions/icmsValores description: ICMS icmsSimples: type: object allOf: – #/definitions/icmsValores description: ICMS Simples icmsFuturo: type: object allOf: – #/definitions/icmsValores description: ICMS Futuro icmsCreditado: type: object allOf: – #/definitions/icmsValores description: ICMS Creditado (Entrada) icmsDest: type: object allOf: – #/definitions/icmsValores description: ICMS de Destino DIFAL icmsSt: type: object allOf: – #/definitions/icmsSt description: ICMS ST icmsDesonerado: type: object allOf: – #/definitions/icmsValores description: ICMS Desonerado icmsDiferido: type: object allOf: – #/definitions/icmsValores description: ICMS Diferido fcpSt: type: object allOf: – #/definitions/impostoPadraoIcms description: Fundo de combate a pobreza ST fcp: type: object allOf: – #/definitions/impostoPadraoIcms description: Fundo de combate a pobreza fcpDest: type: object allOf: – #/definitions/impostoPadraoIcms description: Fundo de combate a pobreza destino situacaoTributaria: type: string description: Situação tributária origemMercadoria: type: string description: Origem da mercadoria retornoPisCofinsNormalImportacao: description: Informações de retorno do calculo do PIS type: object properties: regimeTributarioPis: type: string description: Regime tributário do PIS tipoBaseCalculoCredito: type: string description: Tipo de crédito base de calculo naturezaReceita: type: string description: Natureza de receita percentualReducaoBase: type: number format: double description: Percentual de redução da base aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido cst: type: string description: CST (Saída/Entrada) composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado retornoIss: description: Informações de retorno do calculo de ISS type: object properties: naturezaOperacaoServico: type: string description: Natureza de operação do serviço exigibilidade: type: string description: Exigibilidade cst: type: string description: Situação tributária codigoTributacao: type: string description: Código de tributação codigoTributacaoNfse: type: string description: Código de tributação NFSE codigoFiscalMunicipio: type: string description: Código fiscal do municipio percentualReducaoBase: type: number format: double description: Percentual de redução da base aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado retornoIcms: description: Retorno do ICMS type: object properties: simplesNacional: type: boolean description: Regime do participante é simples nacional aplicacaoOperacao: type: string allOf: – #/definitions/enumAplicacaoOperacao description: Aplicação da operação cst: type: string description: Situação tributária origemMercadoria: type: string description: Origem da mercadoria composicaoBase: type: string description: Fórmula aplicada para base de cálculo icmsSimples: type: object allOf: – #/definitions/retornoIcmsNormal description: ICMS Simples icmsFuturo: type: object allOf: – #/definitions/retornoIcmsNormal description: ICMS Futuro icmsDestacado: type: object allOf: – #/definitions/retornoIcmsNormal description: ICMS icmsCreditado: type: object allOf: – #/definitions/retornoIcmsNormal description: Retorno do ICMS Creditado (Entrada) icmsSt: type: object allOf: – #/definitions/retornoIcmsSt description: Retorno do ICMS ST icmsDest: type: object allOf: – #/definitions/retornoIcmsDestino description: Retorno do ICMS de Destino icmsDiferido: type: object allOf: – #/definitions/retornoIcmsDiferido description: Retorno do ICMS Diferido icmsDesonerado: type: object allOf: – #/definitions/retornoIcmsDesonerado description: Retorno do ICMS Desonerado fcpSt: type: object allOf: – #/definitions/retornoFcpSt description: Retorno do Fundo de combate a pobreza ST fcp: type: object allOf: – #/definitions/retornoFcp description: Retorno do Fundo de combate a pobreza fcpDest: type: object allOf: – #/definitions/retornoFcpDestino description: Retorno do Fundo de combate a pobreza destino icmsIsentasOutras: type: object allOf: – #/definitions/retornoIcmsIsentasOutras description: Retorno de isentas/outras retornoIcmsSt: description: Informações de retorno do calculo de ICMS ST type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo formaDescontoSt: type: string allOf: – #/definitions/enumDescontaICMSST description: Tipo de desconto do valor do ICMS ST modalidadeContribuinteSt: type: string allOf: – #/definitions/enumCodEmp description: Modalidade do contribuinte ST formaStDevolucao: type: string allOf: – #/definitions/enumICMSSTDevolucao description: Tipo de devolucao do ICMS ST guiaPorDocumento: type: boolean description: Gerar guia por Documento retido: type: object allOf: – #/definitions/retornoIcmsStRetido description: ICMS ST retido solidario: type: object allOf: – #/definitions/retornoIcmsStPadrao description: ICMS ST solidário futuro: type: object allOf: – #/definitions/retornoIcmsStPadrao description: ICMS ST entrega futura retidoAnterior: type: object allOf: – #/definitions/retornoIcmsStRetidoAnterior description: ICMS ST retido anteriormente efetivo: type: object allOf: – #/definitions/retornoIcmsStPadrao description: Informações de ICMS efetivo retornoIcmsNormal: description: Informações de retorno do calculo de ICMS type: object properties: percentualReducaoBase: type: number format: double description: Percentual de redução da base aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado prazoSuspencao: type: integer format: int64 description: Prazo de suspenção valorImpostoOperacao: type: string description: Valor do imposto da operação retornoFcpSt: description: Informações de retorno do calculo de FCP ST type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado guiaPorDocumento: type: boolean description: Gerar guia por Documento retornoIcmsDestino: description: Informações de retorno do calculo de ICMS Destino DIFAL type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualReducaoBase: type: number format: double description: Percentual de redução da base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado percentualDifalDestino: type: number format: double description: Alíquota do ICMS do destino guiaPorDocumento: type: boolean description: Gerar guia por Documento retornoFcpDestino: description: Informações de retorno do calculo de FCP Destino type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado guiaPorDocumento: type: boolean description: Gerar guia por Documento retornoIcmsIsentasOutras: description: Informações de retorno de isentas e outras de ICMS type: object properties: valorIsentas: type: string description: valor de isentas do imposto valorOutras: type: string description: valor de outras do imposto retornoFcp: description: Informações de retorno do calculo de FCP Destino type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado guiaPorDocumento: type: boolean description: Gerar guia por Documento retornoIssRetido: description: Informações de retorno do calculo de ISS Retido type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado percentualReducaoBase: type: number format: double description: Percentual de redução da base codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoPisRetido: description: Informações de retorno do calculo de PIS Retido type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoCofinsRetido: description: Informações de retorno do calculo de COFINS Retido type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoCsll: description: Informações de retorno do calculo de CSLL type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoIrrf: description: Informações de retorno do calculo de IRRF type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoInss: description: Informações de retorno do calculo de INSS type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoInssPatronal: description: Informações de retorno do calculo de INSS Patronal type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado regimeControleRetencao: type: string description: Regime de Retenção codigoArrecadacao: type: string description: Código de Arrecadação guiaPorDocumento: type: boolean description: Gerar guia por Documento naturezaRetencao: type: string description: Natureza de Retenção retornoValoresIpi: description: Agrupador de valores de IPI type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado retornoIpi: description: Informações de retorno do calculo de IPI type: object properties: destacado: type: object allOf: – #/definitions/retornoValoresIpi description: Valores de IPI destacado presumido: type: object allOf: – #/definitions/retornoValoresIpi description: Valores de IPI presumido creditado: type: object allOf: – #/definitions/retornoValoresIpi description: Valores de IPI creditado composicaoBase: type: string description: Fórmula aplicada para base de cálculo enquadramentoIpi: type: string description: Código de enquadramento de IPI percentualReducaoBase: type: number format: double description: Percentual de redução da base cst: type: string description: CST (Saída/Entrada) valorIsentas: type: string description: Valor isentas valorOutras: type: string description: Valor outras devolucaoIpi: type: string allOf: – #/definitions/enumDevolucaoIpi description: Forma de devolução do IPI retornoImpostoImportacaoII: description: Informações de retorno do calculo de IPI type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado percentualReducaoBase: type: number format: double description: Percentual de redução da base retornoIcmsStPadrao: description: Informações de retorno do calculo de ICMS padrão type: object properties: valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado percentualReducaoBase: type: number format: double description: Percentual de redução da base retornoIcmsStRetido: description: Informações de retorno do calculo de ICMS Retido type: object properties: valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado percentualReducaoBase: type: number format: double description: Percentual de redução da base percentualMVA: type: number format: double description: Percentual de margem do valor agregado retornoIcmsStRetidoAnterior: description: Informações de retorno do calculo de ICMS Retido Anteriormente type: object properties: valorBase: type: string description: Valor calculo como base valorImposto: type: string description: Valor do imposto calculado aliquotaSuportada: type: number format: double description: Aliquota suportada consumidor final valorIcmsProprio: type: string description: Valor ICMS proprio retornoIcmsDiferido: description: Informações de retorno do calculo de ICMS Diferido type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado retornoIcmsDesonerado: description: Informações de retorno do calculo de ICMS Desonerado type: object properties: aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado motivo: type: string allOf: – #/definitions/enumMotDes description: Motivo da desoneração itemRetencao: description: Item de retenção do documento type: object required: – idItem properties: idItem: type: string description: Id do item no documento servico: type: object allOf: – #/definitions/servico description: Dados do serviço produto: type: object allOf: – #/definitions/produto description: Dados do produto retornoParametroItem: description: Retorno dos parametros de retenção por item type: object properties: idItem: type: string description: Id do item no documento parametros: type: object allOf: – #/definitions/parametrosRetencao description: Parametros por imposto do item parametrosRetencao: description: Parametros da retenção type: object properties: pisRetido: type: object allOf: – #/definitions/parametroRetencao description: Configuração do PIS Retido cofinsRetido: type: object allOf: – #/definitions/parametroRetencao description: Configuração do Cofins Retido csll: type: object allOf: – #/definitions/parametroRetencao description: Configuração do CSLL issRetido: type: object allOf: – #/definitions/parametroRetencao description: Configuração do ISS Retido inss: type: object allOf: – #/definitions/parametroRetencao description: Configuração do INSS inssPatronal: type: object allOf: – #/definitions/parametroRetencao description: Configuração do INSS Patronal irrf: type: object allOf: – #/definitions/parametroRetencao description: Configuração do IRRF parametroRetencao: description: Retorno padrão por imposto retido type: object properties: controlaRetencaoFilial: type: string description: Indicativo do controle de retenção da filial tipoControle: type: string description: Tipo de controle de retenção valorMinimoRetencao: type: string description: Valor mínimo para retenção valorMaximoRecolhimento: type: string description: Valor máximo do recolhimento, utilizado apenas para INSS e INSS Patronal gerarGuiaDocumento: type: boolean description: Gerar guia no documento saidaExterior: type: boolean description: Saída pra o exterior regimeTributario: type: string description: Regime Tributário calculoGrossUp: type: boolean description: Calculo Gross Up descontarRetencao: type: boolean description: Descontar Retenção tabelaProgressiva: type: boolean description: Tabela Progressiva codigoArrecadacao: type: string description: Código de Arrecadação cide: description: Contém os parâmetros relacionados ao CIDE type: object properties: base: type: string description: Base de cálculo do imposto percentualImposto: type: number format: double description: Percentual imposto valor: type: string description: Valor do imposto retornoCide: description: Informações de retorno do calculo de CIDE type: object properties: percentualReducaoBase: type: number format: double description: Percentual de redução da base aplicarValorLiquido: type: string description: Aplicar imposto no valor líquido composicaoBase: type: string description: Fórmula aplicada para base de cálculo valorBase: type: string description: Valor calculo como base percentualImposto: type: number format: double description: % de imposto usado para cálculo valorImposto: type: string description: Valor do imposto calculado 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. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE