Vendas NF-e
Consultar Notas de Remessa
Changed onRetorna lista paginada de Notas Fiscais modelo 55 com CFOPs de remessa (CONFAZ AJ003/22).
get/v1/vendas/nfe/remessas
Request
- Base URLhttps://api.sankhya.com.br
- URLhttps://api.sankhya.com.br/v1/vendas/nfe/remessas
- AuthAPI 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:28-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": "PJ",
"cnpjCpf": "12345678000195",
"ieRg": "123456789012",
"nome": "Empresa Cliente LTDA",
"razao": "Empresa Cliente Comércio LTDA",
"email": "contato@empresa.com.br",
"telefoneNumero": "1130000000",
"endereco": {
"entrega": true,
"nomeContato": "Maria Santos",
"email": "maria.santos@empresa.com.br",
"logradouro": "Rua das Flores, 123",
"numero": "123",
"complemento": "Apto 400",
"bairro": "Centro",
"cidade": "São Paulo",
"codigoIbge": 3550308,
"uf": "SP",
"cep": "01234-567"
}
},
"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": "Remessa Estadual de Mercadoria",
"codigoNatureza": 30100,
"nomeNatureza": "Remessa de Mercadoria",
"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": 15000,
"descontoTotal": 500,
"valorSeguro": 50,
"valorEmbalagem": 100,
"valorFrete": 200,
"vencimentoFrete": "20-06-2024",
"codigoOrdemCarga": 8001,
"codigoVeiculo": 5001,
"placaVeiculo": "ABC-1234",
"codigoMotorista": 3001,
"nomeMotorista": "Carlos Souza",
"codigoTransportadora": 4001,
"nomeTransportadora": "Transportadora X",
"codigoRemetente": 1500,
"nomeRemetente": "Matriz Origem",
"codigoDestinatario": 1600,
"nomeDestinatario": "Filial Destino",
"quantidadeVolumes": 10,
"numeracaoVolumes": "V001 até V010",
"lacres": "L001, L002, L003",
"pesoBruto": 250.5,
"cifFob": 1,
"tipoFrete": 1,
"baseICMSFrete": 200,
"icmsFrete": 24,
"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": 175,
"valorIBSUF": 25,
"valorIBSMunicipio": 10,
"valorImpostoSeletivo": 5,
"valorBaseCalculo": 500,
"valorTotalDocumento": 15175
}
}
]
}Changes
- info
endpoint added
- info