ALaltera-co
Sales

Generate PDF url

Changed on

Returns a pre-signed PDF URL for one invoice, valid for 5 minutes. A company-owned PDF still being generated returns 409 PDF_NOT_READY with Retry-After: 2; retry within a bounded budget. Invalid or unavailable invoice selection returns 400. Pending PDF requests do not change status. A successful request changes an ISSUED sales document, including a pro forma, to SENT even if the URL is never downloaded. DRAFT remains DRAFT. SENT is not proof of email delivery.

post/sales/pdfUrl

Request

  • Base URL
    https://api.altera.co
  • URL
    https://api.altera.co/sales/pdfUrl
  • Auth
    API key in header Authorization

Request body

invoiceIdinteger required

Response

OK

result'OK'
datastring

Pre-signed invoice PDF download URL, valid for 5 minutes.

Example response

{
  "result": "OK"
}

Changes

  • 45544bcb4e8aRevision changes
    • breaking

      request body became required

    • breaking

      the request property became required

    • warning

      the request property's min was set to 1.00

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 64c683372c45Revision changes
    • info

      endpoint added