Descarregar PDF de Documentos de Venda

A presente página descreve as rotas necessárias para a obtenção de um PDF de um documento

Obter Caminho para Ficheiro

Para um documento ser descarregado, o mesmo deve estar com um estado (status) de finalizado (status = 1) .

Descarregar PDF de Documentos de Venda

Descarregar PDF de Documentos de Venda

get

/api/url_for_print/{salesDocumentId}

Authorizations

Path parameters

salesDocumentIdstringrequired

Id do documento de venda

Example: 10

Query parameters

filter[type]string

Tipo do documento a imprimir (Document = Documento de venda)

Example: Document

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '{{base_url}}/api/url_for_print/{salesDocumentId}'

200

200

{
  "data": {
    "attributes": {
      "url": {
        "host": "integration.toconline.pt",
        "path": "/public-file/eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJleHAiOjIwODgwOTYyMDksImlhdCI6MTcwOTY2NDIwOSwibmJmIjoxNzA5NjY0MjA5LCJhcmNoaXZlIjp7ImlkIjoiY1dQSUxkVlkyIiwiZW50aXR5X2lkIjoiODAwMDAwMDQ2In19.herbicMeAYAzFgcb22h9uUZDugfYiGCYokXakor3nIVSo2psCyZLvN9Ps1vH4SUTkfe4cW0mWuOveujHnNby7fA4JoOvoqZX18vw1hRrmPANtW8n3yg62sjiw6PWR7WIMgXPPdXQbS8peHHTo5E6i2qSd16a40mzarSEbc3y8TRppjr1NpKTVyZKL6eWT9Av7xk23X4M-AHOxZzmgsyFA4RVr2ggk_Fqdj1eFbBobvC8y0-dtckvOzS7_ihjaLUTReBCT9Ic-cVV0LrwpIXYEa6nKHG_r3Pzdw2K_jesJHGGDQjgbQEXvKBAu8vOJhoFCRuGpdZTG9H02pdaCFGRWA",
        "port": 443,
        "scheme": "https"
      }
    },
    "id": "10",
    "type": "url_for_print"
  }
}

Descarregar PDF de Documentos de Venda / Descarregar PDF de Documentos de Venda

Endpoint

https://app.toconline.pt/api/url_for_print/<id do documento de venda>?filter[type]=Document&filter[copies]=1

Para obter o id do Documento de Compra pretendido (document_id) poderá consultar: #obter-todos-os-documentos-de-compra-finalizados

Tal como nos restantes pedidos especificados anteriormente, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth

Descarregar Ficheiro

Utilizando a resposta recebida, deverá concatenar os atributos: scheme + "://" + host + path, e irá obter o link através do qual a transferência é imediata. Neste caso, seria:

https://app.toconline.pt/public-file/path_to_file