This service is used to consult the processing status of the InserirLogVendaPassagem method previously sent to ANTT in the Sending Data request.
URL
Production: POST https://antt.ns.eti.br/v1/antt/logvenda/consulta
Input Data
| Field | Occurrence | Data Type | Description |
|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | String | Software House Access Token |
| CNPJ | 1-1 | Int | CNPJ of the company approved by ANTT |
| nsNRec | 1-1 | Int | Processing code ( ID ) |
Request Example
Check Processing Status Request in JSON Format
{
"X-AUTH-TOKEN": "YOUR_TOKEN_HERE",
"CNPJ": "11111111111111",
"nsNRec": 107
}
Response Data
| Field | Occurrence | Data Type | Parent | Description |
|---|---|---|---|---|
| status | 1-1 | Int | Processing Status Code | |
| Motivo | 1-1 | String | Literal description of processing status | |
| cStat | 1-1 | Int or String | Processing Status Status Code | |
| chPassagem | 1-1 | Int or String | Ticket Sale Log Access Key | |
| idTransacao | 1-1 | String | Transaction ID of the InserirLogVendaPassagem method | |
| log_doc | 1-1 | Object | Object containing the data that were processed in the InserirLogvendaPassagem method | |
| idLog | 1-1 | Int | logEmissao | Log identifier code processed at ANTT |
| codigoBilheteEmbarque | 1-1 | Int | logEmissao | ticket identifier code boarding: 0 = Normal; 1 = Free; |
| cnpjEmpresa | 1-1 | String | logEmissao | CNPJ of the company approved by ANTT |
| numeroSerieEquipamentoFiscal | 1-1 | String | logEmissao | Equipment serial number issuing tax or key of BP-e access |
| numeroBilheteEmbarque | 1-1 | String | logEmissao | Ticket number sent. (nBP) |
| dataEmissaoBilhete | 1-1 | String | logEmissao | Date of issue of the ticket sent. UTC Standard: YYYYMMDD |
| horaEmissaoBilhete | 1-1 | String | logEmissao | Time for issuing the ticket sent. UTC Standard: HHMMSS |
| codigoCategoriaTransporte | 1-1 | Int | logEmissao | Transport Category 01 = interstate 02 = international 03 = intercity 04 = municipal |
| identificacaoLinha | 1-1 | String | logEmissao | Line identification; prefix: road [8] or itinerary; semi-urban [4], if applicable (differentiated service) |
| idPontoOrigemViagem | 1-1 | Int | logEmissao | Location of origin code of the ticket. The IBGE code of the municipality can be used |
| idPontoDestinoViagem | 1-1 | Int | logEmissao | Destination point code of ticket. The IBGE code of the municipality can be used |
| codigoTipoServico | 1-1 | Int | logEmissao | Type of service offered in transport: 01: Conventional, with toilet; 02: Conventional, without toilet; 03: Semi-picked; 04: Bed, with air conditioning; 05: Bed, without air conditioning; 06: Executive; 07: Semi-urban; |
| dataViagem | 1-1 | String | logEmissao | Ticket trip data. UTC Standard: YYYYMMDD |
| horaViagem | 1-1 | String | logEmissao | Ticket Travel Time. UTC Standard: HHMMSS |
| codigoTipoViagem | 1-1 | Int | logEmissao | Type of trip: 00: Regular; 01: extra01; 02: extra02; 03: extra03; 04: extra04; (...) NN: extraXX |
| numeroPoltrona | 1-1 | Int | logEmissao | seat number |
| plataformaEmbarque | 1-1 | String | logemissao | Boarding Platform |
| codigoMotivoDesconto | 1-1 | Int | logEmissao | Reason for discount: 01: Standard Rate – no discount; 02: Promotional Rate - Paragraph 3, art. 27 of Decree No. 2.521/98 05: Travel Ticket for the Elderly 100% - Item I, art. 40 of Law No. 10741/03; 06: Elderly Travel Ticket 50% - Item II, art. 40 of Law No. 10741/03 07: Travel Authorization - Free Pass - Art. 1 of Law No. 8.899/94; 08: Free Pass Auditors and Labor Agents - Art. 34 of the Decree No. 4,552/02; 09: Child Free - Item XVII, art. 29 of Decree No. 2,521/98; 10: Youth Travel Ticket 100% - Item I, art. 32 of Law No. 12,852/13; 11: Youth Travel Ticket 50% - Item II, art. 32 of Law No. 12,852/13; 12: Travel Authorization - Free Companion Pass - Art. 1 of Law No. 8.899/94; |
| valorTarifa | 1-1 | Int | logEmissao | Fee Value Formatting: 10.2 Min: 0.00; Max: 99999999.99 |
| percentualDesconto | 1-1 | Float | logEmissao | Percentual do desconto. Formatação: 5,2 Min: 0.00; Max: 100.00; |
| aliquotaICMS | 1-1 | Float | LogEmissao | Percentual da Alíquota do ICMS. Formatação: 5,2 Min: 0.00; Max: 100.00; |
| valorPedagio | 1-1 | Float | LogEmissao | Toll Value Formatting: 10.2 Min: 0.00; Max: 99999999.99 |
| valorTaxaEmbarque | 1-1 | Float | LogEmissao | Boarding Tax Value Formatting: 5.2 Min: 0.00; Max: 100.00; |
| valorTotal | 1-1 | Float | LogEmissao | Total Amount Formatting: 5.2 Min: 0.00; Max: 100.00; |
| informacoesPassageiro | 1-1 | Object | Object containing the passenger data that was informed in the ticket sent to be processed by the InserirLogVendaPassagemmethod | |
| nomePassageiro | 1-1 | String | informacoesPassageiro | Passenger name |
| documentoIdentificacaoPassageiro | 1-1 | String | informacoesPassageiro | Identification document of the passenger Example: "CPF" |
| cpfPassageiro | 0-1 | String | informacoesPassageiro | Passenger CPF |
| celularPassageiro | 0-1 | String | informacoesPassageiro | Passenger Telephone Number Examples: +5521915140585; 5121915140585; 21915140585; 2184340791 |
| tpAmb | 1-1 | String | Environment where the InsertLogVendaPassagem method processing was generated 1 = Production; 2 = Test Environment |
|
| xMotivo | 1-1 | String | Literal Description of "cStat" |
Response Examples
Successful Response
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"cStat": "100",
"chPassagem": "2021080736561800025500000002536000000016",
"idTransacao": "56492653-ah0b-46h5-995a-f61d8a945eaa",
"log_doc": {
"idLog": 0,
"codigoBilheteEmbarque": 1,
"cnpjEmpresa": "07364617000135",
"numeroSerieEquipamentoFiscal": "43210807364617000135630060000023521000000012",
"numeroBilheteEmbarque": "000002352",
"dataEmissaoBilhete": "20210823",
"horaEmissaoBilhete": "160600",
"codigoCategoriaTransporte": 2,
"identificacaoLinha": "00000001",
"idPontoOrigemViagem": 4314902,
"idPontoDestinoViagem": 4106902,
"codigoTipoServico": 1,
"dataViagem": "20210823",
"horaViagem": "173145",
"codigoTipoViagem": 1,
"numeroPoltrona": 1,
"plataformaEmbarque": "5",
"codigoMotivoDesconto": 1,
"valorTarifa": 50.0,
"percentualDesconto": 0.0,
"aliquotaICMS": 17.0,
"valorPedagio": 0.0,
"valorTaxaEmbarque": 10.0,
"valorTotal": 60.0,
"informacoesPassageiro": {
"nomePassageiro": "JOHN DOE",
"documentoIdentificacaoPassageiro": "CPF",
"cpfPassageiro": "00268825074",
"celularPassageiro": "51988695436"
}
},
"tpAmb": "2",
"xMotivo": "Ação executada com sucesso."
}
Unsuccessful Response
{
"status": -5,
"motivo": "Nao foi possivel carregar o status do Log de Venda de Passagem",
"erro": {
"cStat": 2,
"xMotivo": "Erro de validação de dados na ANTT"
}
}
Returned Codes
| Código | Descrição |
|---|---|
| 200 | Log submission successfully executed. |
| -2 | Request data validation error. |
| -3 | Errors in log processing after sending to Core/ANTT |
| -4 | Errors in log processing after sending to Core/ANTT |
| -5 | Errors in log processing after sending to Core/ANTT |
| -6 | Document already processed and authorized. Check the nsNRec informed of the response. |