Skip to main content
objectOutputTemplate

Fields

id
ID!

The unique identifier of the template.

templateSetId
ID!

The unique identifier of the template set the template belongs to.

name
String!

The name of the template.

documentType
String!

The document type the template belongs to. Known values: SALES_QUOTATION, SALES_ORDER, SALES_INVOICE, DELIVERY_NOTE, SALES_INVOICE_CORRECTION, PRICE_LIST, CUSTOMER_DETAILS, CUSTOMER_MESSAGE, STOCK_VALUATION, INVENTORY_DIFFERENCE_LIST, ITEM_LABEL, SHIPPING_LABEL, SUPPLIER_MESSAGE, WAREHOUSE_PACK_LIST, SHIPPING_LIST, STORAGE_LOCATION_LABEL, PURCHASE_ORDER, PURCHASE_ORDER_REMINDER, SUPPLIER_PRICE_REQUEST, FULFILLMENT_ORDER, PICK_LIST, PUTAWAY_LIST, WMS_INVENTORY_LIST, PAYMENT_RECEIPT, SHIPPING_NOTIFICATION, DUNNING_LETTER, SALES_RETURN, RETURN_LABEL_EMAIL, ADDRESS_LABEL, VOUCHER, EXTERNAL_DOCUMENT, PDF, PACKAGE_ID_LABEL, SSCC_LABEL. The list is the catalogue of QueryOutputDocumentTypes and grows with the product. A client treats a value it does not know as a document type it cannot handle and does not offer it; the server answers an unknown value in a body with 422 and in a path or query with 404 (OUTPUT_DOCUMENT_TYPE_NOT_FOUND).

channels
[String!]!

The channels the template delivers its document by. One template can serve several channels. Known values: PRINT, FAX, SAVE, MAIL, EXPORT, LABEL. New values can be added without a contract change. A client ignores a channel it does not know; the server answers an unknown value in a request with 400 (VALIDATION_FAILED).

The assignments of the template, one per criterion that limits it. A criterion without an entry means: applies to all values.

changedAt
DateTime!

The time the template was last changed.

The layouts of the template, one per channel that names a layout.