Vendas NF-e

Consulta Específica de Nota Fiscal Eletrônica (Detalhada)

Changed on

Retorna a estrutura completa (Descrições, Cliente, Itens e Financeiro).

get/v1/vendas/nfe/{codigoNota}

Request

  • Base URL
    https://api.sankhya.com.br
  • URL
    https://api.sankhya.com.br/v1/vendas/nfe/{codigoNota}
  • Auth
    API key in header Authorization

Path parameters

codigoNotainteger required
Example:12540

Código Interno da Nota.

Response

Sucesso.

codigoEmpresainteger
nomeEmpresastring
confirmadaboolean
pendenteboolean
statusWMSinteger
situacaoWMSinteger
statusConferenciainteger
dataNegociacaostring
dataHoraAlteracaostring
numeroNotainteger
codigoNotainteger
serieNotastring
codigoTipoNegociacaointeger
nomeTipoNegociacaostring
codigoTipoOperacaointeger
nomeTipoOperacaostring
codigoNaturezainteger
nomeNaturezastring
codigoCentroResultadointeger
nomeCentroResultadostring
codigoProjetointeger
nomeProjetostring
codigoContratointeger
codigoVendedorinteger
nomeVendedorstring
codigoContatointeger
nomeContatostring
codigoMoedainteger
nomeMoedastring
valorMoedanumber double
valorNotanumber double
descontoTotalnumber double
valorSeguronumber double
valorDestaquenumber double
valorVendornumber double
valorJuronumber double
valorOutrosnumber double
valorEmbalagemnumber double
valorFretenumber double
vencimentoFretestring date
codigoOrdemCargainteger
codigoVeiculointeger
placaVeiculostring
codigoMotoristainteger
nomeMotoristastring
codigoTransportadorainteger
nomeTransportadorastring
codigoRemetenteinteger
nomeRemetentestring
codigoDestinatariointeger
nomeDestinatariostring
quantidadeVolumesinteger
numeracaoVolumesstring
lacresstring
pesoBrutonumber double
cifFob1 | 2 | 3 | 4 | 5 | 6
tipoFrete1 | 2
baseICMSFretenumber double
icmsFretenumber double
chaveNFestring
statusNFestring
numeroProtocoloNFestring
dataProtocoloNFestring date-time
numeroAleatorioNFestring
loteNFestring
numeroRegistroDPECstring
dataRegEPECstring date-time
xmlNFestring
codigoPedidoOrigeminteger

Example response

{
  "codigoEmpresa": 1,
  "nomeEmpresa": "Sankhya Gestão de Negócios Matriz",
  "cliente": {
    "tipo": "PF",
    "cnpjCpf": "12315914799",
    "ieRg": "12315914799",
    "nome": "José da Silva",
    "razao": "José da Silva ME",
    "email": "contato@provedor.com.br",
    "telefoneDdd": "34",
    "telefoneNumero": "912349966",
    "endereco": {
      "entrega": true,
      "nomeContato": "Maria Roberta",
      "email": "maria.roberta@provedor.com.br",
      "logradouro": "Rua Maria Roberta",
      "numero": "10",
      "complemento": "Apto 104",
      "bairro": "Centro",
      "cidade": "Uberlândia",
      "codigoIbge": 11155566,
      "uf": "MG",
      "cep": "38400000"
    }
  },
  "confirmada": true,
  "statusWMS": 2,
  "situacaoWMS": 17,
  "statusConferencia": 6,
  "dataNegociacao": "15/06/2024",
  "dataHoraAlteracao": "15/06/2024 14:45:30",
  "numeroNota": 254100,
  "codigoNota": 12540,
  "serieNota": "1",
  "codigoTipoNegociacao": 110,
  "nomeTipoNegociacao": "Venda de Mercadoria Nacional",
  "codigoTipoOperacao": 1200,
  "nomeTipoOperacao": "Venda Estadual de Produção Própria",
  "codigoNatureza": 30100,
  "nomeNatureza": "Venda de Produção do Estabelecimento",
  "codigoCentroResultado": 10100,
  "nomeCentroResultado": "Departamento Comercial SP",
  "codigoProjeto": 202401,
  "nomeProjeto": "Expansão Sudeste 2024",
  "codigoContrato": 4502,
  "codigoVendedor": 55,
  "nomeVendedor": "Carlos Eduardo Silva",
  "codigoContato": 302,
  "nomeContato": "Maria Paula",
  "nomeMoeda": "Real",
  "valorNota": 5450,
  "descontoTotal": 250,
  "valorSeguro": 45,
  "valorOutros": 85,
  "valorEmbalagem": 20,
  "valorFrete": 180,
  "vencimentoFrete": "2024-07-15",
  "codigoOrdemCarga": 995512,
  "codigoVeiculo": 45,
  "placaVeiculo": "ABC-1234",
  "codigoMotorista": 102,
  "nomeMotorista": "Roberto Mendes",
  "codigoTransportadora": 800,
  "nomeTransportadora": "Expresso Logística Rápida",
  "codigoRemetente": 1,
  "nomeRemetente": "Sankhya Gestão de Negócios Matriz",
  "codigoDestinatario": 20500,
  "nomeDestinatario": "Tech Solutions Comercio e Servicos LTDA",
  "quantidadeVolumes": 12,
  "numeracaoVolumes": "1/12 a 12/12",
  "lacres": "LACRE-001254",
  "pesoBruto": 245.5,
  "cifFob": 1,
  "tipoFrete": 2,
  "baseICMSFrete": 180,
  "icmsFrete": 21.6,
  "chaveNFe": "35240612345678000199550010000125401002541002",
  "statusNFe": "5",
  "numeroProtocoloNFe": "135240008899774",
  "dataProtocoloNFe": "2024-06-15T10:30:00",
  "numeroAleatorioNFe": "98765432",
  "loteNFe": "20240055",
  "numeroRegistroDPEC": "998877",
  "dataRegEPEC": "2024-06-15T09:00:00",
  "xmlNFe": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48bmZlUHJvYyB2ZXJzaW9uPSI0LjAwIiB4bWxucz0iaHR0cDovL3d3dy5wb3J0YWxmaXNjYWwuaW5mLmJyL25mZSI+Li4uPC9uZmVQcm9jPg==",
  "codigoPedidoOrigem": 15420,
  "reformaTributaria": {
    "valorTotalImposto": 1325,
    "valorIBSUF": 662.5,
    "valorIBSMunicipio": 150,
    "valorBaseCalculo": 5000,
    "valorTotalDocumento": 6325
  },
  "itens": [
    {
      "sequencia": 1,
      "codigoProduto": 1050,
      "descricaoProduto": "Notebook Gamer i7 16GB",
      "quantidade": 2,
      "unidade": "UN",
      "valorUnitario": 2500,
      "valorTotal": 5000,
      "cfop": "5101",
      "ncm": "84714100",
      "cst": "000",
      "valorDesconto": 100,
      "codigoLocalEstoque": 2,
      "valorICMS": 900,
      "valorIPI": 250,
      "impostos": [
        {
          "tipo": "ibs",
          "cst": "00",
          "tributacaoMunicipio": "140801",
          "classificacaoTributaria": 200,
          "aliquota": 26.5,
          "aliquotaEfetivaRegular": 26.5,
          "aliquotaEfetivaBaseCalculo": 26.5,
          "valorBaseDIFAL": 43.64,
          "aliquotaInternaDestino": 19.5,
          "percentualPartilhaDIFAL": 100,
          "valorDIFALDestino": 6.76,
          "percentualReducaoAliquotaGovernamental": 60,
          "percentualDiferimento": 10,
          "valorBase": 1000,
          "valorImposto": 106,
          "valorRegular": 106,
          "valorDiferimento": 10.6
        }
      ]
    }
  ],
  "financeiros": [
    {
      "sequencia": 1,
      "tipoPagamento": 19,
      "cheque": {
        "codigoBarras": "341067330330018805201725766099",
        "banco": "341",
        "agencia": "0673",
        "conta": "576609",
        "numero": 1880,
        "nome": "José da Silva Souza",
        "cnpjCpf": "14532515955"
      },
      "cartao": {
        "bandeira": "02",
        "autorizacao": 4581596
      },
      "dataVencimento": "30/05/2024",
      "dataBaixa": "30/05/2024",
      "valorParcela": 3.38,
      "idTransacao": "dadotiuiwnlkeuhcnhlahdiwlaoaokd48ge55x"
    }
  ]
}

Changes

    • warning

      added the new 08 enum value to the //// response property for the response status

    • warning

      added the new 09 enum value to the //// response property for the response status

    • warning

      added the new cofins enum value to the ///// response property for the response status

    • warning

      added the new pis enum value to the ///// response property for the response status

    • info

      the endpoint scheme security VendasNFeBearer was added to the API

    • info

      the endpoint scheme security Bearer was removed from the API

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      removed the 8.00 enum value from the //// response property for the response status

    • info

      removed the 9.00 enum value from the //// response property for the response status