Through the NF3-e status consult service, it’s possile to obtain information of the NF3-e current status at Sefaz database.
This functionality is widely used in cases where it’s necessary to verify the existence and validity of an NF3-e, as well as to obtain information about events that occurred with it (e.g.: Cancellation).
URL
Production: POST https://nf3e.ns.eti.br/v1/nf3e/status
Input Data
| Field | Description | Data Type | Occurrence | Notes |
|---|---|---|---|---|
| X-AUTH-TOKEN | User access token | String | 0-1 | |
| licencaCnpj | CNPJ of the license interested in consulting the status of the NF3-e | Int | 0-1 | Used to identify the digital certificate to be used. If not sent, the CNPJ will be extracted from the key sent in the chNF3e field |
| chNF3e | NF3-e access key | Int | 1-1 | |
| tpAmb | NF3-e authorization environment type | Int | 1-1 | 1 - Production, 2 - Homologation |
Request Example
Consult status request
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "YOUR_TOKEN", "licencaCnpj": "11111111111111", "chNF3e": "11111111111111111111111111111111111111111111", "tpAmb": "2"}'\
https://nf3e.ns.eti.br/v1/nf3e/status
Returned Data
| Field | Description | Occurrence | Data Type | Parent | Notes |
|---|---|---|---|---|---|
| status | Processing status code | 1-1 | Int | ||
| motivo | Literal description of the processing status | 1-1 | String | ||
| retConsSitNF3e | Object containing the NF3-e authorization protocol data and all linked events | 0-1 | Object | Only when status = 200 | |
| erro | Object containing error data that occurred during processing | 0-1 | Object | Onlye when status is different from 200 | |
| cStat | Error status code | 1-1 | Int | erro | |
| xMotivo | Error literal description | 1-1 | String | erro |
Response Examples
Successful response
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retConsSitNF3e": {
"tpAmb": "2",
"verAplic": "RS20191028094248",
"cStat": "101",
"xMotivo": "Cancelamento de NF3e homologado ",
"cUF": "43",
"protNF3e": {
"infProt": {
"Id": "NF3e143190000000010",
"tpAmb": "2",
"verAplic": "RS20191028094235",
"chNF3e": "11111111111111111111111111111111111111111111",
"dhRecbto": "2019-12-06T15:56:29-03:00",
"nProt": "143190000000010",
"digVal": "tWkjZX1gzoQenHclxF5J5XxhClE=",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF3e "
},
"versao": "1.00"
},
"versao": "1.00"
}
}
Return Codes
| Code | Description |
|---|---|
| 200 | Consultation carried out successfully |
| -400 | NF3-e key or tpAmb nor informed |
| -3 | Invalid access key |
| -6 | Error on carrying out the consultation. Verify the "erro" object to identify the reason |