Nesta rota é possível obter de várias maneiras o XML de um documento. Podendo também optar por receber o XML parceado em JSON, ou o arquivo PDF gerado.
GET
https://app.plugstorage.com.br/api/invoices/export?token=tokenSH&invoice_key=keyNF&mode=xml&xml=encode
Querystring
| Nome | Descrição |
| token | Token de identificação da sua Software House. |
invoice_key | Chave do documento. |
mode | Modo de retorno. (valores válidos: XML, PDF e JSON.) |
downloaded | Marcar a nota que já foi realizado download. (valores válidos: true) |
return_type | Como deseja obter o XML: (Encodado no formato base64 ou diretamente no corpo da resposta). (valores válidos: ENCODE ou XML) |
resume | Retornar o XML resumido. Caso o XML completo ainda não esteja disponível e o parâmetro não seja informado, o XML resumido será retornado. (valores válidos: false) |
xml_event | Usado para obter o XML do evento de Cancelamento. - CANCELADO retorna apenas o XML de CANCELAMENTO - DESACORDO retorna apenas o xml do DESACORDO do CT-e - CANCDESACORDO retorna apenas o xml do Cancelamento do Desacordo do CT-e - Para funcionar, o parâmetro mode deve estar igual a XML. |
downloaded - valores válidos: true.
return_type - valores válidos: ENCODE ou XML. (OBS: Parâmetro válido para o modo de retorno XML).
resume - valores válidos: false.
mode - valores válidos: XML, PDF ou JSON.
Obter o XML dos Eventos da Reforma tributária
Em desenvolvimento!!
Observação: Opção válida apenas para o mode = XML
Nome do Campo | Descrição | Valores | Obrigatoriedade |
xml_event | Informe o código do Evento que está buscando o XML. Obs: Se informado apenas o código do evento, será retornado o último Evento Autorizado para a nota, sendo um cancelamento ou autorização. |
| Obrigatório: Sim |
situation | Informe a situação que deseja buscar para o evento. Obs: Em todas as situações será retornado sempre o último evento autorizado / rejeitado com base na situação informada. |
| Obrigatório: Não |
sequence | Informe o número da sequência do Evento autorizado. | 1-20 | Obrigatório: Não |
Headers
| Nome | Descrição |
| Authorization | Basic encode64(email:senha) |
| Content-Type | application/x-www-form-urlencoded ou application/json |
Retorno
Exemplo de retorno com erro de validação:
{
"error": true,
"message": "Parâmetro "invoice_key" não informado ou inválido."
}
{
"error": true,
"message": "Parâmetro "xml_event" só pode ser utilizado para o mode XML."
}
{
"error": true,
"message": "Parâmetro "numero_sequencia" inválido, informe um valor entre 1 a 20."
}
{
"error": true,
"message": "Parâmetro "situacao" não é suportado para o "xml_event" informado,
valores aceitos para "xml_event": E211110..."
}
{
"error": true,
"message": "Não localizamos qualquer Evento com os parâmetros informados."
}
{
"error": true,
"message": "Parâmetro "situacao" inválido, valores aceitos: AUTORIZADO, REJEITADO, CANCELADO."
}
Exemplo de retorno do XML, com sucesso:
{
"error": false,
"status": "success",
"message": "Nota encontrada.",
"data": {
"xml" : "Conteúdo do XML aqui"
}
}
Exemplo de retorno do PDF, com sucesso:
{
"error": false,
"message": "Nota encontrada.",
"data": {
"xml": {
"data": {
"pdf": "base64"
}
}
}
}
Exemplo de retorno do JSON, com sucesso:
{
"error": false,
"message": "Nota encontrada.",
"data": {
"xml": {
"xml parceado em JSON"
}
}
}
Exemplo de retorno com erro:
{
"error": true,
"message": "Nota não encontrada."
}
Exemplo de retorno com XML completo ainda não disponível e o parâmetro resume igual a false:
Não foi possível gerar o XML da nota.
Comentários
0 comentário
Por favor, entre para comentar.