v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Vendas NF-e

Consultar Cabeçalho de Notas Fiscais (Modelo 55)

Retorna uma lista paginada apenas com os dados principais (cabeçalho) das Notas Fiscais modelo 55. Utiliza o formato padrão com descrições e objeto cliente.

get/v1/vendas/nfe

Query parameters

pageinteger required

Example:1

Informe neste atributo a "página" desejada

modifiedSincestring

Example:2025-01-28T16:24:00

Data hora da ultima modificação. Quando este parametro é enviado, o serviço retorana apenas registros que tiveram modificação deste da data/hora enviada. Vale ressaltar que este recurso é condicionada a utilização do Log de Alterações no SankhyaOm no ambiente do cliente. O formato deve ser o seguinte: AAAA-MM-DDTHH:MM:SS

codigoEmpresainteger required

Example:1

Código da Empresa (Escopo Obrigatório)

codigoNotainteger

Example:12540

Código Interno da Nota (NUNOTA).

numeroNotainteger

Example:254100

Número da Nota Fiscal (NUMNOTA).

serieNotastring

Example:1

Série da Nota

dataNegociacaoIniciostring

Example:10/02/2025

Data inicial (dd/mm/aaaa)

dataNegociacaoFinalstring

Example:20/02/2025

Data final (dd/mm/aaaa)

codigoClienteinteger

Código do Cliente (Parceiro)

confirmadaboolean

Example:true

Nota Confirmada?

pendenteboolean

Nota Pendente?

statusNFe1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Example:5

Status da NF-e (Enum numérico)

statusWMS1 | 2 | 3 | 4 | 5 | 6

Example:2

Status WMS

situacaoWMS1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22

Example:17

Situação WMS

statusConferencia1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Example:6

Status Conferência

codigoNaturezainteger

Example:30100

Código da Natureza (CODNAT)

codigoCentroResultadointeger

Example:202

Código do CR

codigoProjetointeger

Código do Projeto

codigoContratointeger

Example:159

Código do Contrato

codigoOrdemCargainteger

Example:55412

Código da Ordem de Carga

Response

Sucesso.

Example response

{
  "metadados": {
    "paginaAtual": 1,
    "totalPaginas": 12,
    "totalRegistros": 580,
    "possuiMaisPaginas": true
  },
  "registros": [
    {
      "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
      }
    }
  ]
}