Scope: sales:invoices.read https://api.alladdin.com/api/v2/credit-notes/{creditNoteId}/pdf

Downloads the credit note as a PDF file. The response Content-Type is application/pdf.
The PDF is generated using the template configured in your account settings.

Parameters

Path parameters

creditNoteId string required

Credit Note ID (24-char hex ObjectId)

Request

import requests

url = "https://api.alladdin.com/api/v2/credit-notes/{creditNoteId}/pdf"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

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

Responses

Response

"string"

Success responses

200 PDF binary content application/pdf string<binary>

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Credit note not found. application/json 429 Rate limit exceeded application/json 500 Internal server error application/json object type string title string status integer detail string

← PreviousGet credit note attachment →

Next →Delete a credit note →