LIlight
v1 - Customer Credits

Generate customer credit PDF

Generates the PDF document for a customer credit. Poll this endpoint until status is READY, then use the url field to download the PDF. The signed URL is temporary and should not be stored and reused. To download again, call this endpoint to get a fresh URL.

post/v1/customer-credits/{customerCreditId}/document

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

customerCreditIdstring uuid required

Response

default response

idstring uuid

Unique identifier for the PDF document

customerCreditIdstring uuid

ID of the customer credit

status'GENERATING' | 'READY' | 'FAILED'

Current status of the PDF document generation

  • GENERATING - The PDF is currently being generated
  • READY - The PDF has been generated and is ready for download
  • FAILED - The PDF generation failed

⚠️ This enum is not exhaustive; new values may be added in the future.

urlstring url nullable

Signed URL to download the PDF document. Only available when status is READY. The URL is temporary and should not be stored and reused. To download again, call the endpoint to get a fresh URL.

createdAtstring date-time

Timestamp when the document was created

updatedAtstring date-time

Timestamp when the document was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.