Através deste endpoint é possível realizar o evento de Comprovação de Entrega de uma NF-e já autorizada.
Obs.: O evento de Comprovação de Entrega possui regras e prazos definidos pela Secretaria da Fazendo que devem ser considerados e respeitados. Para maiores informações clique aqui e verifique a versão mais atualizada o Manual de Orientações do Contribuinte da Sefaz.
URL
POST https://nfe.ns.eti.br/nfe/compentrega
Dados de entrada
Campos | Descrição | Ocorrência | Tipo | Observação |
---|---|---|---|---|
X-AUTH-TOKEN | Token de acesso do usuário | 0-1 | A | Poder ser enviado no cabeçalho da requisição |
chNFe | Chave de acesso da NF-e | 1-1 | N | |
tpAmb | Tipo do ambiente de autorização da NF-e | 1-1 | N | 1 - Produção 2 - Homologação |
dhEvento | Data e Hora da emissão do evento | 1-1 | D | Padrão Sefaz (com UTC) AAAA-MM-DDTHH:MM:SS TZD Ex.: 2019-08-09T15:04:10-03:00 |
nSeqEvento | Número sequencial do evento | 1-1 | N | |
verApli | Versão do aplicativo do autor do evento | 1-1 | A | |
dhEntrega | Data e Hora da conclusão entrega | 1-1 | D | Padrão Sefaz (com UTC) AAAA-MM-DDTHH:MM:SS TZD Ex.: 2019-08-09T15:04:10-03:00 |
nDoc | Documento de identificação da pessoa que recebeu a entrega | 1-1 | A | |
xNome | Nome da pessoa que recebeu a entrega | 1-1 | A | |
hashComprovante | Hash SHA-1, no formato Base64, resultante da concatenação de: Chave de Acesso da NF-e + Base64 da imagem capturada do Comprovante de Entrega da NF-e | 1-1 | A | |
dhHashComprovante | Data e Hora da geração do hash do comprovante de entrega da NF-e | 0-1 | D | Padrão Sefaz (com UTC) AAAA-MM-DDTHH:MM:SS TZD Ex.: 2019-08-09T15:04:10-03:00 |
tpAutor | Tipo do autor | 1-1 | N | 1=Empresa Emitente, 2=Empresa destinatária; 3=Empresa; 5=Fisco; 6=RFB; 9=Outros Órgãos; |
latGPS | Latitude do ponto de entrega | 0-1 | N | |
longGPS | Longitude do ponto de entrega | 0-1 | N |
Exemplo de requisição
Requisição de cancelamento de NF-e
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chNFe": "99999999999999999999999999999999999999999999",
"tpAmb": 2,
"dhEvento": "2019-08-09T19:28:30-03:00",
"nSeqEvento": "1",
"verAplic":"teste",
"dhEntrega": "2019-08-09T19:27:40-03:00",
"nDoc": "99999999999",
"xNome": "Nome de Quem Recebeu",
"hashComprovante": "NzgzNkM3QTUwRDZGNg==",
"dhHashEntrega": "2019-08-09T19:28:00-03:00",
"tpAutor":"1",
"latGPS": "-31.776000",
"longGPS": "-52.359400"
}' \
https://nfe.ns.eti.br/nfe/compentrega
Dados retornados
Campo | Descrição | Observação |
---|---|---|
status | Código de status do processamento | |
motivo | Descrição literal do status de processamento | |
retEvento | Objeto contendo os dados do processamento do evento na Sefaz | Somente em status = 200 |
retEvento.cStat | Código de situação do processamento na Sefaz | |
retEvento.xMotivo | Descrição literal da situação de processamento na Sefaz | |
retEvento.chNFe | Chafe de acesso da NF-e | |
retEvento.dhRegEvento | Data e hora de registro do evento na Sefaz | Padrão Sefaz (com UTC): AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2019-08-09T15:04:10-03:00 |
retEvento.nProt | Número de recibo do documento pela Sefaz | |
xml | XML de distribuição do evento de comprovante de entrega | |
erro | Array contendo a lista de erros ocorridos durante a validação das informações do comprovante de acordo com o tipo de dados | |
erro.cStat | Código do erro ocorrido | |
erro.xMotivo | Descrição literal do erro ocorrido |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Comprovação de Entrega vinculada a NF-e com sucesso",
"retEvento": {
"cStat": 135,
"xMotivo": "Evento registrado e vinculado a NF-e",
"chNFe": "99999999999999999999999999999999999999999999",
"dhRegEvento": "2019-08-09T19:41:09-03:00","nProt": "999999999999999"
},
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoNFe versao...."}
Códigos de retorno
Código | Descrição |
---|---|
200 | Comprovante de Entrega vinculado a NF-e com sucesso |
-2 | Campos obrigatórios não informados na requisição |
-3 | Chave de acesso inválida |
-4 | Erro de informações de acordo com o tipo de dados |