Quarantine
The quarantine object contains information held against a quarantine record.
When an item is damaged, lost, or in for service, you may move it to the quarantine.
A quarantine record holds information about the damage, loss, or service. It's common for folks to upload attachments to record details of the damage and store detailed notes in the description.
Document layouts
The quarantine
object can be accessed in document layouts created against the following records:
Quarantine
Discussion templates
The quarantine
object can be accessed in discussion templates created against the following records:
Quarantine
activities
activities
Returns activity objects for the activities relating to a quarantine.
Input
Output
attachments
attachments
Returns attachment objects for attachments stored against a quarantine.
Input
Output
description
description
Returns the description for a quarantine
Input
Output
ends_at
ends_at
Returns the end date and time for a quarantine.
If open ended, a quarantine's end date will default to years in future. Use is_open_ended?
to handle this.
Input
Output
Use a date filter to change the way that the date is formatted.
id
id
Returns a quarantine ID.
The ID is an internal reference for a record. It's not exposed in our web interface.
Input
Output
image_attachments
image_attachments
Returns attachment objects for attachments stored against a quarantine where the attachment file type is an image.
Use images
where you just need to return image URLs. Use image_attachments
where you'd like to return image names, file names, and other data.
Input
Output
images
images
Returns an array of URLs for image attachments against this quarantine.
Typically used to included photographs of damaged goods on a quarantine note.
Input
Output
is_open_ended?
is_open_ended?
Returns true
if a quarantine is open ended; false
otherwise.
Input
Output
name
name
Returns the name of the quarantined product.
Input
Output
next_booking
next_booking
Returns opportunity objects for the next opportunity that a quarantine is booked on.
Input
Output
product
product
Returns product objects for a quarantine.
Input
Output
quantity
quantity
Returns the quantity quarantined. Useful for bulk and non-stock stock products.
Input
Output
quantity_booked_out
quantity_booked_out
Returned the quantity booked out of quarantine.
Input
Output
quantity_outstanding
quantity_outstanding
Returns the quantity yet to be booked out of quarantine.
Input
Output
reference
reference
Returns the reference (subject) of a quarantine.
Input
Output
source
source
Returns opportunity objects for the source opportunity related to a quarantine.
A quarantine will have a source opportunity where an item was checked-in as lost, damaged, or a sale return from an opportunity.
Input
Output
starts_at
starts_at
Returns the start date and time for a quarantine.
Input
Output
stock_level
stock_level
Returns stock level objects for a quarantine.
Input
Output
supplier
supplier
Returns organization objects for the supplier related to this opportunity.
A quarantine will have a related supplier where it is a supplier return, or is damaged or lost sub-rent stock.
Input
Output
type
type
Returns the quarantine type name
Damaged
Lost
Service
Supplier Return
Sale Return
Swapped Component
Input
Output
Last updated