Differences

This shows you the differences between two versions of the page.

--- api:api_applications_id_offers_id_attachments_id_download [2025/01/02 15:32] – created Lauri
+++ api:api_applications_id_offers_id_attachments_id_download [2025/01/02 15:39] (current) – [GET, HEAD] Lauri
@@ Line 5: / Line 5: @@
 Download a specific attachment.
+There are two major ways that an attachment can be created:
+  - Uploading a file when composing the offer letter (this call returns the uploaded bytes verbatim)
+  - Generating a PDF attachment from a letterhead [1].
+In addition:
+  - An attachment can be specified as part of an offer type, in which case it is attached automatically
+  - An attachment can be [[api:api_applications_id_offers_id_letters|posted from the API]]
+[1] Letterheads are document templates that can be used to generate attachments to offers. In reality, there is also a middle-step in that process — first a Letter is created from the Letterhead (and can be accessed using [[api:/api/applications/ID/offers/ID/letters|/api/applications/ID/offers/ID/letters]]). Such a Letter represents a generated (and potentially user-customised) document, where each template marker has already been replaced by actual applicant data. For the purposes of attaching to an offer, the Letter is converted to a PDF and attached o an offer just like a regular uploaded PDF. All of this happens seamlessly in the UI, however, for the API the entire data model is explicitly shown.
 ==== Syntax ====