referencestring
Shown to the customer and on receipts, e.g. PM-7K3QX9
status'draft' | 'paid' | 'in_production' | 'printed' | 'posted' | 'cancelled' | 'returned'
recipientLinesstring[]
The address as printed on the envelope
paperSize'a4' | 'us_letter' | 'null' nullable
Paper the letter is printed on (a draft's as decided from its document now, a paid letter's as fixed at payment); null while the customer still has to choose (paperChoiceRequired)
paperChoiceRequiredboolean
A US Letter document to a destination outside the US, Canada and US territories, and no choice yet: ask "shrink to A4 (recommended) or keep US Letter?" and send paperSize with /letters/{id}/send. Sending without it answers 409 PAPER_CHOICE_REQUIRED.
destinationPaperSize'a4' | 'us_letter'
Standard paper of the destination: us_letter for US, CA, PR, VI, GU, AS, MP, else a4
currency'EUR' | 'USD' | 'GBP' | 'CHF'
totalinteger
Total in minor units of currency
quoteobject
Price breakdown in EUR cents (lines, netEurCents, vatEurCents, grossEurCents, vatRate, reverseCharge), postal size class and zone
priceLabelstring
"incl. 17% VAT", or "excl. VAT — reverse charge"
trackingNumberstring nullable
Registered letters, once posted
createdVia'web' | 'mcp' | 'api'
createdAtstring date-time
paidAtstring date-time nullable
postedAtstring date-time nullable
cancelledAtstring date-time nullable
urlstring uri
The letter's page in the customer's account, in the account's language: the print-ready PDF (page previews, open, download) until the retention period ends, the status and the price. Give it to the account holder to check the letter before sending; it needs their sign-in.