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; |
codigoCategoriaTransporte | 1-1 | Int | logEmissao | Categoria do Transporte 01 = interestadual 02 = internacional 03 = intermunicipal 04 = municipal |
identificacaoLinha | 1-1 | String | logEmissao | Identificação da linha; prefixo: rodoviário [8] ou itinerário; semiurbano [4], se aplicável (serviço diferenciado) |
codigoTipoServico | 1-1 | Int | logEmissao | Tipo de serviço oferecido no transporte: 01: Convencional, com sanitário; 02: Convencional, sem sanitário; 03: Semileito; 04: Leito, com ar condicionado; 05: Leito, sem ar condicionado; 06: Executivo; 07: Semiurbano; |
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: 00: Rgular; 01: extra01; 02: extra02; 03: extra03; 04: extra04; ( ... ) NN: extraXX |
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: 01: Tarifa Normal – sem desconto; 02: Tarifa Promocional - Parágrafo 3º, art. 27 do Decreto nº 2.521/98 05: Bilhete de Viagem do Idoso 100% - Inciso I, art. 40 da Lei nº 10.741/03; 06: Bilhete de Viagem do Idoso 50% - Inciso II, art. 40 da Lei nº 10.741/03 07: Autorização de Viagem - Passe Livre – Art. 1º da Lei nº 8.899/94; 08: Passe Livre Auditores e Agentes do Trabalho - Art. 34 do Decreto nº 4.552/02; 09: Gratuidade de Criança - Inciso XVII, art. 29 do Decreto nº 2.521/98; 10: Bilhete de Viagem do Jovem 100% - Inciso I, art. 32 da Lei nº 12.852/13; 11: Bilhete de Viagem do Jovem 50% - Inciso II, art. 32 da Lei nº 12.852/13; 12: Autorização de Viagem - Passe Livre Acompanhante – Art. 1º da Lei nº 8.899/94; |
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; |
Exemplo de requisição
Requisição de Envio de Dados em JSON
{
"X-AUTH-TOKEN":"SEU_TOKEN_AQUI",
"chBPe":"432108065998843000126630060000023521000000012",
"tpAmb": 2,
"logEmissao": {
"codigoBilheteEmbarque": 1,
"codigoCategoriaTransporte": "02",
"identificacaoLinha": "1",
"codigoTipoServico": 1,
"dataViagem": "20210823",
"horaViagem": "173145",
"codigoTipoViagem": 1,
"numeroPoltrona": "1",
"plataformaEmbarque": "5",
"codigoMotivoDesconto": 1,
"percentualDesconto": 0.0,
"aliquotaICMS": 17.0
}
}
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. |