Purchase order
The purchase order object contains information about a purchase order in Current RMS.
Purchase orders can be created directly from an opportunity. Current RMS will take opportunity costs and create a purchase order per supplier.
activities
activities
Returns activity objects for the activities relating to the purchase order.
Input
Output
attachments
attachments
Returns attachment objects for attachments stored against a purchase order.
Input
Output
authorised_at
authorised_at
Returns the date and time that the purchase order was authorized.
Input
Output
Use a date filter to change the way that the date is formatted.
authoriser
authoriser
Returns user objects with information about the user who authorized the purchase order.
Input
Output
charge_excluding_tax_total
charge_excluding_tax_total
Returns the purchase order charge total excluding tax.
Input
Output
Use the currency filter or a number filter to change the way that the number is formatted.
charge_including_tax_total
charge_including_tax_total
Returns the purchase order charge total including tax.
Input
Output
charge_total
charge_total
Returns the purchase order charge total.
Input
Output
customer_collecting
customer_collecting
Returns if the customer is collecting.
Input
Output
customer_returning
customer_returning
Returns if the customer is returning.
Input
Output
delivery_address
delivery_address
Returns the purchase order delivery address.
You may also use the venue object (below).
Input
Output
delivery_address_detail
delivery_address_detail
Returns address objects for the delivery address against the purchase order.
Input
Output
delivery_address_name
delivery_address_name
Returns the name of the delivery address against the purchase order.
You may also use the venue object (below).
Input
Output
delivery_at
delivery_at
Returns the purchase order delivery date and time.
Input
Output
delivery_attention
delivery_attention
Returns the value of the purchase order “Delivery For Attention Of” field.
Input
Output
delivery_instructions
delivery_instructions
Returns the purchase order delivery instructions.
Input
Output
description
description
Returns the purchase order (internal) description.
Input
Output
expected_at
expected_at
Returns the purchase order expected arrival date and time.
Input
Output
expected_note
expected_note
Returns the purchase order expected arrival notes.
Input
Output
external_description
external_description
Returns the purchase order external description.
Input
Output
id
id
Returns the purchase order ID.
The ID is an internal reference for a record. It's not exposed in our web interface and shouldn't be confused with the order number (below).
Input
Output
image_attachments
image_attachments
Returns attachment objects for attachments stored against a purchase order where the attachment file type is an image.
Input
Output
items
items
Returns purchase order item objects for items on the purchase order.
Input
Output
name
name
Returns the purchase order subject.
Input
Output
number
number
Returns the purchase order number.
Input
Output
ordered_at
ordered_at
Returns the value of the purchase order “Order Date” field.
Input
Output
participants
participants
Returns contact, organization, user, vehicle, or venue objects for participants on the purchase order.
Input
Output
reference
reference
Returns the purchase order customer reference.
Input
Output
sources
sources
Returns opportunity objects for the purchase order sources.
A purchase order may have multiple sources, or no sources at all.
Input
Output
state
state
Returns the purchase order state code.
Code
State name
0
Draft
1
Order
Input
Output
state_name
state_name
Returns the purchase order state name.
State names are in the language set against your user profile.
Draft
Order
Input
Output
status
status
Returns the purchase order status code.
Code
Status name
0
Open
10
Authorized
20
Sent
30
Completed
40
Canceled
Input
Output
status_name
status_name
Returns the purchase order status name.
Status names are in the language set against your user profile.
Open
Authorized
Sent
Completed
Canceled
Input
Output
store
store
Returns store objects for the store against the purchase order.
Input
Output
supplier
supplier
Returns organization objects for the supplier against the purchase order.
Input
Output
tax_class_name
tax_class_name
Returns the purchase order tax class.
This may differ from the organization tax class.
Input
Output
tax_total
tax_total
Returns the purchase order tax total.
Input
Output
venue
venue
Returns venue objects for the venue against the purchase order.
A delivery address can be a venue, but a venue might not always be a purchase order's delivery address. If you don't choose a venue when creating a purchase order, using {{ order.venue.name }}
won't return the same as {{ order.delivery_address_name }}
.
Input
Output
weight_total
weight_total
Returns the purchase order weight total.
Input
Output
Use the company object weight unit to print the weight unit for your system.
Last updated