O método de download é responsável por retornar o XML de distribuição da NFCom a partir do fornecimento da chave de acesso de uma NFCom autorizada pela API.
URL
Produção: POST https://nfcom.ns.eti.br/nfcom/get
Dados de entrada
| Campo | Ocorrência | Tipo | Descrição |
|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | A | Token de acesso do usuário |
| chNFCom | 1-1 | N | Chave de acesso da NFCom |
| tpDown | 1-1 | N | Tipo do download: X - XML |
| tpAmb | 0-1 | N | Tipo de ambiente de autorização da NFCom 1 - Produção 2 - Homologação Valor padrão: 2 |
Exemplo de requisição
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN"
"chNFCom": "43240107364617000135620000000000011000000016",
"tpDown": "X",
"tpAmb": "2"
}' \
https://nfcom.ns.eti.br/nfcom/get
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| chNFCom | Chave da NFCom | |
| xml | XML de distribuição da NFCom autorizada | Somente em quando tipo = X Apenas com status = 200 |
| erro | Objeto contendo informações de erro ao carregar a NFCom | Apenas com status diferente de 200 |
| erro.cStat | Código do status de erro | |
| erro.xMotivo | Descrição literal do erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chNFCom": "43240107364617000135620000000000111000000012",
"xml": "xml"
}
Retorno com erro
{
"status": -2,
"motivo": "Tipo de download inválido: L"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Download realizado com sucesso |
| -2 | Tipo de download inválido |
| -3 | Chave de acesso inválida |
| -4 | NFCom nao encontrada ou nao autorizada com a chave informada |