SAsankhya
Vendas NF-e

Consultar Notas de Retorno

Changed on

Retorna lista paginada de Notas Fiscais modelo 55 com CFOPs de retorno/devolução (CONFAZ AJ003/22).

get/v1/vendas/nfe/retornos

Request

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

Query parameters

pageinteger required
Example:1

Número da página desejada.

modifiedSincestring date-time
Example:2025-01-28T16:24:00Z

Retorna apenas registros alterados após esta data/hora (YYYY-MM-DDTHH:MM:SS).

dataNegociacaoIniciostring required
Example:10-02-2025

Data inicial obrigatória no formato DD-MM-YYYY.

dataNegociacaoFinalstring required
Example:20-02-2025

Data final obrigatória no formato DD-MM-YYYY.

codigoEmpresainteger required
Example:1

Código da Empresa.

numeroNotainteger
Example:254100

Número da Nota Fiscal (NUMNOTA).

codigoClienteinteger

Código do Cliente (Parceiro).

statusNFe1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
Example:1

Status da NF-e. Valores possíveis:

  • 1 — Aprovada: autorização confirmada pela SEFAZ.
  • 2 — Denegada: nota negada pela SEFAZ (contribuinte irregular).
  • 3 — Aguardando Autorização: lote enviado, aguardando resposta da SEFAZ.
  • 4 — Enviada: transmitida à SEFAZ, sem retorno processado ainda.
  • 5 — Não é NF-e: documento não eletrônico (nota em papel/manual).
  • 6 — Pendente de Retorno: retorno da SEFAZ ainda não consultado.
  • 7 — Aguardando Correção: nota com inconsistências aguardando ajuste.
  • 8 — Enviada EPEC: transmitida via EPEC (contingência offline).
  • 9 — NF-e de Terceiro: nota emitida por terceiros e recebida pelo Sankhya.
  • 10 — Com Erro de Validação: rejeitada por erro de schema/regra de negócio.
codigoNaturezainteger
Example:30100

Código da Natureza (CODNAT).

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",
        "telefoneNumero": "34912349966",
        "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": "2024-06-15T14:45:30Z",
      "numeroNota": 254100,
      "codigoNota": 12540,
      "serieNota": "1",
      "codigoTipoNegociacao": 110,
      "nomeTipoNegociacao": "Venda de Mercadoria Nacional",
      "codigoTipoOperacao": 1200,
      "nomeTipoOperacao": "Retorno de Venda Estadual",
      "codigoNatureza": 30100,
      "nomeNatureza": "Retorno de Venda",
      "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": "15-07-2024",
      "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": "1",
      "numeroProtocoloNFe": "135240008899774",
      "dataProtocoloNFe": "2024-06-15T10:30:00Z",
      "numeroAleatorioNFe": "98765432",
      "loteNFe": "20240055",
      "numeroRegistroDPEC": "998877",
      "dataRegEPEC": "2024-06-15T09:00:00Z",
      "xmlNFe": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4...",
      "reformaTributaria": {
        "valorTotalImposto": 1325,
        "valorIBSUF": 662.5,
        "valorIBSMunicipio": 150,
        "valorBaseCalculo": 5000,
        "valorTotalDocumento": 6325
      }
    }
  ]
}

Changes