Get credit note document

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

Returns the attached PDF document for a credit note

Answers 307 Temporary Redirect to a pre-signed URL, not the file. A credit note created through this API has no PDF behind that URL; only notes created from an uploaded document have one.

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

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

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

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();

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()