InserirLogVendaPassagem
O método InserirLogVendaPassagem é responsável por realizar o envio dos dados para a ANTT realizando a inclusão da passagem vendida no determinado período. Deve ser enviado de acordo com os tipos de dados definidos pelos schemas XMLs da ANTT e realizar o envio do documento para processamento no WebService da ANTT
O retorno deste serviço contém o status do processamento deste método da ANTT pela API e o código nsNRec para consulta de status de processamento.
URL
Produção: POST https://antt.ns.eti.br/v1/antt/logvenda
Dados de entrada
Os dados para envio do método devem ser enviados em JSON.
Envio de dados em formato JSON
Para envio dos dados em JSON o Content-Type da requisição deverá ser definido como application/json.
| Campo | Ocorrência | Tipo | Pai | Descrição |
|---|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | String | Token de acesso do usuário Pode ser enviado também via Header ou QueryString na URL. |
|
| chBPe | 1-1 | String | Chave de Acesso do BPe Autorizado anteriormente através da NS API BPe | |
| tpAmb | 1-1 | String | Tipo de ambiente para processamento do método InserirLogVendaPassagem 1 - Produção 2 - Homologação *Valor padrão: 2 |
|
| logEmissao | 1-1 | O | Objeto contendo os dados a serem enviados para o método | |
| codigoBilheteEmbarque | 1-1 | Int | logEmissao | Código identificador do bilhete de embarque: 0 = Normal; 1 = Gratuidade; 2 = Desconto Previsto em Lei; |
| codigoCategoriaTransporte | 1-1 | Int | logEmissao | Categoria do Transporte 1 = Interestadual; 2 = Internacional |
| identificacaoLinha | 1-1 | String | logEmissao | Identificação da linha; prefixo: (Rodoviário Regular) [8], [11] ou [12] |
| codigoTipoServico | 1-1 | Int | logEmissao | Tipo de serviço oferecido no transporte: 1 - A (Cama) 2 - B (Leito) 3 - C (Semileito) 4 - D (Executiva) 5 - E (Básica) |
| dataViagem | 1-1 | String | logEmissao | Data de viagem do bilhete. Padrão UTC: AAAAMMDD |
| horaViagem | 1-1 | String | logEmissao | Horário da Viagem do bilhete. Padrão UTC: HHMMSS |
| codigoTipoViagem | 1-1 | Int | logEmissao | Tipo de viagem: 0 - Não Atende à Regularidade/Frequência Mínima 1 - Atende à Regularidade/Frequência Mínima |
| numeroPoltrona | 1-1 | Int | logEmissao | Número da poltrona |
| plataformaEmbarque | 0-1 | String | logEmissao | Codigo ou identificação numérica da plataforma de Embarque |
| codigoMotivoDesconto | 1-1 | Int | logEmissao | Motivo do desconto: 0 - Tarifa/Preço Normal (sem desconto) 1 - Tarifa/Preço Promocional 2 - Pessoa Idosa (gratuidade) 3 - Pessoa Idosa (desconto mínimo de 50%) 4 - Titular da Credencial de Passe Livre 5 - Acompanhante do Titular da Credencial de Passe Livre 6 - Jovem (gratuidade) 7 - Jovem (desconto mínimo de 50%) 8 - Criança de Colo (até 6 anos incompletos) 9 - Auditor ou Agente do Trabalho |
| 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; |
| origemEmissao | 1-1 | int | logEmissao | Origem / Forma de emissão do bilhete adquirido pelo passageiro: 1 = Presencial; 2 = Embarcada; 3 = Internet; 4 = Terminal de autoatendimento (totem); |
| sequenciamento | 1-1 | Int | logEmissao | Código sequencial de ordenação Min: 0; Max: 99 |
| idViagem | 1-1 | String | logEmissao | Código Identificador da Viagem (Rodoviário Regular) Informações na sequência apresentada e separadas por hífen. Abaixo, a explicação de cada item que deverá ser incluído no idViagem. Data Programada da Viagem no ponto inicial da linha: AAAAMMDD Hora Programada da Viagem no ponto inicial da linha: HHMMSS Código Tipo de Viagem: NN 00 = Não atende à Regularidade Mínima; 01 = Atende à Regularidade Mínima Código Sentido da Linha: 0 = Volta; 1 = Ida Prefixo da Linha SGP/SIGMA: 8, 11 ou 12 caracteres Exemplo requisição: AAAAMMDD-HHMMSS-NN-N-PPPPPPPPPPPP |
Exemplo de requisição
Requisição de Envio de Dados em JSON
{
"X-AUTH-TOKEN":"SEU_TOKEN_AQUI",
"chBPe":"43230407364617000135630060000028941000000019",
"tpAmb": "2",
"logEmissao": {
"cnpjEmpresa": "07364617000135",
"idPontoOrigemViagem": "4314915",
"idPontoDestinoViagem": "4106910",
"codigoBilheteEmbarque": 1,
"codigoCategoriaTransporte": "2",
"identificacaoLinha": "2",
"codigoTipoServico": 1,
"dataViagem": "20230419",
"horaViagem": "140000",
"codigoTipoViagem": 1,
"numeroPoltrona": "1",
"plataformaEmbarque": "5",
"codigoMotivoDesconto": 1,
"percentualDesconto": 0.0,
"aliquotaICMS": 17.0,
"sequenciamento": 0,
"idViagem": "20240620-174900-01-1-123456789101"
}
}
Dados retornados
| Campo | Descrição | Tipo | Ocorrência | Observação |
|---|---|---|---|---|
| Status | Código de status do processamento | N | 1-1 | |
| Motivo | Descrição literal do status de processamento | A | 1-1 | |
| nsNRec | ID do Processamento do método InserirLogVendaPassagem | N | 0-1 | Somente em status = 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Log enviado para a ANTT",
"nsNRec": "112"
}
Retorno com erro
{
"status": -6,
"motivo": "Documento ja processado anteriormente e autorizado",
"nsNRec": "110"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Envio do log executado com sucesso. |
| -2 | Erro de validação de dados enviados. |
| -3 | Erros no processamento do log após enviar para o Core/ANTT |
| -4 | Erros no processamento do log após enviar para o Core/ANTT |
| -5 | Erros no processamento do log após enviar para o Core/ANTT |
| -6 | Documento ja processado anteriormente e autorizado. Consulta o nsNRec informado da resposta. |