UniversidadeNovidadesPoliticasAtendimento

Portal Fiscal

portalFiscal

Obter Lista de Serviço

get
/listaServico
Autorizações
AuthorizationstringObrigatório
Parâmetros de consulta
continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/listaServico
GET /estoques/v10/listaServico HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codSevico": 1,
      "descServico": "text",
      "codServEFD": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar Documento de Entrada

put
/documentoEntrada/{ignorarCenario}/{lancarDocumento}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
ignorarCenariointegerObrigatório

Opção de Aplicar como Sugestão as Regras Cadastradas no Cenário de Lançamento de Documento (0 - Não / 1 - Sim)

lancarDocumentointegerObrigatório

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)

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Corpo
numerointegerOpcional

Código Numérico da Nota

codSeriestringOpcional

Série

codFornecedorinteger · máx: 99999Opcional

Código do Fornecedor

dataEmissaostring · dateOpcional

Data de Emissão (YYYY/MM/DD)

dataEntradastring · dateOpcional

Data de Entrada (YYYY/MM/DD)

codParametrointeger · máx: 99999Opcional

Parâmetro

especieDocumentointeger · enum · máx: 99Opcional

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)

Valores possíveis:
tipoDocEntintegerOpcional

Tipo de Documento (Entrada Padrao)

UFEmissaostring · máx: 2Opcional

UF Emissão

observacaostring · máx: 500Opcional

Observação (Dados Gerais)

chaveNfestring · máx: 44Opcional

Chave de acesso da NF-e

moduloOrigeminteger · enum · máx: 99Opcional

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)

Valores possíveis:
pkModuloOrigemstring · máx: 60Opcional

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)

Respostas
200

OK

application/json
put
/documentoEntrada/{ignorarCenario}/{lancarDocumento}
PUT /estoques/v10/documentoEntrada/{ignorarCenario}/{lancarDocumento} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1949

{
  "numero": 1,
  "codSerie": "text",
  "codFornecedor": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "codParametro": 1,
  "especieDocumento": 1,
  "tipoDocEnt": 1,
  "UFEmissao": "text",
  "observacao": "text",
  "chaveNfe": "text",
  "moduloOrigem": 1,
  "pkModuloOrigem": "text",
  "dadosContabil": [
    {
      "contaContabil": "text",
      "valor": 1
    }
  ],
  "dadosImportacao": {
    "numeroDI": "text"
  },
  "financeiroParcelas": [
    {
      "duplicata": "text",
      "parcela": "text",
      "dataVencimento": "2025-11-29",
      "valorParcela": 1,
      "valorDesconto": 1,
      "valorJuros": 1,
      "codPortador": 1,
      "tipoMoeda": 1,
      "codHistorico": 1,
      "complHistorico1": "text"
    }
  ],
  "dadosServico": {
    "tipoDocumento": "C",
    "sitDocumento": "D",
    "codCidadePrestServ": "text",
    "codNatOper": 1
  },
  "itens": [
    {
      "codItem": "text",
      "descrItem": "text",
      "unidadeMedida": "text",
      "classificacaoFiscal": 1,
      "quantItem": 1,
      "valorTotalItem": 1,
      "valorDesconto": 1,
      "cfopSaida": 1,
      "cfopEntrada": 1,
      "impostoICMS": {
        "baseICMSTrib": 1,
        "baseICMSIsent": 1,
        "baseICMSOutras": 1,
        "percICMS": 1,
        "valorICMS": 1,
        "codCST": "text"
      },
      "impostoIPI": {
        "baseIPITrib": 1,
        "baseIPIIsent": 1,
        "baseIPIOutras": 1,
        "valorIPI": 1,
        "codCST": "text",
        "aliquotaIPI": 1
      },
      "impostoPISPASEP": {
        "basePISPASEP": 1,
        "aliqPISPASEP": 1,
        "valorPISPASEP": 1,
        "codCST": "text",
        "tipoBaseCred": "01"
      },
      "impostoCOFINS": {
        "baseCOFINS": 1,
        "aliqCOFINS": 1,
        "valorCOFINS": 1,
        "codCST": "text",
        "tipoBaseCred": "01"
      },
      "impostoISS": {
        "valorServico": 1,
        "aliquota": 1,
        "valorISS": 1
      },
      "dadosEstoque": {
        "codTransacaoEntrada": 1,
        "codTransacaoSaida": 1
      },
      "dadosServicoItem": {
        "codListaServico": 1,
        "codServicoReinf": 1,
        "codCNOCEI": 1,
        "baseCalcINSS": 1,
        "aliquotaINSS": 1,
        "vlrRetencaoINSS": 1,
        "baseCalcIRRF": 1,
        "baseCalcPIS": 1,
        "vlrRetencaoPIS": 1,
        "baseCalcCSLL": 1,
        "vlrRetencaoCSLL": 1,
        "baseCalcCOFINS": 1,
        "vlrRetencaoCOFINS": 1
      },
      "dadosContabil": {
        "contaContabil": "text",
        "observacao1": "text",
        "observacao2": "text",
        "centroCusto": [
          {
            "codCentroCusto": 1,
            "percentual": 1
          }
        ]
      },
      "pedidosCompraItem": [
        {
          "codPedido": 1,
          "itemPedido": 1,
          "quantidade": 1
        }
      ]
    }
  ],
  "valoresDFE": {
    "despesasAcessorias": 1,
    "despesasFinanceiras": 1,
    "valorSeguro": 1,
    "valorFreteDestacado": 1
  }
}
{
  "codDigitacao": "text"
}

Obter Documento Entrada

get
/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
codFornecedorintegerObrigatório

Código do Fornecedor

codSerieintegerObrigatório

Série Fiscal do Documento

codDocumentointegerObrigatório

Código do Documento

Parâmetros de cabeçalho
empresaintegerObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}
GET /estoques/v10/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: 1
Accept: */*

{
  "numero": 1,
  "codSerie": "text",
  "codFornecedor": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "codParametro": 1,
  "especieDocumento": 1,
  "tipoDocEnt": 1,
  "UFEmissao": "text",
  "observacao": "text",
  "chaveNfe": "text",
  "moduloOrigem": 1,
  "pkModuloOrigem": "text",
  "dadosContabil": [
    {
      "contaContabil": "text",
      "valor": 1
    }
  ],
  "dadosImportacao": {
    "numeroDI": "text"
  },
  "financeiroParcelas": [
    {
      "duplicata": "text",
      "parcela": "text",
      "dataVencimento": "2025-11-29",
      "valorParcela": 1,
      "valorDesconto": 1,
      "valorJuros": 1,
      "codPortador": 1,
      "tipoMoeda": 1,
      "codHistorico": 1,
      "complHistorico1": "text"
    }
  ],
  "dadosServico": {
    "tipoDocumento": "C",
    "sitDocumento": "D",
    "codCidadePrestServ": "text",
    "codNatOper": 1
  },
  "itens": [
    {
      "codItem": "text",
      "descrItem": "text",
      "unidadeMedida": "text",
      "classificacaoFiscal": 1,
      "quantItem": 1,
      "valorTotalItem": 1,
      "valorDesconto": 1,
      "cfopSaida": 1,
      "cfopEntrada": 1,
      "impostoICMS": {
        "baseICMSTrib": 1,
        "baseICMSIsent": 1,
        "baseICMSOutras": 1,
        "percICMS": 1,
        "valorICMS": 1,
        "codCST": "text"
      },
      "impostoIPI": {
        "baseIPITrib": 1,
        "baseIPIIsent": 1,
        "baseIPIOutras": 1,
        "valorIPI": 1,
        "codCST": "text",
        "aliquotaIPI": 1
      },
      "impostoPISPASEP": {
        "basePISPASEP": 1,
        "aliqPISPASEP": 1,
        "valorPISPASEP": 1,
        "codCST": "text",
        "tipoBaseCred": "01"
      },
      "impostoCOFINS": {
        "baseCOFINS": 1,
        "aliqCOFINS": 1,
        "valorCOFINS": 1,
        "codCST": "text",
        "tipoBaseCred": "01"
      },
      "impostoISS": {
        "valorServico": 1,
        "aliquota": 1,
        "valorISS": 1
      },
      "dadosEstoque": {
        "codTransacaoEntrada": 1,
        "codTransacaoSaida": 1
      },
      "dadosServicoItem": {
        "codListaServico": 1,
        "codServicoReinf": 1,
        "codCNOCEI": 1,
        "baseCalcINSS": 1,
        "aliquotaINSS": 1,
        "vlrRetencaoINSS": 1,
        "baseCalcIRRF": 1,
        "baseCalcPIS": 1,
        "vlrRetencaoPIS": 1,
        "baseCalcCSLL": 1,
        "vlrRetencaoCSLL": 1,
        "baseCalcCOFINS": 1,
        "vlrRetencaoCOFINS": 1
      },
      "dadosContabil": {
        "contaContabil": "text",
        "observacao1": "text",
        "observacao2": "text",
        "centroCusto": [
          {
            "codCentroCusto": 1,
            "percentual": 1
          }
        ]
      },
      "pedidosCompraItem": [
        {
          "codPedido": 1,
          "itemPedido": 1,
          "quantidade": 1
        }
      ]
    }
  ],
  "valoresDFE": {
    "despesasAcessorias": 1,
    "despesasFinanceiras": 1,
    "valorSeguro": 1,
    "valorFreteDestacado": 1
  }
}

Excluir Documento Entrada do Portal Fiscal

delete
/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
codFornecedorintegerObrigatório

Código do Fornecedor

codSerieintegerObrigatório

Série Fiscal do Documento

codDocumentointegerObrigatório

Código do Documento

Parâmetros de cabeçalho
empresaintegerObrigatório

Código da Empresa

Respostas
200

OK

delete
/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento}
DELETE /estoques/v10/documentoEntrada/{codFornecedor}/{codSerie}/{codDocumento} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: 1
Accept: */*

Sem conteúdo
AnteriorMovimentação de EstoquePróximoModels

Atualizado