v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
CustomerInvoice

Generate PDF for Customer Invoice

Usage Instructions and Security Best Practices

  • Link Expiration: Links expire after 15 minutes.
  • Authenticate Users: Only generate pdf links for authenticated users.
  • On-Demand Links: Generate the link only when a user requests to view or download a pdf.
  • New Windows/Tabs: Automatically redirect users to the URL provided, instead of showing them the link directly.
  • Avoid Caching: Do not cache or store pdf links in your application.
  • Avoid Email Transmission: Never send pdf links via email due to link expiry and security concerns.

Example Workflow

  1. Request Access: User logs into your system and requests to view a pdf.
  2. Generate Link: Your system makes a POST request to the pdf endpoint.
  3. Provide Link: Your application receives the URL and automatically redirects the user to the URL in a new window or tab.
post/provider/customer_invoices/{customer_invoice_id}/pdf

Path parameters

customer_invoice_idstring required

Unique Customer Invoice ID

Response

Successful response

urlstring