Skip to main content
GET

Get proforma PDF

Scope:sales:proforms.read
https://api.holded.com/api/v2/proformas/{proformaId}/pdf

Downloads the proforma invoice as a PDF file. The response Content-Type is `application/pdf`. The PDF reflects the current state of the proforma.

Parameters

Path parameters

proformaIdstringrequired

Proforma ID (24-char hex ObjectId)

Request

python
import requests

url = "https://api.holded.com/api/v2/proformas/{proformaId}/pdf"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json
"string"

Success responses

200PDF binary contentapplication/pdf
string<binary>

Error responses

401Invalid or missing API keyapplication/json
403Insufficient permissionsapplication/json
404Proforma not foundapplication/json
429Rate limit exceededapplication/json