This service is used to check the processing status of an NF3-e previously sent for processing using the NF3-e Issuance Method.
URL
Production: POST https://nf3e.ns.eti.br/v1/nf3e/issue/status
Input Data
Field | Occurrence | Data Type | Parent | Description |
---|---|---|---|---|
X-AUTH-TOKEN | 1-1 | String | Software house access token | |
CNPJ | 1-1 | Int | CNPJ of the NF3-e issuer | |
nsNRec | 1-1 | Int | Receipt log number of the issue process |
Request Example
Check processing status request
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN":"YOUR_TOKEN", "CNPJ": "11111111111111", "nsNRec": 1}' \
https://nf3e.ns.eti.br/v1/nf3e/issue/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 | ||
chNF3e | NF3-e access key | 1-1 | Int | ||
cStat | NF3-e processing status code at Sefaz | 0-1 | Int | Only when status = 200 | |
xMotivo | Literal description of the NF3-e processing status code at Sefaz | 0-1 | String | Only when status = 200 | |
nProt | NF3-e authorization protocol number at Sefaz | 0-1 | Int | Only when cStat = 100 | |
dhRecbto | Date and time of receipt of NF3-e by Sefaz | 0-1 | Date | Only when status = 200 | |
consultarNSNRec | nsNRec of the same document authorized or pending consultation | 0-1 | Int | This field can appear when status = 200 and cStat = 539, if we have an nsNRec pending consultation or from the same authorized document. If you receive this field, check the processing status again with its value | |
xml | NF3-e distribution XML | 0-1 | String | Only when cStat = 100 | |
erro | Object containing error information in case the request cannot be carried out successfully | 0-1 | Object | Only when status is different from 200 |
Error Object Details
Field | Description | Occurrence | Data Type | Parent |
---|---|---|---|---|
cStat | Error status code | 1-1 | Int | |
xMotivo | Literal description of the error | 1-1 | String |
Response Examples
Successful response
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chNF3e": "43191207364617000135660000000000101834241950",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF3e ",
"nProt": "143190000000010",
"dhRecbto": "2019-12-06T15:56:29-03:00",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><nf3eProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nf3e\"><NF3e><infNF3e versao=\"1.00\" Id=\"NF3e43191207364617000135660000000000101834241950\">...</nf3eProc>"
}
Response with an error
{
"status": -2,
"motivo": "Nao foi possivel carregar o status da NF3-e",
"erro": {
"cStat": 0,
"xMotivo": "Documento não localizado em nosso banco de dados"
}
}
Return Codes
Code | Description |
---|---|
200 | Consultation made successfully |
-2 | It was not possible to load the processing status of the NF3-e. Check the "erro" object for more information |