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.

Purchase orders are in beta. It's unlikely these object will change, but new objects may be added in future.

activities

Returns activity objects for the activities relating to the purchase order.

Input

{% for activity in order.activities %}
  {{ activity.subject }}
{% endif %}

Output

Call to follow up

pageActivity

attachments

Returns attachment objects for attachments stored against a purchase order.

Input

{% for attachment in order.attachments %}
  {{ attachment.name }}
{% endfor %}

Output

Ann Veal

pageAttachments

authorised_at

Returns the date and time that the purchase order was authorized.

Input

{{ order.authorised_at }}

Output

2021-02-21 10:00:00 +0000

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.

Input

{{ order.authoriser.name }}

Output

Peter Miller

pageUser

charge_excluding_tax_total

Returns the purchase order charge total excluding tax.

Input

{{ order.charge_excluding_tax_total }}

Output

450.0

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.

Input

{{ order.charge_including_tax_total }}

Output

550.0

charge_total

Returns the purchase order charge total.

Input

{{ order.charge_total }}

Output

450.0

delivery_address

Returns the purchase order delivery address.

You may also use the venue object (below).

Input

{{ order.delivery_address }}

Output

0470 Conn Throughway North Meda MN 03899-1584

delivery_address_detail

Returns address objects for the delivery address against the purchase order.

Input

{{ order.delivery_address_detail.state }}

Output

QLD

pageAddress detail

delivery_address_name

Returns the name of the delivery address against the purchase order.

You may also use the venue object (below).

Input

{{ order.delivery_address_name }}

Output

Seaview Convention Center

delivery_at

Returns the purchase order delivery date and time.

Input

{{ order.delivery_at }}	

Output

2021-03-29 11:00:00 +0000

delivery_attention

Returns the value of the purchase order “Delivery For Attention Of” field.

Input

{{ order.delivery_attention }}

Output

Michael McGovern

delivery_instructions

Returns the purchase order delivery instructions.

Input

{{ order.delivery_instructions }}

Output

Around the back.

description

Returns the purchase order (internal) description.

Input

{{ order.description }}

Output

Take extra care with this sub-rented stock.

expected_at

Returns the purchase order expected arrival date and time.

Input

{{ order.expected_at }}

Output

2021-04-10 14:00:00 +0000

expected_note

Returns the purchase order expected arrival notes.

Input

{{ order.expected_note }}

Output

Vendor is running late; delivery Thursday.

external_description

Returns the purchase order external description.

Input

{{ order.external_description }}

Output

Purchase Order raised as agreed.

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

{{ order.id }}

Output

1

image_attachments

Returns attachment objects for attachments stored against a purchase order where the attachment file type is an image.

Input

{% for attachment in order.image_attachments %}
  {{ attachment.name }}
{% endfor %}

Output

Ann Veal

pageAttachments

items

Returns purchase order item objects for items on the purchase order.

Input

{% for item in order.items %}
  {% if item.is_item? %}
    {{ item.name }}
  {% endif %}
{% endfor %}

Output

Pioneer XDJ RX

pagePurchase order items

name

Returns the purchase order subject.

Input

{{ order.name }}

Output

V-Blast Music Festival

number

Returns the purchase order number.

Input

{{ order.number }}

Output

PO-001

ordered_at

Returns the value of the purchase order “Order Date” field.

Input

{{ order.ordered_at }} 

Output

2021-03-11 14:00:00 +0000

participants

Returns contact, organization, user, vehicle, or venue objects for participants on the purchase order.

Input

{% for participant in order.participants %}
  {{ participant.name }} - {{ participant.type }}
{% endfor %}

Output

Michael McGovern - Contact

reference

Returns the purchase order customer reference.

Input

{{ order.reference }}

Output

I3804

sources

Returns opportunity objects for the purchase order sources.

A purchase order may have multiple sources, or no sources at all.

Input

{% for source in order.sources %}
  {{ source.name }}
{% endfor %}

Output

Omni Consumer Products New Product Launch

pageOpportunity

state

Returns the purchase order state code.

Code	State name
0	Draft
1	Order

Input

{{ order.state }}

Output

1

state_name

Returns the purchase order state name.

State names are in the language set against your user profile.

• Draft

• Order

Input

{{ order.state_name }}

Output

Order

status

Returns the purchase order status code.

Code	Status name
0	Open
10	Authorized
20	Sent
30	Completed
40	Canceled

Input

{{ order.status }}

Output

10

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

{{ order.status_name }}

Output

Authorized

store

Returns store objects for the store against the purchase order.

Input

{{ order.store.name }}

Output

The Banana Stand

pageStore

supplier

Returns organization objects for the supplier against the purchase order.

Input

{{ supplier.name }}

Output

Omni Consumer Products

pageOrganization

tax_class_name

Returns the purchase order tax class.

This may differ from the organization tax class.

Input

{{ order.tax_class_name }}

Output

Default

tax_total

Returns the purchase order tax total.

Input

{{ order.tax_total }}

Output

100.0

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

{{ order.venue.name }}

Output

Seaview Conference Center

pageVenue

weight_total

Returns the purchase order weight total.

Input

{{ order.weight_total }}

Output

250.0

Use the company object weight unit to print the weight unit for your system.