Descarregar PDF de documentos e recibos

Esta rota permite a obtenção de links para visualizar e descarregar PDF de documentos de venda — orçamentos, faturas-proforma, guias, faturas e notas — e recibos.

get

Path parameters

idintegerRequired

id of the document or receipt of which to get the link to the materialized PDF

Example: 1

Query parameters

filter[type]string · enumRequired

is it a document or a receipt?

Example: DocumentPossible values:

filter[copies]integerOptional

number of copies of the document or receipt to print (in the PDF)

Example: 1

Responses

200

OK

application/json

get

/url_for_print/{id}

HTTPcURLJavaScriptPython

GET /url_for_print/{id}?filter[type]=Document HTTP/1.1
Host: /
Accept: */*

200

OK

{
  "data": {
    "type": "url_for_print",
    "id": "1",
    "attributes": {
      "url": {
        "scheme": "https",
        "host": "app.cloudware.pt",
        "port": 443,
        "path": "/public-file/path_to_file"
      }
    }
  }
}

Para a obtenção de links para documentos de venda, o pedido a fazer deverá ser o seguinte:

curl -v -X GET -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' '<API_URL>/url_for_print/<id do documento>?filter[type]=Document&filter[copies]=1'

Para a obtenção de links para recibos, o pedido a fazer deverá ser o seguinte:

curl -v -X GET -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' '<API_URL>/url_for_print/<id do recibo>?filter[type]=Receipt&filter[copies]=1'

Nos pedidos acima, o <access_token> é o token de acesso válido devolvido pelo serviço de OAuth e o <id do documento> ou o <id do recibo> é o identificador interno do documento ou do recibo (cabeçalho) devolvido no campo "id" da resposta ao seu pedido de criação.

A resposta a este pedido é idêntica à do seguinte exemplo:

{
    "data": {
        "type": "url_for_print",
        "id": "id do documento ou recibo",
        "attributes": {
            "url": {
                "scheme": "https",
                "host": "app.cloudware.pt",
                "port": 443,
                "path": "/public-file/path_to_file"
            }
        }
    }
}

Nesta resposta, o link para o documento ou recibo é obtido concatenando os atributos scheme (seguido de "://"), host e path. Para este exemplo, seria:

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

Para obter o link público do pdf, é necessário acrescentar ao pedido o campo "public_pdf" com o valor "true" . Por exemplo:

curl -v -X GET -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' '<API_URL>/url_for_print/<id do documento>?public_pdf=true'

A resposta a este pedido é identica à resposta definida em cima.