Content Comparison

Document Metadata

preview_title

Title of the document for display in the browser tab or print preview.

Styles

css_additional

Path to any additional CSS file to style the PDF.

Header / Footer

logo_url

URL of the logo to be displayed in the PDF header.

page_footer

Text displayed in the footer of the document.

Service Information

service.name

Name of the service or company issuing the document.

sender_address_line

Address of the service issuing the document.

service_address.phone_number

Service's customer support phone number.

service.email

Service's customer support email address.

service_user_name

Name of the user or agent processing the document.

Billing Address

billing_address.salutation

Salutation or title of the recipient (e.g., Mr., Mrs., Ms.).

billing_address.company_name

Company name of the billing recipient.

billing_address.line1

First line of the billing recipient's address.

billing_address.line2

Second line of the billing recipient's address.

billing_address.city

City of the billing recipient.

billing_address.state

State of the billing recipient.

billing_address.zip_code

ZIP code of the billing recipient.

billing_address.country.name

Country of the billing recipient.

billing_address.vat_id

VAT number of the billing recipient.

company

Name of the company related to the customer (if applicable).

Document Information

note_name

The type of the document (e.g., invoice, order confirmation).

note_prefix

Prefix used for the document number.

note_id

Unique identifier for the document.

show_thumbnails

Boolean flag indicating whether product thumbnails should be displayed.

Order Details

order_obj.full_number

Full number of the order.

order_obj.number

Order number for the current order.

order_obj.sequence_number

Sequence number for the order, if applicable.

order_date

Date when the order was placed.

is_customer_number_shown

Boolean flag indicating if the customer number should be shown.

customer_number_label

Label for the customer number.

customer_number

Customer number associated with the order.

is_customer_reference_shown

Boolean flag indicating if the customer reference should be shown.

customer_reference_label

Label for the customer reference.

customer_reference

Customer reference number.

confirmation_note.order_confirmation_number

The order confirmation number for the order.

order_obj.payment_method_name

Name of the payment method used for the order.

payment_custom_fields

Custom fields related to payment, if available.

Shipping Details

note_data.shipping_date

Date the order was shipped.

order_obj.shipping_method

Shipping method selected for the order.

shipping_address.salutation

Salutation or title of the shipping recipient (e.g., Mr., Mrs., Ms.).

shipping_address.company_name

Company name of the shipping recipient.

shipping_address.line1

First line of the shipping recipient's address.

shipping_address.line2

Second line of the shipping recipient's address.

shipping_address.city

City of the shipping recipient.

shipping_address.state

State of the shipping recipient.

shipping_address.zip_code

ZIP code of the shipping recipient.

shipping_address.country.name

Country of the shipping recipient.

delivery_time

Estimated delivery time for the order.

is_pickup

Boolean flag indicating if the order is a pickup.

order_obj.pickup_location.location

Location where the order will be picked up (for pickup orders).

order_obj.pickup_location.instructions

Instructions for picking up the order.

Order Lines

order_lines

A list of order lines/items included in the document.

line.thumbnail

Thumbnail image of the order line.

line.fullName

Full name of the product in the order line.

line.offer.technology

Technology used for the line item (e.g., 3D printing method).

line.offer.material

Material used for the product in the order line.

line.prices.printPrice

Print price of the line item.

line.offer.postProcessings

List of post-processing options for the line item.

line.dimensions.w

Width dimension of the line item.

line.dimensions.h

Height dimension of the line item.

line.dimensions.d

Depth dimension of the line item.

line.measureUnit

Unit of measurement for the line item dimensions.

line.weight

Weight of the line item.

line.weightUnit

Unit of measurement for the line item weight.

line.volume

Volume of the line item

line.volumeUnit

Unit of measurement for volume of the line item

line.prices.unitPrice

Unit price of the line item.

line.prices.discount

Discount applied to the line item.

line.prices.linePrice

Total price for the line item.

line.part_requirements.fields.all

Additional requirements for the line item.

Delivered Items

delivered_items

List of delivered items for the order.

delivered_item.delivered

Quantity of the item that has been delivered.

Totals

subtotal

Subtotal of the order.

post_processings_price

Total cost for post-processing.

printing_price

Total printing cost.

fee

Extra fee applied to the order.

fees

List of fees associated with the order.

difference_to_minimum

Difference to the minimum price required.

voucher_discount

Discount applied through a voucher.

shipping_price

Shipping price for the order.

total_prices.excl_tax

Net total (before taxes) for the order.

tax_rate

Tax rate applied to the order.

tax

Total tax amount.

total_prices.incl_tax

Gross total (including taxes) for the order.

total_weight

Total weight of the items in the order.

total_weight_decimals

Number of decimal places to display for the total weight.

total_weight_unit

Unit of measurement for the total weight (e.g., kg, lbs).

Footer

page_footer

Text displayed in the footer of the document.

Comments

note_data.comment

Additional comments related to the order.

Conditions

general_sales_conditions

Text containing the general sales conditions.

general_shipping_conditions

Text containing the general shipping conditions.