The sales order and purchase custom form is used to generate the sales order and purchase order in PDF format. You can make a copy of the default sales/purchase order form and customize it.
This form is programmed using Liquid . In the order form, you have access to a variable called order which represents the current order you are looking at. From the order variable, you can access related objects and fields
You would get the value of a field on order using liquid syntax like this {{order.field_name}}
A list of fields for orders (applies to both Sales and Purchase Orders)
id : An id that uniquely identifies the order.
order_number: Sales/Purchase order number.
order_date: Date of the sales/purchase order.
total: The total of the order including taxes and adjustments.
external_order_reference_number: The customer PO field for order
internal_order_reference_number: The internal ref # for order.
total_payment_amount: Total amount of pre-payment received for this order.
customer_bill_to_id: id of the customer that is related to the sales order.
customer_bill_to: The custom on the sales order
supplier_id: id of the customer that is related to the purchase.
supplier: Supplier for purchase order
message: The message/note on the order.
order_item_subtotal_no_tax: Order total without taxes
order_item_applied_taxes: A list of taxes for each line.
total_taxes_array: A list of total taxes for each tax
Related Objects: (applies to both Sales and Purchase Orders)
term: An object that represent the term of the order.
currency: An object that represents the currency for the order. See currency object.
ship_to_party: The party that is to be shipped the order. See party object.
firm: The company (firm) that the order belongs to. See firm object.
customer_bill_to: The customer the order is created for. See detail about customer_bill_to object
order_items: A list of order items. See order_item section
public_custom_fields_list: A list of custom fields that is related to the order. See custom_field object
internal_organization: The entity the order belongs to . A firm can have many entities.
facility: The facility(warehouse) the order is going to ship from. There are 2 fields related to facility. name and code.
message: The message/note on the order.
order_item_subtotal_no_tax: Order total without taxes
order_item_applied_taxes: A list of taxes for each line.
total_taxes_array: A list of total taxes for each tax
Related Objects: (applies to both Sales and Purchase Orders)
term: An object that represent the term of the order.
currency: An object that represents the currency for the order. See currency object.
ship_to_party: The party that is to be shipped the order. See party object.
firm: The company (firm) that the order belongs to. See firm object.
customer_bill_to: The customer the order is created for. See detail about customer_bill_to object
order_items: A list of order items. See order_item section
public_custom_fields_list: A list of custom fields that is related to the order. See custom_field object
internal_organization: The entity the order belongs to . A firm can have many entities.
facility: The facility(warehouse) the order is going to ship from. There are 2 fields related to facility. name and code.
total_payment_amount: Total amount on the sales order.
order_type: The type of the order. Use the description field which can be 'sale', 'purchase', 'rma', 'transfer'
shipping_preference: Shipping preference data for the order. It has the following fields: shipping_carrier, shipping_services, package_width, package_height, package_depth,
package_dimension_units, package_weight, package_weight_units, package_description,
country_of_manufacture, shipping_service_description
package_dimension_units, package_weight, package_weight_units, package_description,
country_of_manufacture, shipping_service_description
sales_agent: Get the sales agent on the order
total_weight: The weight of all products on the order if applicable
related_invoices: Any invoices created from this sales order
tags: A list of dimension options related to the order. See dimension tag object and sample code on how to show a list of tags for orders.
order_item is an object that represents a line in a sales/purchase order. It has a list of fields like the order object
id: Each order item has an id
order: The order the order item belongs to
note_a: Note A on the order item
note_b: Note B on the order item.
description: Description of line item
order_item_comment:
per_unit_cost: unit cost of the line.
quantity: Quantity being ordered.
product: The product being ordered. See product.
line_item_value_before_adjustments: Total line amount before any adjustments
line_item_value: Total line amount include adjustments before taxes
order_item_applied_taxes: Taxes applied for a order line.
estimated_delivery_date: Estimated delivery date
item_description: Same as note a
order_item_comment: Same as note b:
quantity_outstanding: Ordered quantity minus quantity shipped.
order_item_seq_id: Line number for the order item
quantity_shipped: Quantity shipped
order_item_adjustments: Any discount or surcharge on the line.
public_custom_fields_list: A list of public custom fields related to the order item
measurement_unit: A link to the measurement unit used for the order line
ship_date: Ship date
quantity_on_hand: Quantity on hand for the product on the order line in the facility for the order.
message: The message/note on the order.
order_item_subtotal_no_tax: Order total without taxes
order_item_applied_taxes: A list of taxes for each line.
total_taxes_array: A list of total taxes for each tax
supplier_part_number: Applies to purchase order. If there is an approved supplier record for the supplier on the PO, provide the part number of the supplier.
tags: A list of dimension options related to the order. See dimension tag object and sample code on how to show a list of tags for orders.
order_item is an object that represents a line in a sales/purchase order. It has a list of fields like the order object
id: Each order item has an id
order: The order the order item belongs to
note_a: Note A on the order item
note_b: Note B on the order item.
description: Description of line item
order_item_comment:
per_unit_cost: unit cost of the line.
quantity: Quantity being ordered.
product: The product being ordered. See product.
line_item_value_before_adjustments: Total line amount before any adjustments
line_item_value: Total line amount include adjustments before taxes
order_item_applied_taxes: Taxes applied for a order line.
estimated_delivery_date: Estimated delivery date
item_description: Same as note a
order_item_comment: Same as note b:
quantity_outstanding: Ordered quantity minus quantity shipped.
order_item_seq_id: Line number for the order item
quantity_shipped: Quantity shipped
order_item_adjustments: Any discount or surcharge on the line.
public_custom_fields_list: A list of public custom fields related to the order item
measurement_unit: A link to the measurement unit used for the order line
ship_date: Ship date
quantity_on_hand: Quantity on hand for the product on the order line in the facility for the order.
message: The message/note on the order.
order_item_subtotal_no_tax: Order total without taxes
order_item_applied_taxes: A list of taxes for each line.
total_taxes_array: A list of total taxes for each tax
supplier_part_number: Applies to purchase order. If there is an approved supplier record for the supplier on the PO, provide the part number of the supplier.
quantity_available: All the quantity available on hand for the product on the order item.
Comments and Suggestions
0 comments
Please sign in to leave a comment.
Related articles