Foi disponibilizado uma nova rota para a API do Plug Storage, Nesta rota é possível solicitar a exportação dos documentos que se encontra armazenadas na plataforma.
Ao realizar a requisição informando o período a ser exportado, modelo de documento, ambiente e o tipo de transação, será retornado um número de protocolo. Esse número deve ser informado na requisição para a rota de consultar exportação. Onde a mesma irá retornar os links para download do arquivo PDF e para o arquivo compactado, onde contem os XMLs armazenados.
POST
https://app.plugstorage.com.br/api/accountant/processexport?token=tokenSoftwareHouse
Querystring
Nome | Descrição |
token | Token de identificação da sua Software House |
Headers
Nome | Valor |
Authorization | Basic encode64 (email:senha) |
Content-Type | application/x-www-form-urlencoded |
Body
Nome | Descrição | Obrigatório |
initial_period | Período Inicial, exe: 01-03-2020 | Sim |
final_period | Período final, exe: 31-03-2020 | Sim |
document_model | Modelo do Documento, exe: 55 | Sim |
environment | Ambiente, exe: 1 | Sim |
transaction | Tipo de Transação, exe: received | Não |
Modelos de documentos aceitos:
- 55 para NF-e,
- 65 para NFC-e,
- 59 para SAT,
- 57 para CT-e,
- 67 para CT-e OS,
- 99 para NFS-e
Valores aceitos para o campo enviroment:
- 1 para ambiente de produção
- 2 para o ambiente de homologação.
Valores aceito para o campo transaction:
- "send": Será exportado documentos que o cliente é o EMISSOR.
- "received": Será exportados documentos que o cliente é o DESTINATÁRIO
- "other": Será exportados documentos que não seja do emitente e nem do destinatário.
- para exportar todos os documento, NÃO informar o parâmetro transaction.
Retorno
exemplo de retorno com sucesso:
{
"message": "Está sendo realizado a exportação das notas para o usuário TecnoSpeed. Segue o número de protocolo para realizar a consulta.",
"protocol": "8308202003305776070"
}
exemplo de retorno com erro:
{
"error": true,
"message": "Parâmetro document_model não informado ou Invalido!"
}
Comentários
0 comentário
Por favor, entre para comentar.