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