# Portal Fiscal

portalFiscal

## GET /listaServico

> Obter Lista de Serviço

```json
{"openapi":"3.0.1","info":{"title":"Estoque","version":"1.0"},"tags":[{"name":"Portal Fiscal","description":"portalFiscal"}],"servers":[{"url":"https://localhost/estoques/v10"},{"url":"http://localhost/estoques/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaServicos":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Servico"}}}},"Servico":{"type":"object","properties":{"codSevico":{"type":"integer","description":"Código do Serviço"},"descServico":{"type":"string","description":"Descrição do Serviço"},"codServEFD":{"type":"integer","description":"Código Serviço EFD-Reinf"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/listaServico":{"get":{"tags":["Portal Fiscal"],"summary":"Obter Lista de Serviço","operationId":"ObterListaServico","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaServicos"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## PUT /documentoEntrada/{ignorarCenario}/{lancarDocumento}

> Cadastrar Documento de Entrada

```json
{"openapi":"3.0.1","info":{"title":"Estoque","version":"1.0"},"tags":[{"name":"Portal Fiscal","description":"portalFiscal"}],"servers":[{"url":"https://localhost/estoques/v10"},{"url":"http://localhost/estoques/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DocumentoEntrada":{"type":"object","properties":{"numero":{"type":"integer","description":"Código Numérico da Nota"},"codSerie":{"type":"string","description":"Série"},"codFornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY/MM/DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY/MM/DD)","format":"date"},"codParametro":{"maximum":99999,"type":"integer","description":"Parâmetro"},"especieDocumento":{"maximum":99,"type":"integer","description":"Espécie do Documento (1 - Nota Fiscal,2 - Nota Fiscal com Conhecimento,3 - Nota Fiscal de Devolução,4 - Conhecimento,5 - Fatura Energia Elétrica,6 - Nota Serviço,7 - Nota Fiscal Complementar,8 - Nota Fiscal Retorno Industrialização,10 - Nota Fiscal Retorno Industrialização com Conhecimento,11 - Nota Fiscal com Serviço,12 - Nota Fiscal com Serviço e Conhecimento,13 - Nota Fiscal Retorno de Industrialização/Serviço,14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento,15 - Outros Documentos)","enum":[1,2,3,4,5,6,7,8,10,11,12,13,14,15]},"tipoDocEnt":{"type":"integer","description":"Tipo de Documento (Entrada Padrao)"},"UFEmissao":{"maxLength":2,"type":"string","description":"UF Emissão"},"observacao":{"maxLength":500,"type":"string","description":"Observação (Dados Gerais)"},"chaveNfe":{"maxLength":44,"type":"string","description":"Chave de acesso da NF-e"},"moduloOrigem":{"maximum":99,"type":"integer","description":"Módulo de Origem do Documento (1 - Portal de Entrada (Importado XML),2 - Portal de Entrada (Digitado),3 - Módulo de Importação (EDS),4 - API Portal Fiscal,99 - Outro)","enum":[1,2,3,4]},"pkModuloOrigem":{"maxLength":60,"type":"string","description":"Primary Key de ligação para o módulo de origem, separando as chaves por sub-pieces, conforme Módulo de importação(EDS) (ProcessoImportacao + seqDesembaraço + seqNotaEntrada)"},"dadosContabil":{"type":"array","items":{"$ref":"#/components/schemas/ContaContabil"}},"dadosImportacao":{"$ref":"#/components/schemas/DadosImportacao"},"financeiroParcelas":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroParcelas"}},"dadosServico":{"$ref":"#/components/schemas/DadosServico"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/Itens"}},"valoresDFE":{"$ref":"#/components/schemas/ValoresDFE"}}},"ContaContabil":{"type":"object","properties":{"contaContabil":{"maxLength":5,"type":"string","description":"Código da Conta Contábil"},"valor":{"multipleOf":0.01,"maximum":9999999.99,"type":"number","description":"Valor para a conta contábil"}}},"DadosImportacao":{"type":"object","properties":{"numeroDI":{"maxLength":15,"type":"string","description":"Número da Declaração de Importação"}}},"FinanceiroParcelas":{"type":"object","properties":{"duplicata":{"maxLength":8,"type":"string","description":"Duplicata"},"parcela":{"maxLength":3,"type":"string","description":"Parcela"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY/MM/DD)","format":"date"},"valorParcela":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Parcela"},"valorDesconto":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Desconto"},"valorJuros":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Juros"},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoMoeda":{"maximum":99,"type":"integer","description":"Tipo de Moeda"},"codHistorico":{"maximum":999,"type":"integer","description":"Código do Histórico"},"complHistorico1":{"maxLength":35,"type":"string","description":"Complemento do Histórico 1"}}},"DadosServico":{"type":"object","properties":{"tipoDocumento":{"maxLength":1,"type":"string","description":"Tipo de Documento (\"C\"-Cupom Fiscal,\"J\"-Nota Fiscal Conjugada,\"N\"-Nota Fiscal,\"O\"-Outros,\"R\"-Recibo)","enum":["C","J","N","O","R"]},"sitDocumento":{"maxLength":1,"type":"string","description":"Situação de Documento (\"D\"-Descontada pela Prefeitura,\"E\"-Regime Especial,\"I\"-Isenta ,\"N\"-Normal,\"R\"-Retida ,\"S\"-Substituta ,\"T\"-Não Tributável)","enum":["D","E","I","N","R","S","T"]},"codCidadePrestServ":{"maxLength":7,"type":"string","description":"Código do IBGE da Cidade de Prestação do Serviço"},"codNatOper":{"maximum":9,"type":"integer","description":"Natureza da Operação (1 - Tributação no município,2 - Tributação fora do município,3 - Isento,4 - Imune,5 - Exigibilidade suspensa por decisão judicial,6 - Exigibilidade suspensa por processo administrativo,7 - Não incidênci ,8 - Exportação)","enum":[1,2,3,4,5,6,7,8]}}},"Itens":{"type":"object","properties":{"codItem":{"maxLength":20,"type":"string","description":"Código do Item"},"descrItem":{"maxLength":50,"type":"string","description":"Descrição do Item"},"unidadeMedida":{"maxLength":6,"type":"string","description":"Unidade de Medida"},"classificacaoFiscal":{"maximum":99999,"type":"integer","description":"Classificação Fiscal"},"quantItem":{"multipleOf":0.001,"maximum":9999999.999,"type":"number","description":"Quantidade do Item"},"valorTotalItem":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total do Item"},"valorDesconto":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Desconto"},"cfopSaida":{"maximum":9999,"type":"integer","description":"CFOP de Saída"},"cfopEntrada":{"maximum":9999,"type":"integer","description":"CFOP de Entrada"},"impostoICMS":{"$ref":"#/components/schemas/ImpostoICMS"},"impostoIPI":{"$ref":"#/components/schemas/ImpostoIPI"},"impostoPISPASEP":{"$ref":"#/components/schemas/ImpostoPISPASEP"},"impostoCOFINS":{"$ref":"#/components/schemas/ImpostoCOFINS"},"impostoISS":{"$ref":"#/components/schemas/ImpostoISS"},"dadosEstoque":{"$ref":"#/components/schemas/DadosEstoqueItem"},"dadosServicoItem":{"$ref":"#/components/schemas/DadosServicoItem"},"dadosContabil":{"$ref":"#/components/schemas/ItemContabil"},"pedidosCompraItem":{"type":"array","items":{"$ref":"#/components/schemas/Pedido"}}}},"ImpostoICMS":{"type":"object","properties":{"baseICMSTrib":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Tributada ou Com Crédito)"},"baseICMSIsent":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Isentas ou Sem Crédito)"},"baseICMSOutras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Outras)"},"percICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota de ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de ICMS"},"codCST":{"maxLength":3,"type":"string","description":"CST do ICMS"}}},"ImpostoIPI":{"type":"object","properties":{"baseIPITrib":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Tributada ou Com Crédito)"},"baseIPIIsent":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Isentas ou Sem Crédito)"},"baseIPIOutras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Outras)"},"valorIPI":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de IPI"},"codCST":{"maxLength":2,"type":"string","description":"CST do IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota de IPI"}}},"ImpostoPISPASEP":{"type":"object","properties":{"basePISPASEP":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do PIS/PASEP"},"aliqPISPASEP":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS/PASEP"},"valorPISPASEP":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de PIS/PASEP"},"codCST":{"maxLength":2,"type":"string","description":"CST do PIS/PASEP"},"tipoBaseCred":{"maxLength":2,"type":"string","description":"Tipo de base de crédito (01 - Aquisição bens para revenda,02 - Aquisição bens util. insumo,03 - Aquisição serviços util. insumo,04 - Energia elétrica e térmica,05 - Aluguéis de prédios,06 - Aluguéis de máquinas/equipamentos,07 - Armaz. mercad./frete oper. venda,08 - Contraprest. arrend. mercantil,09 - Imobilizado (créd. depreciação),10 - Imobilizado (créd. aquisição),11 - Amort./Depreciação imóveis,12 - Devol. Vendas Incid. Não-Cumulativa,13 - Outras Oper. com Direito Crédito,14 - Transporte Cargas,15 - Subcontratação,16 - Imobiliária,17 - Custo Incorrido por unidade,18 - Imobiliária,19 - Custo Orçado por unidade,20 - Prestação de Serviços,Estoque de abertura de bens)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18,19,20]}}},"ImpostoCOFINS":{"type":"object","properties":{"baseCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do COFINS"},"aliqCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de COFINS"},"codCST":{"maxLength":2,"type":"string","description":"CST do COFINS"},"tipoBaseCred":{"maxLength":2,"type":"string","description":"Tipo de base de crédito (01 - Aquisição bens para revenda,02 - Aquisição bens util. insumo,03 - Aquisição serviços util. insumo,04 - Energia elétrica e térmica,05 - Aluguéis de prédios,06 - Aluguéis de máquinas/equipamentos,07 - Armaz. mercad./frete oper. venda,08 - Contraprest. arrend. mercantil,09 - Imobilizado (créd. depreciação),10 - Imobilizado (créd. aquisição),11 - Amort./Depreciação imóveis,12 - Devol. Vendas Incid. Não-Cumulativa,13 - Outras Oper. com Direito Crédito,14 - Transporte Cargas,15 - Subcontratação,16 - Imobiliária,17 - Custo Incorrido por unidade,18 - Imobiliária,19 - Custo Orçado por unidade,20 - Prestação de Serviços,Estoque de abertura de bens)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18,19,20]}}},"ImpostoISS":{"type":"object","properties":{"valorServico":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de Serviço"},"aliquota":{"multipleOf":0.01,"maximum":999.99,"type":"number","description":"Valor da Alíquota"},"valorISS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do ISS"}}},"DadosEstoqueItem":{"type":"object","properties":{"codTransacaoEntrada":{"maximum":9999,"type":"integer","description":"Código Transação de Estoque de Entrada"},"codTransacaoSaida":{"maximum":9999,"type":"integer","description":"Código Transação de Estoque de Saída"}}},"DadosServicoItem":{"type":"object","properties":{"codListaServico":{"type":"string","maxLength":6,"description":"Código da Lista de Serviço"},"codServicoReinf":{"maximum":99999,"type":"integer","description":"Código Serviço EFD-Reinf"},"codCNOCEI":{"maximum":99999,"type":"integer","description":"Código CNO/CEI"},"baseCalcINSS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base Cálculo INSS"},"aliquotaINSS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota INSS"},"vlrRetencaoINSS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção INSS"},"baseCalcIRRF":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo IRRF"},"baseCalcPIS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo PIS"},"vlrRetencaoPIS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção PIS"},"baseCalcCSLL":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo CSLL"},"vlrRetencaoCSLL":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção CSLL"},"baseCalcCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo COFINS"},"vlrRetencaoCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção COFINS"}}},"ItemContabil":{"type":"object","properties":{"contaContabil":{"maxLength":5,"type":"string","description":"Código da Conta Contábil"},"observacao1":{"maxLength":35,"type":"string","description":"Observação 1"},"observacao2":{"maxLength":35,"type":"string","description":"Observação 2"},"centroCusto":{"type":"array","items":{"$ref":"#/components/schemas/CentroCusto"}}}},"CentroCusto":{"type":"object","properties":{"codCentroCusto":{"type":"integer","description":"Código do Centro de Custo"},"percentual":{"multipleOf":0.01,"maximum":100,"type":"number","description":"Percentual Rateio"}}},"Pedido":{"type":"object","properties":{"codPedido":{"maximum":999999,"type":"integer","description":"Código do Pedido de Compras"},"itemPedido":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido de Compra"},"quantidade":{"multipleOf":0.001,"maximum":9999999.999,"type":"number","description":"Quantidade do Item do Pedido de Compra"}}},"ValoresDFE":{"type":"object","properties":{"despesasAcessorias":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Despesas Acessórias"},"despesasFinanceiras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Despesas Financeiras"},"valorSeguro":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do seguro"},"valorFreteDestacado":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Frete destacado no documento fiscal"}}},"DocumentoEntradaResult":{"type":"object","properties":{"codDigitacao":{"type":"string","description":"Código Digitação"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/documentoEntrada/{ignorarCenario}/{lancarDocumento}":{"put":{"tags":["Portal Fiscal"],"summary":"Cadastrar Documento de Entrada","operationId":"CadastrarDocumentoEntrada","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"ignorarCenario","in":"path","description":"Opção de Aplicar como Sugestão as Regras Cadastradas no Cenário de Lançamento de Documento (0 - Não / 1 - Sim)","required":true,"schema":{"type":"integer"}},{"name":"lancarDocumento","in":"path","description":"Opção de Lançar o Documento, caso negativo ficará disponível no Portal Fiscal para Validação e Lançamento Manual (0 - Não / 1 - Sim)","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Dados Documento Entrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentoEntrada"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentoEntradaResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## GET /documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}

> Obter Documento Entrada

```json
{"openapi":"3.0.1","info":{"title":"Estoque","version":"1.0"},"tags":[{"name":"Portal Fiscal","description":"portalFiscal"}],"servers":[{"url":"https://localhost/estoques/v10"},{"url":"http://localhost/estoques/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DocumentoEntrada":{"type":"object","properties":{"numero":{"type":"integer","description":"Código Numérico da Nota"},"codSerie":{"type":"string","description":"Série"},"codFornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY/MM/DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY/MM/DD)","format":"date"},"codParametro":{"maximum":99999,"type":"integer","description":"Parâmetro"},"especieDocumento":{"maximum":99,"type":"integer","description":"Espécie do Documento (1 - Nota Fiscal,2 - Nota Fiscal com Conhecimento,3 - Nota Fiscal de Devolução,4 - Conhecimento,5 - Fatura Energia Elétrica,6 - Nota Serviço,7 - Nota Fiscal Complementar,8 - Nota Fiscal Retorno Industrialização,10 - Nota Fiscal Retorno Industrialização com Conhecimento,11 - Nota Fiscal com Serviço,12 - Nota Fiscal com Serviço e Conhecimento,13 - Nota Fiscal Retorno de Industrialização/Serviço,14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento,15 - Outros Documentos)","enum":[1,2,3,4,5,6,7,8,10,11,12,13,14,15]},"tipoDocEnt":{"type":"integer","description":"Tipo de Documento (Entrada Padrao)"},"UFEmissao":{"maxLength":2,"type":"string","description":"UF Emissão"},"observacao":{"maxLength":500,"type":"string","description":"Observação (Dados Gerais)"},"chaveNfe":{"maxLength":44,"type":"string","description":"Chave de acesso da NF-e"},"moduloOrigem":{"maximum":99,"type":"integer","description":"Módulo de Origem do Documento (1 - Portal de Entrada (Importado XML),2 - Portal de Entrada (Digitado),3 - Módulo de Importação (EDS),4 - API Portal Fiscal,99 - Outro)","enum":[1,2,3,4]},"pkModuloOrigem":{"maxLength":60,"type":"string","description":"Primary Key de ligação para o módulo de origem, separando as chaves por sub-pieces, conforme Módulo de importação(EDS) (ProcessoImportacao + seqDesembaraço + seqNotaEntrada)"},"dadosContabil":{"type":"array","items":{"$ref":"#/components/schemas/ContaContabil"}},"dadosImportacao":{"$ref":"#/components/schemas/DadosImportacao"},"financeiroParcelas":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroParcelas"}},"dadosServico":{"$ref":"#/components/schemas/DadosServico"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/Itens"}},"valoresDFE":{"$ref":"#/components/schemas/ValoresDFE"}}},"ContaContabil":{"type":"object","properties":{"contaContabil":{"maxLength":5,"type":"string","description":"Código da Conta Contábil"},"valor":{"multipleOf":0.01,"maximum":9999999.99,"type":"number","description":"Valor para a conta contábil"}}},"DadosImportacao":{"type":"object","properties":{"numeroDI":{"maxLength":15,"type":"string","description":"Número da Declaração de Importação"}}},"FinanceiroParcelas":{"type":"object","properties":{"duplicata":{"maxLength":8,"type":"string","description":"Duplicata"},"parcela":{"maxLength":3,"type":"string","description":"Parcela"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY/MM/DD)","format":"date"},"valorParcela":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Parcela"},"valorDesconto":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Desconto"},"valorJuros":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Juros"},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoMoeda":{"maximum":99,"type":"integer","description":"Tipo de Moeda"},"codHistorico":{"maximum":999,"type":"integer","description":"Código do Histórico"},"complHistorico1":{"maxLength":35,"type":"string","description":"Complemento do Histórico 1"}}},"DadosServico":{"type":"object","properties":{"tipoDocumento":{"maxLength":1,"type":"string","description":"Tipo de Documento (\"C\"-Cupom Fiscal,\"J\"-Nota Fiscal Conjugada,\"N\"-Nota Fiscal,\"O\"-Outros,\"R\"-Recibo)","enum":["C","J","N","O","R"]},"sitDocumento":{"maxLength":1,"type":"string","description":"Situação de Documento (\"D\"-Descontada pela Prefeitura,\"E\"-Regime Especial,\"I\"-Isenta ,\"N\"-Normal,\"R\"-Retida ,\"S\"-Substituta ,\"T\"-Não Tributável)","enum":["D","E","I","N","R","S","T"]},"codCidadePrestServ":{"maxLength":7,"type":"string","description":"Código do IBGE da Cidade de Prestação do Serviço"},"codNatOper":{"maximum":9,"type":"integer","description":"Natureza da Operação (1 - Tributação no município,2 - Tributação fora do município,3 - Isento,4 - Imune,5 - Exigibilidade suspensa por decisão judicial,6 - Exigibilidade suspensa por processo administrativo,7 - Não incidênci ,8 - Exportação)","enum":[1,2,3,4,5,6,7,8]}}},"Itens":{"type":"object","properties":{"codItem":{"maxLength":20,"type":"string","description":"Código do Item"},"descrItem":{"maxLength":50,"type":"string","description":"Descrição do Item"},"unidadeMedida":{"maxLength":6,"type":"string","description":"Unidade de Medida"},"classificacaoFiscal":{"maximum":99999,"type":"integer","description":"Classificação Fiscal"},"quantItem":{"multipleOf":0.001,"maximum":9999999.999,"type":"number","description":"Quantidade do Item"},"valorTotalItem":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total do Item"},"valorDesconto":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Desconto"},"cfopSaida":{"maximum":9999,"type":"integer","description":"CFOP de Saída"},"cfopEntrada":{"maximum":9999,"type":"integer","description":"CFOP de Entrada"},"impostoICMS":{"$ref":"#/components/schemas/ImpostoICMS"},"impostoIPI":{"$ref":"#/components/schemas/ImpostoIPI"},"impostoPISPASEP":{"$ref":"#/components/schemas/ImpostoPISPASEP"},"impostoCOFINS":{"$ref":"#/components/schemas/ImpostoCOFINS"},"impostoISS":{"$ref":"#/components/schemas/ImpostoISS"},"dadosEstoque":{"$ref":"#/components/schemas/DadosEstoqueItem"},"dadosServicoItem":{"$ref":"#/components/schemas/DadosServicoItem"},"dadosContabil":{"$ref":"#/components/schemas/ItemContabil"},"pedidosCompraItem":{"type":"array","items":{"$ref":"#/components/schemas/Pedido"}}}},"ImpostoICMS":{"type":"object","properties":{"baseICMSTrib":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Tributada ou Com Crédito)"},"baseICMSIsent":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Isentas ou Sem Crédito)"},"baseICMSOutras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do ICMS (Outras)"},"percICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota de ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de ICMS"},"codCST":{"maxLength":3,"type":"string","description":"CST do ICMS"}}},"ImpostoIPI":{"type":"object","properties":{"baseIPITrib":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Tributada ou Com Crédito)"},"baseIPIIsent":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Isentas ou Sem Crédito)"},"baseIPIOutras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do IPI (Outras)"},"valorIPI":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de IPI"},"codCST":{"maxLength":2,"type":"string","description":"CST do IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota de IPI"}}},"ImpostoPISPASEP":{"type":"object","properties":{"basePISPASEP":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do PIS/PASEP"},"aliqPISPASEP":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS/PASEP"},"valorPISPASEP":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de PIS/PASEP"},"codCST":{"maxLength":2,"type":"string","description":"CST do PIS/PASEP"},"tipoBaseCred":{"maxLength":2,"type":"string","description":"Tipo de base de crédito (01 - Aquisição bens para revenda,02 - Aquisição bens util. insumo,03 - Aquisição serviços util. insumo,04 - Energia elétrica e térmica,05 - Aluguéis de prédios,06 - Aluguéis de máquinas/equipamentos,07 - Armaz. mercad./frete oper. venda,08 - Contraprest. arrend. mercantil,09 - Imobilizado (créd. depreciação),10 - Imobilizado (créd. aquisição),11 - Amort./Depreciação imóveis,12 - Devol. Vendas Incid. Não-Cumulativa,13 - Outras Oper. com Direito Crédito,14 - Transporte Cargas,15 - Subcontratação,16 - Imobiliária,17 - Custo Incorrido por unidade,18 - Imobiliária,19 - Custo Orçado por unidade,20 - Prestação de Serviços,Estoque de abertura de bens)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18,19,20]}}},"ImpostoCOFINS":{"type":"object","properties":{"baseCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Calculo do COFINS"},"aliqCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de COFINS"},"codCST":{"maxLength":2,"type":"string","description":"CST do COFINS"},"tipoBaseCred":{"maxLength":2,"type":"string","description":"Tipo de base de crédito (01 - Aquisição bens para revenda,02 - Aquisição bens util. insumo,03 - Aquisição serviços util. insumo,04 - Energia elétrica e térmica,05 - Aluguéis de prédios,06 - Aluguéis de máquinas/equipamentos,07 - Armaz. mercad./frete oper. venda,08 - Contraprest. arrend. mercantil,09 - Imobilizado (créd. depreciação),10 - Imobilizado (créd. aquisição),11 - Amort./Depreciação imóveis,12 - Devol. Vendas Incid. Não-Cumulativa,13 - Outras Oper. com Direito Crédito,14 - Transporte Cargas,15 - Subcontratação,16 - Imobiliária,17 - Custo Incorrido por unidade,18 - Imobiliária,19 - Custo Orçado por unidade,20 - Prestação de Serviços,Estoque de abertura de bens)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18,19,20]}}},"ImpostoISS":{"type":"object","properties":{"valorServico":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor de Serviço"},"aliquota":{"multipleOf":0.01,"maximum":999.99,"type":"number","description":"Valor da Alíquota"},"valorISS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do ISS"}}},"DadosEstoqueItem":{"type":"object","properties":{"codTransacaoEntrada":{"maximum":9999,"type":"integer","description":"Código Transação de Estoque de Entrada"},"codTransacaoSaida":{"maximum":9999,"type":"integer","description":"Código Transação de Estoque de Saída"}}},"DadosServicoItem":{"type":"object","properties":{"codListaServico":{"type":"string","maxLength":6,"description":"Código da Lista de Serviço"},"codServicoReinf":{"maximum":99999,"type":"integer","description":"Código Serviço EFD-Reinf"},"codCNOCEI":{"maximum":99999,"type":"integer","description":"Código CNO/CEI"},"baseCalcINSS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base Cálculo INSS"},"aliquotaINSS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota INSS"},"vlrRetencaoINSS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção INSS"},"baseCalcIRRF":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo IRRF"},"baseCalcPIS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo PIS"},"vlrRetencaoPIS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção PIS"},"baseCalcCSLL":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo CSLL"},"vlrRetencaoCSLL":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção CSLL"},"baseCalcCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Base de Cálculo COFINS"},"vlrRetencaoCOFINS":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Retenção COFINS"}}},"ItemContabil":{"type":"object","properties":{"contaContabil":{"maxLength":5,"type":"string","description":"Código da Conta Contábil"},"observacao1":{"maxLength":35,"type":"string","description":"Observação 1"},"observacao2":{"maxLength":35,"type":"string","description":"Observação 2"},"centroCusto":{"type":"array","items":{"$ref":"#/components/schemas/CentroCusto"}}}},"CentroCusto":{"type":"object","properties":{"codCentroCusto":{"type":"integer","description":"Código do Centro de Custo"},"percentual":{"multipleOf":0.01,"maximum":100,"type":"number","description":"Percentual Rateio"}}},"Pedido":{"type":"object","properties":{"codPedido":{"maximum":999999,"type":"integer","description":"Código do Pedido de Compras"},"itemPedido":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido de Compra"},"quantidade":{"multipleOf":0.001,"maximum":9999999.999,"type":"number","description":"Quantidade do Item do Pedido de Compra"}}},"ValoresDFE":{"type":"object","properties":{"despesasAcessorias":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Despesas Acessórias"},"despesasFinanceiras":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Despesas Financeiras"},"valorSeguro":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do seguro"},"valorFreteDestacado":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Frete destacado no documento fiscal"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}":{"get":{"tags":["Portal Fiscal"],"summary":"Obter Documento Entrada","operationId":"ObterDocumentoEntrada","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"codFornecedor","in":"path","description":"Código do Fornecedor","required":true,"schema":{"type":"integer"}},{"name":"codSerie","in":"path","description":"Série Fiscal do Documento","required":true,"schema":{"type":"integer"}},{"name":"codDocumento","in":"path","description":"Código do Documento","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentoEntrada"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## DELETE /documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}

> Excluir Documento Entrada do Portal Fiscal

```json
{"openapi":"3.0.1","info":{"title":"Estoque","version":"1.0"},"tags":[{"name":"Portal Fiscal","description":"portalFiscal"}],"servers":[{"url":"https://localhost/estoques/v10"},{"url":"http://localhost/estoques/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}":{"delete":{"tags":["Portal Fiscal"],"summary":"Excluir Documento Entrada do Portal Fiscal","operationId":"ExcluirDocumentoEntrada","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"codFornecedor","in":"path","description":"Código do Fornecedor","required":true,"schema":{"type":"integer"}},{"name":"codSerie","in":"path","description":"Série Fiscal do Documento","required":true,"schema":{"type":"integer"}},{"name":"codDocumento","in":"path","description":"Código do Documento","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/entradas/estoques-v1.0/portal-fiscal.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
