Obter o XML, PDF ou JSON de um documento - V2 – Central de Atendimento

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.
Essa documentação é referente a versão 2 da rota para obter o XMl, PDF ou JSON onde ouve algumas mudanças na forma de autenticação, para acessar a versão 1 Clique aqui.

GET

https://app.plugstorage.com.br/api/v2/invoices/export

Querystring

Nome	Descrição
softwarehouse_token	Token de identificação da sua Software House.
cpf_cnpj	CPF ou CNPJ do cliente.
invoice_key	Chave do documento.
mode	Modo de retorno. valores válidos: XML, PDF ou JSON
return_type	Como deseja obter o XML: (Encodado no formato base64 ou diretamente no corpo da resposta). valores válidos: ENCODE ou XML. (OBS: Parâmetro válido para o modo de retorno 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.
downloaded	Marcar nota que já foi realizado download. valores válidos: true.
return_type	Valores válidos: ENCODE ou XML (OBS: Parâmetro válido para o modo de retorno XML).
xml_event	Usado para obter o XML do evento de Cancelamento. (valores válidos: AMBOS, AUTORIZADO, CANCELADO, DESACORDO e CANCDESACORDO) - CANCELADO retorna apenas o XML de CANCELAMENTO - AMBOS retorna o XML AUTORIZADO + EVENTO Cancelamento concatenado - 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.

Retorno

Exemplo de retorno de validações:

{
 "error": true,
 "message": "Parâmetro "invoice_key" não informado ou inválido."
}

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."
}

GET

Querystring

Artigos relacionados