Get credit note document

GET

https://api.light.inc/v1/credit-notes/{creditNoteId}/document

Redirects to a temporary download link for the credit note's PDF document. The link is valid for 30 minutes and can be opened by anyone who holds it; request a new one when you need the file.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Path parameters

creditNoteId string · uuidrequired

Response

application/pdfReturns a file (application/pdf) rather than JSON.

cURL

curl -X GET "https://api.light.inc/v1/credit-notes/3c90c3cc-0d44-4b50-8888-8dd25736052a/document" \
  -H "Authorization: Basic YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.light.inc/v1/credit-notes/3c90c3cc-0d44-4b50-8888-8dd25736052a/document", {
  method: "GET",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.light.inc/v1/credit-notes/3c90c3cc-0d44-4b50-8888-8dd25736052a/document",
    headers={
        "Authorization": f"Basic {os.environ['LIGHT_API_KEY']}",
    },
)
data = res.json()