Through this service it’s possible to obtain the distribution XML e an graphical representation in PDF of a disablement previously authorized thorugh the Disable Numeration method.
URL
POST or GET https://nfe.ns.eti.br/nfe/get/inut
Consuming the service via GET, the input data must be sent via QueryString. E.g.: https://nfe.ns.eti.br/nfe/get/inut?X-AUTH-TOKEN=YOUR_TOKEN&chave=99999999999999999999999999999999999999999&tpDown=x
Input data
| Field | Description | Occurrence | Data Type | Notes |
|---|---|---|---|---|
| X-AUTH-TOKEN | User access token | 0-1 | String | |
| chave | Disablement key | 1-1 | Int | Information from the Id attribute of the infInut tag without the literal ID at the beginning. |
| tpAmb | NF-e authorization environment type | 0-1 | Int | 1 - Production 2 - Homologation Standard value: 2 |
| tpDown | Download type: X - XML P - PDF XP - XML or PDF | 0-1 | String | Startard value: X |
Request example
Download event request
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "YOUR_TOKEN",
"chave": "99999999999999999999999999999999999999999",
"tpDown": "p"
}'\
https://nfe.ns.eti.br/nfe/get/inut
Returned data
| Field | Description | Occurrence | Data Type | Parent | Notes |
|---|---|---|---|---|---|
| status | Processing status code | 1-1 | Int | ||
| motivo | Processing status literal description | 1-1 | String | ||
| retInut | Object containing the disablement processing data at Sefaz | 0-1 | Object | Only when status = 200 | |
| cStat | Disablement situation code at Sefaz | 1-1 | Int | retInut | |
| xMotivo | Event situation code literal description at Sefaz | 1-1 | String | retInut | |
| chave | Disablement key | 1-1 | Int | retInut | |
| tpAmb | Environment type | retInut | 1 = Production 2 = Homologation |
||
| dhRecebto | Date and time of receipt registration of the disablement at Sefaz | 1-1 | Date | retInut | Sefaz Standard: YYYY-MM-DDTHH:MM:SS+UTC. E.g.: 2016-06-13T15:04:10-02:00 |
| nProt | Sefaz disablement authorization protocol number | 1-1 | Int | retInut | |
| xml | Event XML | 0-1 | String | retInut | Only when tpDown = X or XP. Only when status = 200 |
| Event graphical representation in PDF | 0-1 | String | retInut | Base64 PDF. Only when tpDown = P or XP. Only when status = 200 | |
| erro | Object containing error information in case the donwload could not be carried out successfully | 0-1 | Object | Only when status is different from 200 | |
| erro.cStat | Error status code | 1-1 | Int | erro | |
| erro.xMotivo | Error literal description | 1-1 | String | erro |
Return example
Successful return
{
"status": 200,
"motivo": "Evento localizado com sucesso",
"retInut": {
"cStat": "102",
"xMotivo": "Inutilizacao de numero homologado",
"chave": "99999999999999999999999999999999999999999",
"tpAmb": 2,
"dhRecbto": "2016-11-29T19:15:42-02:00",
"nProt": "143160001512981",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><ProcInutNFe versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</ProcInutNFe>"
}
}
Return codes
| Code | Description |
|---|---|
| 200 | Disablement located successfully |
| -2 | Invalid download type |
| -3 | Not possible to carry out the disablement. Check the "erro" object for more information |