Campo |
Descrição |
Obrigatório |
idRequisicao |
Este atributo identifica a requisição de autorização unicamente, não podendo assumir um mesmo valor na mesma data. O intervalo de valores que este atributo pode assumir varia entre 1 e 999.999. |
Sim |
dataRequisicao |
Este elemento identifica a data na qual a requisição foi processada. O formato deste campo é dd/mm/aaaa hh:MM:ss, onde: - dd: dia; - mm: mês; - aaaa: ano; - hh: horas; - MM: minutos; - ss: segundos |
Não |
cnpjremetente |
Este elemento identifica o CNPJ do remetente da requisição. O valor deste campo será informado pelos 14 dígitos que compõem o CNPJ, sem qualquer pontuação |
Não |
Cnpjdestinatario |
Este elemento identifica o CNPJ do destinatário da requisição. O valor deste campo será informado pelos 14 dígitos que compõem o CNPJ, sem qualquer pontuação. |
Não |
ufDestinatario |
Este elemento identifica a UF do destinatário da requisição. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Não |
codAutorizacao |
Este elemento identifica o código de autorização concedido para a requisição. O valor deste campo será um identificador numérico formado por até 20 dígitos. |
Não¹ |
mensagemRetorno |
Este elemento identifica a mensagem de erro retornada para uma solicitação de autorização. |
Não¹ |
Campo |
Descrição |
Opcional |
código |
Este elemento identifica o código associado ao erro, caso exista. |
Sim |
Mensagem |
Este elemento identifica a mensagem associada ao erro. |
Não |
Campo |
Descrição |
Opcional |
idRequisicao |
Este atributo identifica a requisição de autorização unicamente, não podendo assumir um mesmo valor na mesma data. O intervalo de valores que este atributo pode assumir varia entre 1 e 999.999 |
Não |
cnpjRemetente |
Este elemento identifica o CNPJ do remetente da requisição. O Valor deste campo será informado pelos 14 dígitos que compõem o CNPJ, sem qualquer pontuação. |
Não |
CnpjDestinatario |
< Este elemento identifica o CNPJ do destinatário da requisição. O valor deste campo será informado pelos 14 dígitos que compõem o CNPJ, sem qualquer pontuação. |
Não |
RazaoSocialDestinatario |
Este elemento identifica a razão social do destinatário da requisição. |
Não |
UfDestinatario |
Este elemento identifica a UF do destinatário da requisição. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Não |
CodAutorizacao |
Este elemento identifica o código de autorização concedido para a requisição. O valor deste campo será um identificador numérico formado por até 20 dígitos. |
Sim² |
2 - O campo codAutorizacao somente será obrigatório no caso de complementação dos dados da Nota Fiscal para uma autorização solicitada anteriormente.
Volume |
Este elemento identifica o volume "seta" a ser autorizado. O valor deste campo deverá ser informado desprezando-se os valores centesimais e sem qualquer pontuação. |
Não |
CodUnidadeMedida |
O código da unidade de medida do volume identificado no campo anterior. Os possíveis códigos aceitos por este campo são: - 1: litros. |
Não |
TipoCombustibel |
Este elemento identifica o tipo de combustível da transação. O valor deste campo será um dos seguintes códigos NCM: - 2007.20.02: álcool anidro; - 2007.20.10: álcool hidratado; - 2208.90.00: outros |
Não |
Diferimento |
Este elemento indicará se a operação está sendo realizada com o diferimento do imposto ou não. O valor deste campo será: - S: operação realizada com diferimento do imposto; - N: operação realizada sem diferimento do imposto |
Não |
Numero |
Este elemento identifica o número da nota fiscal associada a esta operação. O intervalo de valores que este campo pode assumir varia entre 1 e 999.999.999, devendo ser informado sem qualquer pontuação. |
Não³ |
Serie |
Este elemento identifica a série da nota fiscal associada a esta operação. |
Sim |
DataEmissão |
Este elemento identifica a data na qual a nota fiscal foi emitida. O formato deste campo será ddmmaaaa, onde: - dd: dia; - mm: mês; - aaaa: ano; |
Não³ |
VolumeNF |
Este elemento identifica o volume da mercadoria medido a 20ºC no caminhão. O valor deste campo deverá ser informado desprezando-se os valores centesimais e sem qualquer pontuação. |
Não³ |
3 - Caso seja uma transmissão completa estes campos deverão estar preenchidos. Para transmissões parciais o campo referente aos dados da nota fiscal - dadosNF - poderá ser omitido, devendo ser transmitido posteriormente com o campo codAutorizacao contendo o valor do respectivo código de autorização concedido previamente.
Valor |
Este elemento identifica o valor da operação, conforme descrito na nota fiscal. O formato deste campo será o valor da operação incluindo os centavos, caso existam, separados por vírgula. |
Não³ |
Campo |
Descrição |
Opcional |
CodAutorizacao |
Este elemento identifica o código associado ao erro, caso exista. |
Não |
CpfCnpj |
Este elemento identifica o CPF/CNPJ do remetente da requisição, seja transportador autônomo ou empresa. O valor deste campo será informado pelos 11 dígitos que compõem o CPF ou pelo 14 dígitos que compõem o CNPJ, sem qualquer pontuação. |
Não |
Tranporta-xNome |
Este elemento identifica o nome do transportador autônomo ou razão social da empresa que irá realizar o transporte. |
Não |
Uf |
Este elemento identifica a UF da empresa/transportador autônomo que irá realizar o transporte da mercadoria. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Não |
Cpf |
Este elemento identifica o CPF do motorista do veículo. O valor deste campo será informado pelos 11 dígitos que compõem o CPF sem qualquer pontuação. |
Não |
Motorista-xNome |
Este elemento identifica o nome do motorista do veículo. |
Não |
PlacaPrincipal |
Este elemento identifica a placa principal do veículo utilizado para o transporte. O formato deste campo será CCCNNNN ou CCNNNN, onde: - C: é uma letra maiúscula; - N: é um número. |
Não |
UfPlacaPrincipal |
Este elemento identifica a UF da placa principal do veículo utilizado para o transporte. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Não |
PlacaSecundaria |
Este elemento identifica a placa secundária do veículo utilidazo para o transporte. O formato deste campo será CCCNNNN ou CCNNNN, onde: - C: é uma letra maiúscula; - N: é um número. |
Sim |
UfPlacaSecundaria |
Este elemento identifica a UF da placa secundária do veículo utilizado para o transporte. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Sim |
PlacaTerceira |
Este elemento identifica a placa terceira do veículo utilizado para o transporte. O formato deste campo será CCCNNNN ou CCNNNN, onde: - C: é uma letra maiúscula; - N: é um número. |
Sim |
UfPlacaTerceira |
Este elemento identifica a UF da placa terceira do veículo utilizado para o transporte. Este campo poderá assumir os seguintes valores: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Sim |
Estrutura do arquivo XML de Entrada
xmlns
|
Este atributo identifica o schema associado ao arquivo XML. O valor deste campo é xsdReauisicao. |
Sim |
idRequisicao
|
Este atributo identifica a requisição de autorização unicamente, não podendo assumir um mesmo valor na mesma data (dd/mm/aaaa). O intervalo de valores que este atributo pode assumir varia entre 1 e 999.999. |
Sim |
dataRequisicao
|
Este elemento identifica a data na qual a requisição está sendo feita (data atual). Oformato deste campo é aaaammddhhMM, onde: - aaaa: ano; - mm: mês; - dd: dia; - hh: horas; - MM: minutos. |
Sim |
remetente
|
Este elemento identifica o CNPJ do remetente da requisição. O valor deste campo deve ser informado sem pontuação, apenas os 14 dígitos que compõem o CNPJ. |
Sim |
destinatario
|
Este elemento identifica o CNPJ do destinatário da requisição. O valor deste campo deve ser informado sem pontuação, apenas os 14 dígitos que compõem o CNPJ. |
Sim |
ufDestinatario
|
Este elemento identifica a UF na qual o destinatário da requisição está localizado. Os possíveis valores para este campo são: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Sim |
codAutorizacao
|
Este elemento identifica o Código de Autorização, recebido previamente, ao quais as informações da nota fiscal estão associadas. O valor deste campo é um número formado por 1 a 20 dígitos. |
Não* |
volume
|
Este elemento identifica o volume "seta" a ser autorizado. O valor deste campo deverá ser informado desprezando-se os valores centesimais e sem qualquer pontuação. |
Sim |
numero
|
Este elemento identifica o número da nota fiscal associada a esta operação. O intervalo de valores que este campo pode assumir varia entre 1 e 999.999.999, devendo ser informado sem qualquer pontuação. |
Não* |
serie |
Este elemento identifica a série da nota fiscal associada a esta operação |
Não* |
DataEmissao |
Este elemento identifica a data na qual a nota fiscal foi emitida. O formato deste campo é aaaammdd, onde: - aaaa: ano; - mm: mês; - dd: dia; |
Não* |
VolumeNF |
Este elemento identifica o volume do produto medido a 20º C no caminhão. O valor deste campo deverá ser informado desprezando-se os valores centesimais e sem qualquer pontuação. |
Não* |
valor |
Este elemento identifica o valor da operação conforme descrito na nota fiscal. O formato deste campo será o valor da operação sem qualquer pontuação, desprezados os centavos caso existam. |
Não* |
* No caso da transmissão posterior dos dados da nota fiscal, os campos codAutorização, numero, serie, dataEmissão, volumeNF e valor deverão estar necessariamente preenchidos para a complementação.
Estrutura do arquivo XML de Retorno
O arquivo XML de Retorno possui as informações que serão retornadas após o processamento de cada requisição.
Campo |
Descrição |
Obrigatório |
||
xmlns
|
Este atributo identifica o schema associado ao arquivo XML. O valor deste campo é xsdAutorizacao. |
Sim |
||
idRequisicao
|
Este atributo identifica a requisição de autorização unicamente, não podendo assumir um mesmo valor na mesma data (dd/mm/aaaa). O intervalo de valores que este atributo pode assumir varia entre 1 e 999.999. |
Sim |
||
dataRequisicao
|
Este elemento identifica a data na qual a requisição está sendo feita (data atual). O formato deste campo é aaaammddhhMM, onde: - aaaa: ano; - mm: mês; - dd: dia; - hh: horas; - MM: minutos. |
Sim |
||
remetente
|
Este elemento identifica o CNPJ do remetente da requisição. O valor deste campo deve ser informado sem pontuação, apenas os 14 dígitos aue comoõem o CNPJ. |
Sim |
||
destinatario
|
Este elemento identifica o CNPJ do destinatário da requisição. O valor deste campo deve ser informado sem pontuação, apenas os 14 dígitos que compõem o CNPJ. |
Sim |
||
ufDestinatario
|
Este elemento identifica a UF na qual o destinatário da requisição está localizado. Os possíveis valores para este campo são: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO. |
Sim |
||
codAutorizacao
|
Este elemento identifica o Código de Autorização, caso a requisição tenha sido corretamente processada e autorizada. O valor deste campo é um número formado por 1 a 20 dígitos. |
Não |
||
mensagemRetorno
|
Este elemento identifica a mensagem de erro retornada pelo sistema no caso da impossibilidade de processamento ou da não autorização de uma requisição. O valor deste campo é um número formado por 1 a 20 dígitos. |
Não |
Estrutura do arquivo XML de Erro
O arquivo de erro possui as informaçãoes dos erros detectados durante o processamento de uma requisição.
Campo |
Descrição |
Obrigatório |
xmlns
|
Este atributo identifica o schema associado ao arquivo XML. O valor deste campo é xdsErro. |
Sim |
código |
Este elemento identifica o código associado ao erro, caso exista. |
Não |
mensagem |
Este elemento contém a mensagem do erro ocorrido no sistema quando do processamento da requisição |
Sim |
[TAG] |
DESCRIÇÃO |
CONTEUDO |
FORMATO |
|
[requisicaoXml xmlns] |
Elemento que encabeça a XML e identifica o esquema do XML |
"xsdRequisicao" |
obrigatório |
|
[reqCompletas] |
Elemento que inicia o fornecimento das informações das requisições |
Vazio |
obrigatório |
|
[requisicaoCompleta] |
Elemento que identifica uma requisição |
obrigatório |
||
[dadosSolicitacao] |
Elemento que identifica um grupo de informações de uma requisição |
Vazio |
obrigatório |
|
[datarequisicao] |
Elemento que identifica a data da requisição |
Data da Requisição |
obrigatório |
AAAAMMDDHHMI onde AAAA = Ano com 4 caracteres numéricos MM = Mês com 2 caracteres numéricos DD = Dia com 2 caracteres numéricos HH = Hora com 2 caracteres numéricos MI = Minutos com 2 caracteres numéricos |
[identificador] |
Elemento que identifica uma requisição |
Número da requisição |
obrigatório |
6 caracteres numéricos, inclusive zeros à esquerda (gerado pelo contribuinte, número único para cada item da requisição) |
[remetente] |
Elemento que identifica o CNPJ do Remetente |
CNPJ do Remetente |
Obrigatório |
14 caracteres numéricos, inclusive zeros à esquerda |
[destinatario] |
Elemento que identifica o CNPJ do destinatário |
CNPJ do destinatário |
Obrigatório |
14 caracteres numéricos, inclusive zeros à esquerda |
[ufdestinatario] |
Elemento que identifica a UF do CNPJ do destinatário |
UF do CNPJ do destinatário |
Obrigatório |
2 caracteres alfanuméricos |
[codautorizacao] |
Elemento que possui o código de autorização |
Código de autorização |
opcional |
10 caracteres numéricos |
[volume] |
Elemento que identifica o volume à temperatura ambiente |
Volume Quando estiver solicitando autorização |
Obrigatório |
10 caracteres numéricos |
[dadosNotaFiscal] |
Elemento grupo que identifica uma nota fiscal |
Vazio |
Obrigatório |
|
[numeronf] |
Elemento que identifica o Número da Nota Fiscal |
Número da Nota Fiscal |
Obrigatório Quando possuir informações sobre a Nota Fiscal |
10 caracteres numéricos |
[serienf] |
Elemento que identifica a série da Nota Fiscal |
Série da Nota Fiscal |
Obrigatório quando possuir dados da nota fiscal |
5 caracteres alfanuméricos |
[dataemissaonf] |
Elemento que identifica a data de emissão da Nota Fiscal |
Data Emissão da Nota Fiscal |
Obrigatório Quando possuir Nota Fiscal |
AAAAMMDD, onde AAAA = ano com 4 caracteres numéricos MM = Mês, DD = Dia |
volumenf] |
Elemento que identifica o volume a 20?C, na NF |
Volume |
Obrigatório Quando possuir Nota Fiscal |
10 caracteres numéricos |
valornf] |
Elemento que identifica o valor da NF |
Valor |
Obrigatório Quando possuir Nota Fiscal |
15 caracteres numéricos |
[TAG] |
DESCRIÇÃO |
CONTEUDO |
FORMATO |
|
[requisicaoXml xmlns] |
Elemento que encabeça a XML e identifica o esquema do XML |
"xsdRequisicao" |
obrigatório |
|
[reqCompletas] |
Elemento que inicia o fornecimento das informações das requisições |
Vazio |
obrigatório |
|
[requisicaoCompleta |
||||
[identRequisicao] |
Elemento que identifica uma única requisição |
Autonumeração inciando por "000001" |
obrigatório |
6 caracteres numéricos |
[dadosSolicitacao] |
Elemento que identifica um grupo de informações de uma requisição |
Vazio |
obrigatório |
|
[datarequisicao] |
Elemento que identifica a data da requisição |
Data da Requisição |
obrigatório |
AAAAMMDDHHMI onde AAAA = Ano com 4 caracteres numéricos MM = Mês com 2 caracteres numéricos DD = Dia com 2 caracteres numéricos HH = Hora com 2 caracteres numéricos MI = Minutos com 2 caracteres numéricos |
[identificador] |
Elemento que identifica uma requisição |
Número da requisição |
obrigatório |
6 caracteres numéricos, inclusive zeros à esquerda (gerado pelo contribuinte, número único para cada item da requisição) |
[remetente] |
Elemento que identifica o CNPJ do Remetente |
CNPJ do Remetente |
Obrigatório |
14 caracteres numéricos, inclusive zeros à esquerda |
[ufremetente] |
Elemento que identifica a UF do CNPJ do Remetente |
CNPJ do Remetente |
Obrigatório |
2 caracteres alfanuméricos |
[destinatario] |
Elemento que identifica o CNPJ do destinatário |
CNPJ do destinatário |
Obrigatório |
14 caracteres numéricos, inclusive zeros à esquerda |
[ufdestinatario] |
Elemento que identifica a UF do CNPJ do destinatário |
UF do CNPJ do destinatário |
Obrigatório |
2 caracteres alfanuméricos |
[codautorizacao] |
Elemento que possui o código de autorização |
Código de autorização |
opcional |
10 caracteres numéricos |
[mensagemretorno] |
Elemento que identifica a mensagem de retorno |
Mensagem quanto ao processamento |
Vazio se o processamento executar com sucesso ou mensagem de erro detectado no processamento |
100 caracteres alfanuméricos |