--- title: "List Templates" method: GET path: "/v2/invoice-pdf-templates" tags: ["invoice-pdf-templates"] --- # List Templates `GET /v2/invoice-pdf-templates` ## Request - Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from) - URL: `https://api.stuut.ai/v2/invoice-pdf-templates` - Auth: HTTP bearer List Invoice PDF Templates The default template first, then the other templates by name. Unset fields report their defaults. An organization without a default template gets one, with generation off. ## Response `200` Successful Response - InvoicePdfTemplateResponse[] - `id` string, required - `name` string, required - `is_default` boolean, required - `slug` string, nullable, required - `created_at` string, date-time, nullable, required - `modified_at` string, date-time, nullable, required - `state` 'active' | 'disabled', required - `action` 'generate' | 'never_generate', required - `combine_pdfs_from` integer, nullable, required - `show_org_contact` boolean, required - `show_mailing_address` boolean, required - `show_banking` boolean, required - `show_ship_to` boolean, required - `show_bill_to` boolean, required - `show_purchase_order_number` boolean, required - `show_order_number` boolean, required - `show_customer_number` boolean, required - `show_payment_terms` boolean, required - `show_invoice_method` boolean, required - `show_due_date` boolean, required - `show_invoice_period` boolean, required - `show_invoice_balance` boolean, required - `show_tax_row` boolean, required - `show_payments_row` boolean, required - `show_comments` boolean, required - `show_late_fee_note` boolean, required - `show_payment_instructions` boolean, required - `show_terms` boolean, required - `show_payment_stub` boolean, required - `mailing_address` PdfAddressSchemaOutput, required: Remit-to / wire address. - `name` string, nullable, required - `line1` string, nullable, required - `line2` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `wire_address` PdfAddressSchemaOutput, required: Remit-to / wire address. - `name` string, nullable, required - `line1` string, nullable, required - `line2` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `lockbox_address` PdfAddressSchemaOutput, required: Remit-to / wire address. - `name` string, nullable, required - `line1` string, nullable, required - `line2` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `banking` PdfBankDetailsSchemaOutput, required: Where customers wire or ACH payments. Written as a whole: an update replaces every field in it. - `bank_name` string, nullable, required - `account_number` string, nullable, required - `routing_number` string, nullable, required - `wire_routing_number` string, nullable, required - `details` string, nullable, required - `payment_terms` string, nullable, required - `invoice_method` string, nullable, required - `late_fee_note` string, nullable, required - `footer_note` string, nullable, required - `notes` string, nullable, required - `payment_instructions` string, nullable, required - `org_contact_lines` string[], nullable, required - `accent_color` string, nullable, required - `layout_name` string, nullable, required - `logo_url` string, nullable, required - `company_name` string, nullable, required - `header_fields` PdfHeaderFieldSchema[], nullable, required - `source` 'invoice' | 'partner', required: Whose custom fields a header field reads. - `key` string, required - `label` string, required - `terms_blocks` PdfTermsBlockSchemaOutput[], nullable, required - `title` string, required - `subtitle` string, nullable, required - `body` string, required - `terms_placement` 'side_by_side' | 'stacked', required - `line_item_columns` PdfLineItemColumnSchemaOutput[], required - `field` 'line_number' | 'quantity' | 'item' | 'name' | 'description' | 'product_type' | 'period' | 'unit_amount' | 'total_discount' | 'total_tax' | 'total_amount' | 'custom_field', required - `key` string, nullable, required - `label` string, nullable, required - `payment_link` PdfPaymentLinkSchemaOutput, required: A pay-online link printed above the totals. `erp_payment_url` prints the payment link the ERP synced onto the invoice; `custom_field` prints the invoice custom field `key`, and only it has a `key`. Left off an invoice with no link, or whose link isn't an https URL. `image_url` prints either side of the link, such as the payment provider's badge; upload it like the logo. - `source` 'erp_payment_url' | 'custom_field', required: Where a template's pay-online link comes from. Both are the ERP's: the invoice's synced payment link, or an invoice custom field the template names. - `key` string, nullable, required - `image_url` string, nullable, required - `totals_rows` PdfTotalsRowSchemaOutput[], nullable, required - `source` 'subtotal' | 'tax' | 'total' | 'payments' | 'amount_due' | 'custom_field', required - `key` string, nullable, required - `label` string, nullable, required - `labels` object, nullable, required - `date_format` '%d/%m/%Y' | '%m/%d/%Y' | '%-m/%-d/%Y' | '%Y-%m-%d' | '%d-%b-%y' | '%d %b %Y' | '%-d %b %Y' | '%b %-d, %Y', required: The date patterns a template may print with (Python strftime). `%b` prints the English month, so a template in another language picks a numeric one. - `currency` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR', required: The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. --- [API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/ff0ad16a55ff?raw)